Skip to content

Data Modeling & Semantic

Model

pyatlan.model.assets.core.model.Model(__pydantic_self__, **data: Any)

Bases: Catalog

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

MODEL_BUSINESS_DATE: NumericField = NumericField('modelBusinessDate', 'modelBusinessDate') class-attribute

Business date for the asset.

MODEL_DOMAIN: KeywordTextField = KeywordTextField('modelDomain', 'modelDomain.keyword', 'modelDomain') class-attribute

Model domain in which this asset exists.

MODEL_ENTITY_NAME: KeywordTextField = KeywordTextField('modelEntityName', 'modelEntityName.keyword', 'modelEntityName') class-attribute

Simple name of the entity in which this asset exists, or empty if it is itself a data model entity.

MODEL_ENTITY_QUALIFIED_NAME: KeywordField = KeywordField('modelEntityQualifiedName', 'modelEntityQualifiedName') class-attribute

Unique name of the entity in which this asset exists, or empty if it is itself a data model entity.

MODEL_EXPIRED_AT_BUSINESS_DATE: NumericField = NumericField('modelExpiredAtBusinessDate', 'modelExpiredAtBusinessDate') class-attribute

Business expiration date for the asset.

MODEL_EXPIRED_AT_SYSTEM_DATE: NumericField = NumericField('modelExpiredAtSystemDate', 'modelExpiredAtSystemDate') class-attribute

System expiration date for the asset.

MODEL_NAME: KeywordTextField = KeywordTextField('modelName', 'modelName.keyword', 'modelName') class-attribute

Simple name of the model in which this asset exists, or empty if it is itself a data model.

MODEL_NAMESPACE: KeywordTextField = KeywordTextField('modelNamespace', 'modelNamespace.keyword', 'modelNamespace') class-attribute

Model namespace in which this asset exists.

MODEL_QUALIFIED_NAME: KeywordField = KeywordField('modelQualifiedName', 'modelQualifiedName') class-attribute

Unique name of the model in which this asset exists, or empty if it is itself a data model.

MODEL_SYSTEM_DATE: NumericField = NumericField('modelSystemDate', 'modelSystemDate') class-attribute

System date for the asset.

MODEL_TYPE: KeywordField = KeywordField('modelType', 'modelType') class-attribute

Type of the model asset (conceptual, logical, physical).

MODEL_VERSION_AGNOSTIC_QUALIFIED_NAME: KeywordField = KeywordField('modelVersionAgnosticQualifiedName', 'modelVersionAgnosticQualifiedName') class-attribute

Unique name of the parent in which this asset exists, irrespective of the version (always implies the latest version).

MODEL_VERSION_NAME: KeywordTextField = KeywordTextField('modelVersionName', 'modelVersionName.keyword', 'modelVersionName') class-attribute

Simple name of the version in which this asset exists, or empty if it is itself a data model version.

MODEL_VERSION_QUALIFIED_NAME: KeywordField = KeywordField('modelVersionQualifiedName', 'modelVersionQualifiedName') class-attribute

Unique name of the version in which this asset exists, or empty if it is itself a data model version.

ModelAttribute

pyatlan.model.assets.core.model_attribute.ModelAttribute(__pydantic_self__, **data: Any)

Bases: Model

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

MODEL_ATTRIBUTE_DATA_TYPE: KeywordField = KeywordField('modelAttributeDataType', 'modelAttributeDataType') class-attribute

Type of the attribute.

MODEL_ATTRIBUTE_ENTITIES: RelationField = RelationField('modelAttributeEntities') class-attribute

TBC

MODEL_ATTRIBUTE_HAS_RELATIONSHIPS: BooleanField = BooleanField('modelAttributeHasRelationships', 'modelAttributeHasRelationships') class-attribute

When true, this attribute has relationships with other attributes.

MODEL_ATTRIBUTE_IMPLEMENTED_BY_ASSETS: RelationField = RelationField('modelAttributeImplementedByAssets') class-attribute

TBC

MODEL_ATTRIBUTE_IS_DERIVED: BooleanField = BooleanField('modelAttributeIsDerived', 'modelAttributeIsDerived') class-attribute

When true, the values in this attribute are derived data.

MODEL_ATTRIBUTE_IS_FOREIGN: BooleanField = BooleanField('modelAttributeIsForeign', 'modelAttributeIsForeign') class-attribute

When true, this attribute is a foreign key to another entity.

MODEL_ATTRIBUTE_IS_NULLABLE: BooleanField = BooleanField('modelAttributeIsNullable', 'modelAttributeIsNullable') class-attribute

When true, the values in this attribute can be null.

MODEL_ATTRIBUTE_IS_PRIMARY: BooleanField = BooleanField('modelAttributeIsPrimary', 'modelAttributeIsPrimary') class-attribute

