Data model metamodel¶

Reference documentation

This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand how to manage data model assets in Atlan. For that, we would suggest starting with the manage data model assets pattern (coming soon).

These model elements all deal with data model constructs.

classDiagram
    direction RL
    class Model {
        <<abstract>>
    }
    class Catalog {
        <<abstract>>
    }
    link Catalog "../entities/catalog"
    Catalog <|-- Model : extends
    class Asset {
        <<abstract>>
    }
    link Asset "../entities/asset"
    Asset <|-- Catalog : extends
    class Referenceable {
        <<abstract>>
    }
    link Referenceable "../entities/referenceable"
    Referenceable <|-- Asset : extends
    class ModelDataModel
    link ModelDataModel "../entities/modeldatamodel"
    Model <|-- ModelDataModel : extends
    class ModelVersion
    link ModelVersion "../entities/modelversion"
    Model <|-- ModelVersion : extends
    class ModelEntity
    link ModelEntity "../entities/modelentity"
    Model <|-- ModelEntity : extends
    class ModelAttribute
    link ModelAttribute "../entities/modelattribute"
    Model <|-- ModelAttribute : extends
    class ModelEntityAssociation
    link ModelEntityAssociation "../entities/modelentityassociation"
    Model <|-- ModelEntityAssociation : extends
    class ModelAttributeAssociation
    link ModelAttributeAssociation "../entities/modelattributeassociation"
    Model <|-- ModelAttributeAssociation : extends

Properties¶

These attributes are unique to instances of Model (and all of its subtypes).

modelBusinessDate ¶

Business date for the asset.

modelDomain ¶

Model domain in which this asset exists.

modelEntityName ¶

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

modelEntityQualifiedName ¶

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

modelExpiredAtBusinessDate ¶

Business expiration date for the asset.

modelExpiredAtSystemDate ¶

System expiration date for the asset.

modelName ¶

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

modelNamespace ¶

Model namespace in which this asset exists.

modelQualifiedName ¶

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

modelSystemDate ¶

System date for the asset.

modelType ¶

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

modelVersionAgnosticQualifiedName ¶

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

modelVersionName ¶

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

modelVersionQualifiedName ¶

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

Relationships¶

The following illustrates how the various data model objects inter-relate with each other:

erDiagram
    Connection ||..o{ ModelDataModel : ""
    ModelDataModel ||--o{ ModelVersion : modelVersions
    ModelVersion }|--o{ ModelEntity : modelVersionEntities
    ModelEntity ||--o{ ModelAttribute : modelEntityAttributes
    ModelEntity ||--o{ ModelEntityAssociation: modelEntityRelatedToEntities
    ModelEntityAssociation }o--|| ModelEntity: modelEntityAssociationTo
    ModelEntity }o--o{ ModelEntity: modelEntityMappedToEntities
    ModelAttribute ||--o{ ModelAttributeAssociation: modelAttributeRelatedToAttributes
    ModelAttributeAssociation }o--|| ModelAttribute: modelAttributeAssociationTo
    ModelAttribute }o--o{ ModelAttribute: modelAttributeMappedToAttributes