Skip to content

Mapping

cognite.neat._session._mapping.DataModelMappingAPI #

classic_to_core(company_prefix=None, use_parent_property_name=True) #

Map classic types to core types.

Note this automatically creates an extended CogniteCore model.

Parameters:

Name Type Description Default
company_prefix str | None

Prefix used for all extended CogniteCore types.

None
use_parent_property_name bool

Whether to use the parent property name in the extended CogniteCore model. See below for more information.

True

If you extend CogniteAsset, with for example, ClassicAsset. You will map the property parentId to parent. If you set user_parent_property_name to True, the parentId will be renamed to parent after the mapping is done. If you set it to False, the property will remain parentId.

Example
neat.mapping.classic_to_core(company_prefix="WindFarmX", use_parent_property_name=True)