When true, this attribute forms the primary key for the entity.

MODEL_ATTRIBUTE_MAPPED_FROM_ATTRIBUTES: RelationField = RelationField('modelAttributeMappedFromAttributes') class-attribute

TBC

MODEL_ATTRIBUTE_MAPPED_TO_ATTRIBUTES: RelationField = RelationField('modelAttributeMappedToAttributes') class-attribute

TBC

MODEL_ATTRIBUTE_PRECISION: NumericField = NumericField('modelAttributePrecision', 'modelAttributePrecision') class-attribute

Precision of the attribute.

TBC

TBC

MODEL_ATTRIBUTE_SCALE: NumericField = NumericField('modelAttributeScale', 'modelAttributeScale') class-attribute

Scale of the attribute.

ModelAttributeAssociation

pyatlan.model.assets.core.model_attribute_association.ModelAttributeAssociation(__pydantic_self__, **data: Any)

Bases: Model

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

MODEL_ATTRIBUTE_ASSOCIATION_FROM: RelationField = RelationField('modelAttributeAssociationFrom') class-attribute

TBC

MODEL_ATTRIBUTE_ASSOCIATION_FROM_QUALIFIED_NAME: KeywordField = KeywordField('modelAttributeAssociationFromQualifiedName', 'modelAttributeAssociationFromQualifiedName') class-attribute

Unique name of the association from which this attribute is related.

MODEL_ATTRIBUTE_ASSOCIATION_TO: RelationField = RelationField('modelAttributeAssociationTo') class-attribute

TBC

MODEL_ATTRIBUTE_ASSOCIATION_TO_QUALIFIED_NAME: KeywordField = KeywordField('modelAttributeAssociationToQualifiedName', 'modelAttributeAssociationToQualifiedName') class-attribute

Unique name of the association to which this attribute is related.

MODEL_ENTITY_ASSOCIATION_QUALIFIED_NAME: KeywordField = KeywordField('modelEntityAssociationQualifiedName', 'modelEntityAssociationQualifiedName') class-attribute

Unique name of the entity association to which this attribute is related.

ModelDataModel

pyatlan.model.assets.core.model_data_model.ModelDataModel(__pydantic_self__, **data: Any)

Bases: Model

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

MODEL_TOOL: KeywordField = KeywordField('modelTool', 'modelTool') class-attribute

Tool used to create this data model.

MODEL_VERSIONS: RelationField = RelationField('modelVersions') class-attribute

TBC

MODEL_VERSION_COUNT: NumericField = NumericField('modelVersionCount', 'modelVersionCount') class-attribute

Number of versions of the data model.

ModelEntity

pyatlan.model.assets.core.model_entity.ModelEntity(__pydantic_self__, **data: Any)

Bases: Model

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

MODEL_ENTITY_ATTRIBUTES: RelationField = RelationField('modelEntityAttributes') class-attribute

TBC

MODEL_ENTITY_ATTRIBUTE_COUNT: NumericField = NumericField('modelEntityAttributeCount', 'modelEntityAttributeCount') class-attribute

Number of attributes in the entity.

MODEL_ENTITY_GENERALIZATION_ENTITY: RelationField = RelationField('modelEntityGeneralizationEntity') class-attribute

TBC

MODEL_ENTITY_GENERALIZATION_NAME: KeywordTextField = KeywordTextField('modelEntityGeneralizationName', 'modelEntityGeneralizationName.keyword', 'modelEntityGeneralizationName') class-attribute

Name of the general entity.

MODEL_ENTITY_GENERALIZATION_QUALIFIED_NAME: KeywordField = KeywordField('modelEntityGeneralizationQualifiedName', 'modelEntityGeneralizationQualifiedName') class-attribute

Unique identifier for the general entity.

MODEL_ENTITY_IMPLEMENTED_BY_ASSETS: RelationField = RelationField('modelEntityImplementedByAssets') class-attribute

TBC

MODEL_ENTITY_MAPPED_FROM_ENTITIES: RelationField = RelationField('modelEntityMappedFromEntities') class-attribute

TBC

MODEL_ENTITY_MAPPED_TO_ENTITIES: RelationField = RelationField('modelEntityMappedToEntities') class-attribute

TBC

TBC

TBC

MODEL_ENTITY_SPECIALIZATION_ENTITIES: RelationField = RelationField('modelEntitySpecializationEntities') class-attribute

TBC

MODEL_ENTITY_SUBJECT_AREA: KeywordField = KeywordField('modelEntitySubjectArea', 'modelEntitySubjectArea') class-attribute

Subject area of the entity.

MODEL_VERSIONS: RelationField = RelationField('modelVersions') class-attribute

TBC

ModelEntityAssociation

pyatlan.model.assets.core.model_entity_association.ModelEntityAssociation(__pydantic_self__, **data: Any)

Bases: Model

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

MODEL_ENTITY_ASSOCIATION_CARDINALITY: KeywordField = KeywordField('modelEntityAssociationCardinality', 'modelEntityAssociationCardinality') class-attribute

(Deprecated) Cardinality of the data entity association.

MODEL_ENTITY_ASSOCIATION_FROM: RelationField = RelationField('modelEntityAssociationFrom') class-attribute

TBC

MODEL_ENTITY_ASSOCIATION_FROM_LABEL: KeywordField = KeywordField('modelEntityAssociationFromLabel', 'modelEntityAssociationFromLabel') class-attribute

Label when read from the association from which this entity is related.

MODEL_ENTITY_ASSOCIATION_FROM_MAX_CARDINALITY: NumericField = NumericField('modelEntityAssociationFromMaxCardinality', 'modelEntityAssociationFromMaxCardinality') class-attribute

Maximum cardinality of the data entity from which the association exists.

MODEL_ENTITY_ASSOCIATION_FROM_MIN_CARDINALITY: NumericField = NumericField('modelEntityAssociationFromMinCardinality', 'modelEntityAssociationFromMinCardinality') class-attribute

Minimum cardinality of the data entity from which the association exists.

MODEL_ENTITY_ASSOCIATION_FROM_QUALIFIED_NAME: KeywordField = KeywordField('modelEntityAssociationFromQualifiedName', 'modelEntityAssociationFromQualifiedName') class-attribute

Unique name of the association from which this entity is related.

MODEL_ENTITY_ASSOCIATION_LABEL: KeywordField = KeywordField('modelEntityAssociationLabel', 'modelEntityAssociationLabel') class-attribute

(Deprecated) Label of the data entity association.

MODEL_ENTITY_ASSOCIATION_TO: RelationField = RelationField('modelEntityAssociationTo') class-attribute

TBC

MODEL_ENTITY_ASSOCIATION_TO_LABEL: KeywordField = KeywordField('modelEntityAssociationToLabel', 'modelEntityAssociationToLabel') class-attribute

Label when read from the association to which this entity is related.

MODEL_ENTITY_ASSOCIATION_TO_MAX_CARDINALITY: NumericField = NumericField('modelEntityAssociationToMaxCardinality', 'modelEntityAssociationToMaxCardinality') class-attribute

Maximum cardinality of the data entity to which the association exists.

MODEL_ENTITY_ASSOCIATION_TO_MIN_CARDINALITY: NumericField = NumericField('modelEntityAssociationToMinCardinality', 'modelEntityAssociationToMinCardinality') class-attribute

Minimum cardinality of the data entity to which the association exists.

MODEL_ENTITY_ASSOCIATION_TO_QUALIFIED_NAME: KeywordField = KeywordField('modelEntityAssociationToQualifiedName', 'modelEntityAssociationToQualifiedName') class-attribute

Unique name of the association to which this entity is related.

ModelVersion

pyatlan.model.assets.core.model_version.ModelVersion(__pydantic_self__, **data: Any)

Bases: Model

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

MODEL_DATA_MODEL: RelationField = RelationField('modelDataModel') class-attribute

TBC

MODEL_VERSION_ENTITIES: RelationField = RelationField('modelVersionEntities') class-attribute

TBC

MODEL_VERSION_ENTITY_COUNT: NumericField = NumericField('modelVersionEntityCount', 'modelVersionEntityCount') class-attribute

Number of entities in the version.

SemanticModel

pyatlan.model.assets.semantic_model.SemanticModel(__pydantic_self__, **data: Any)

Bases: Semantic

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

SEMANTIC_DIMENSIONS: RelationField = RelationField('semanticDimensions') class-attribute

TBC

SEMANTIC_ENTITIES: RelationField = RelationField('semanticEntities') class-attribute

TBC

SEMANTIC_MEASURES: RelationField = RelationField('semanticMeasures') class-attribute

TBC

SemanticDimension

pyatlan.model.assets.semantic_dimension.SemanticDimension(__pydantic_self__, **data: Any)

Bases: Semantic

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

SEMANTIC_EXPRESSION: KeywordField = KeywordField('semanticExpression', 'semanticExpression') class-attribute

Column name or SQL expression for the semantic field.

SEMANTIC_MODEL: RelationField = RelationField('semanticModel') class-attribute

TBC

SEMANTIC_TYPE: KeywordField = KeywordField('semanticType', 'semanticType') class-attribute

Detailed type of the semantic field (e.g., type of measure, type of dimension, or type of entity).

SemanticEntity

pyatlan.model.assets.semantic_entity.SemanticEntity(__pydantic_self__, **data: Any)

Bases: Semantic

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

SEMANTIC_EXPRESSION: KeywordField = KeywordField('semanticExpression', 'semanticExpression') class-attribute

Column name or SQL expression for the semantic field.

SEMANTIC_MODEL: RelationField = RelationField('semanticModel') class-attribute

TBC

SEMANTIC_TYPE: KeywordField = KeywordField('semanticType', 'semanticType') class-attribute

Detailed type of the semantic field (e.g., type of measure, type of dimension, or type of entity).

SemanticField

pyatlan.model.assets.semantic_field.SemanticField(__pydantic_self__, **data: Any)

Bases: Semantic

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

SEMANTIC_EXPRESSION: KeywordField = KeywordField('semanticExpression', 'semanticExpression') class-attribute

Column name or SQL expression for the semantic field.

SEMANTIC_TYPE: KeywordField = KeywordField('semanticType', 'semanticType') class-attribute

Detailed type of the semantic field (e.g., type of measure, type of dimension, or type of entity).

SemanticMeasure

pyatlan.model.assets.semantic_measure.SemanticMeasure(__pydantic_self__, **data: Any)

Bases: Semantic

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

SEMANTIC_EXPRESSION: KeywordField = KeywordField('semanticExpression', 'semanticExpression') class-attribute

Column name or SQL expression for the semantic field.

SEMANTIC_MODEL: RelationField = RelationField('semanticModel') class-attribute

TBC

SEMANTIC_TYPE: KeywordField = KeywordField('semanticType', 'semanticType') class-attribute

Detailed type of the semantic field (e.g., type of measure, type of dimension, or type of entity).

Cube

pyatlan.model.assets.cube.Cube(__pydantic_self__, **data: Any)

Bases: MultiDimensionalDataset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

CUBE_DIMENSIONS: RelationField = RelationField('cubeDimensions') class-attribute

TBC

CUBE_DIMENSION_COUNT: NumericField = NumericField('cubeDimensionCount', 'cubeDimensionCount') class-attribute

Number of dimensions in the cube.

CubeHierarchy

pyatlan.model.assets.cube_hierarchy.CubeHierarchy(__pydantic_self__, **data: Any)

Bases: MultiDimensionalDataset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

CUBE_DIMENSION: RelationField = RelationField('cubeDimension') class-attribute

TBC

CUBE_FIELDS: RelationField = RelationField('cubeFields') class-attribute

TBC

CUBE_FIELD_COUNT: NumericField = NumericField('cubeFieldCount', 'cubeFieldCount') class-attribute

Number of total fields in the cube hierarchy.

CubeDimension

pyatlan.model.assets.cube_dimension.CubeDimension(__pydantic_self__, **data: Any)

Bases: MultiDimensionalDataset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

CUBE: RelationField = RelationField('cube') class-attribute

TBC

CUBE_HIERARCHIES: RelationField = RelationField('cubeHierarchies') class-attribute

TBC

CUBE_HIERARCHY_COUNT: NumericField = NumericField('cubeHierarchyCount', 'cubeHierarchyCount') class-attribute

Number of hierarchies in the cube dimension.

CubeField

pyatlan.model.assets.cube_field.CubeField(__pydantic_self__, **data: Any)

Bases: MultiDimensionalDataset

Description

Source code in pyatlan/model/assets/core/referenceable.py 
36
37
38
def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

CUBE_FIELD_GENERATION: NumericField = NumericField('cubeFieldGeneration', 'cubeFieldGeneration') class-attribute

Generation of the field in the cube hierarchy.

CUBE_FIELD_LEVEL: NumericField = NumericField('cubeFieldLevel', 'cubeFieldLevel') class-attribute

Level of the field in the cube hierarchy.

CUBE_FIELD_MEASURE_EXPRESSION: KeywordTextField = KeywordTextField('cubeFieldMeasureExpression', 'cubeFieldMeasureExpression.keyword', 'cubeFieldMeasureExpression') class-attribute

Expression used to calculate this measure.

CUBE_HIERARCHY: RelationField = RelationField('cubeHierarchy') class-attribute

TBC

CUBE_NESTED_FIELDS: RelationField = RelationField('cubeNestedFields') class-attribute

TBC

CUBE_PARENT_FIELD: RelationField = RelationField('cubeParentField') class-attribute

TBC

CUBE_PARENT_FIELD_NAME: KeywordTextField = KeywordTextField('cubeParentFieldName', 'cubeParentFieldName.keyword', 'cubeParentFieldName') class-attribute

Name of the parent field in which this field is nested.

CUBE_PARENT_FIELD_QUALIFIED_NAME: KeywordField = KeywordField('cubeParentFieldQualifiedName', 'cubeParentFieldQualifiedName') class-attribute

Unique name of the parent field in which this field is nested.

CUBE_SUB_FIELD_COUNT: NumericField = NumericField('cubeSubFieldCount', 'cubeSubFieldCount') class-attribute

Number of sub-fields that are direct children of this field.