Skip to content

SQL Databases

CalculationView

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

Bases: SQL

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

ATLAN_SCHEMA: RelationField = RelationField('atlanSchema') class-attribute

TBC

CALCULATION_VIEW_ACTIVATED_AT: NumericField = NumericField('calculationViewActivatedAt', 'calculationViewActivatedAt') class-attribute

Time at which this calculation view was activated at

CALCULATION_VIEW_ACTIVATED_BY: KeywordField = KeywordField('calculationViewActivatedBy', 'calculationViewActivatedBy') class-attribute

The owner who activated the calculation view

CALCULATION_VIEW_PACKAGE_ID: KeywordField = KeywordField('calculationViewPackageId', 'calculationViewPackageId') class-attribute

The full package id path to which a calculation view belongs/resides in the repository.

CALCULATION_VIEW_VERSION_ID: NumericField = NumericField('calculationViewVersionId', 'calculationViewVersionId') class-attribute

The version ID of this calculation view.

COLUMNS: RelationField = RelationField('columns') class-attribute

TBC

COLUMN_COUNT: NumericField = NumericField('columnCount', 'columnCount') class-attribute

Number of columns in this calculation view.

Column

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

Bases: SQL

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

CALCULATION_VIEW: RelationField = RelationField('calculationView') class-attribute

TBC

COLUMN_AVERAGE: NumericField = NumericField('columnAverage', 'columnAverage') class-attribute

Average value in this column.

COLUMN_AVERAGE_LENGTH: NumericField = NumericField('columnAverageLength', 'columnAverageLength') class-attribute

Average length of values in a string column.

COLUMN_AVERAGE_LENGTH_VALUE: NumericField = NumericField('columnAverageLengthValue', 'columnAverageLengthValue') class-attribute

Average length of values in a string column.

COLUMN_AVERAGE_VALUE: NumericField = NumericField('columnAverageValue', 'columnAverageValue') class-attribute

Average value in this column.

COLUMN_COMPRESSION: KeywordField = KeywordField('columnCompression', 'columnCompression') class-attribute

Compression type of this column.

COLUMN_DBT_MODEL_COLUMNS: RelationField = RelationField('columnDbtModelColumns') class-attribute

TBC

COLUMN_DEPTH_LEVEL: NumericField = NumericField('columnDepthLevel', 'columnDepthLevel') class-attribute

Level of nesting of this column, used for STRUCT and NESTED columns.

COLUMN_DISTINCT_VALUES_COUNT: NumericField = NumericField('columnDistinctValuesCount', 'columnDistinctValuesCount') class-attribute

Number of rows that contain distinct values.

COLUMN_DISTINCT_VALUES_COUNT_LONG: NumericField = NumericField('columnDistinctValuesCountLong', 'columnDistinctValuesCountLong') class-attribute

Number of rows that contain distinct values.

COLUMN_DISTRIBUTION_HISTOGRAM: KeywordField = KeywordField('columnDistributionHistogram', 'columnDistributionHistogram') class-attribute

Detailed information representing a histogram of values for a column.

COLUMN_DUPLICATE_VALUES_COUNT: NumericField = NumericField('columnDuplicateValuesCount', 'columnDuplicateValuesCount') class-attribute

Number of rows that contain duplicate values.

COLUMN_DUPLICATE_VALUES_COUNT_LONG: NumericField = NumericField('columnDuplicateValuesCountLong', 'columnDuplicateValuesCountLong') class-attribute

Number of rows that contain duplicate values.

COLUMN_ENCODING: KeywordField = KeywordField('columnEncoding', 'columnEncoding') class-attribute

Encoding type of this column.

COLUMN_HIERARCHY: KeywordField = KeywordField('columnHierarchy', 'columnHierarchy') class-attribute

List of top-level upstream nested columns.

COLUMN_HISTOGRAM: KeywordField = KeywordField('columnHistogram', 'columnHistogram') class-attribute

List of values in a histogram that represents the contents of this column.

COLUMN_IS_MEASURE: BooleanField = BooleanField('columnIsMeasure', 'columnIsMeasure') class-attribute

When true, this column is of type measure/calculated.

COLUMN_MAX: NumericField = NumericField('columnMax', 'columnMax') class-attribute

Greatest value in a numeric column.

COLUMN_MAXIMUM_STRING_LENGTH: NumericField = NumericField('columnMaximumStringLength', 'columnMaximumStringLength') class-attribute

Length of the longest value in a string column.

COLUMN_MAXS: TextField = TextField('columnMaxs', 'columnMaxs') class-attribute

List of the greatest values in a column.

COLUMN_MAX_VALUE: NumericField = NumericField('columnMaxValue', 'columnMaxValue') class-attribute

Greatest value in a numeric column.

COLUMN_MEAN: NumericField = NumericField('columnMean', 'columnMean') class-attribute

Arithmetic mean of the values in a numeric column.

COLUMN_MEAN_VALUE: NumericField = NumericField('columnMeanValue', 'columnMeanValue') class-attribute

Arithmetic mean of the values in a numeric column.

COLUMN_MEASURE_TYPE: KeywordField = KeywordField('columnMeasureType', 'columnMeasureType') class-attribute

The type of measure/calculated column this is, eg: base, calculated, derived.

COLUMN_MEDIAN: NumericField = NumericField('columnMedian', 'columnMedian') class-attribute

Calculated median of the values in a numeric column.

COLUMN_MEDIAN_VALUE: NumericField = NumericField('columnMedianValue', 'columnMedianValue') class-attribute

Calculated median of the values in a numeric column.

COLUMN_MIN: NumericField = NumericField('columnMin', 'columnMin') class-attribute

Least value in a numeric column.

COLUMN_MINIMUM_STRING_LENGTH: NumericField = NumericField('columnMinimumStringLength', 'columnMinimumStringLength') class-attribute

Length of the shortest value in a string column.

COLUMN_MINS: TextField = TextField('columnMins', 'columnMins') class-attribute

List of the least values in a column.

COLUMN_MIN_VALUE: NumericField = NumericField('columnMinValue', 'columnMinValue') class-attribute

Least value in a numeric column.

COLUMN_MISSING_VALUES_COUNT: NumericField = NumericField('columnMissingValuesCount', 'columnMissingValuesCount') class-attribute

Number of rows in a column that do not contain content.

COLUMN_MISSING_VALUES_COUNT_LONG: NumericField = NumericField('columnMissingValuesCountLong', 'columnMissingValuesCountLong') class-attribute

Number of rows in a column that do not contain content.

COLUMN_MISSING_VALUES_PERCENTAGE: NumericField = NumericField('columnMissingValuesPercentage', 'columnMissingValuesPercentage') class-attribute

Percentage of rows in a column that do not contain content.

COLUMN_STANDARD_DEVIATION: NumericField = NumericField('columnStandardDeviation', 'columnStandardDeviation') class-attribute

Calculated standard deviation of the values in a numeric column.

COLUMN_STANDARD_DEVIATION_VALUE: NumericField = NumericField('columnStandardDeviationValue', 'columnStandardDeviationValue') class-attribute

Calculated standard deviation of the values in a numeric column.

COLUMN_SUM: NumericField = NumericField('columnSum', 'columnSum') class-attribute

Calculated sum of the values in a numeric column.

COLUMN_SUM_VALUE: NumericField = NumericField('columnSumValue', 'columnSumValue') class-attribute

Calculated sum of the values in a numeric column.

COLUMN_TOP_VALUES: KeywordField = KeywordField('columnTopValues', 'columnTopValues') class-attribute

List of top values in this column.

COLUMN_UNIQUENESS_PERCENTAGE: NumericField = NumericField('columnUniquenessPercentage', 'columnUniquenessPercentage') class-attribute

Ratio indicating how unique data in this column is: 0 indicates that all values are the same, 100 indicates that all values in this column are unique.

COLUMN_UNIQUE_VALUES_COUNT: NumericField = NumericField('columnUniqueValuesCount', 'columnUniqueValuesCount') class-attribute

Number of rows in which a value in this column appears only once.

COLUMN_UNIQUE_VALUES_COUNT_LONG: NumericField = NumericField('columnUniqueValuesCountLong', 'columnUniqueValuesCountLong') class-attribute

Number of rows in which a value in this column appears only once.

COLUMN_VARIANCE: NumericField = NumericField('columnVariance', 'columnVariance') class-attribute

Calculated variance of the values in a numeric column.

COLUMN_VARIANCE_VALUE: NumericField = NumericField('columnVarianceValue', 'columnVarianceValue') class-attribute

Calculated variance of the values in a numeric column.

COSMOS_MONGO_DB_COLLECTION: RelationField = RelationField('cosmosMongoDBCollection') class-attribute

TBC

DATA_QUALITY_METRIC_DIMENSIONS: RelationField = RelationField('dataQualityMetricDimensions') class-attribute

TBC

DATA_TYPE: KeywordTextField = KeywordTextField('dataType', 'dataType', 'dataType.text') class-attribute

Data type of values in this column.

DBT_METRICS: RelationField = RelationField('dbtMetrics') class-attribute

TBC

DBT_MODEL_COLUMNS: RelationField = RelationField('dbtModelColumns') class-attribute

TBC

DEFAULT_VALUE: TextField = TextField('defaultValue', 'defaultValue') class-attribute

Default value for this column.

DQ_BASE_COLUMN_RULES: RelationField = RelationField('dqBaseColumnRules') class-attribute

TBC

DQ_REFERENCE_COLUMN_RULES: RelationField = RelationField('dqReferenceColumnRules') class-attribute

TBC

FOREIGN_KEY_FROM: RelationField = RelationField('foreignKeyFrom') class-attribute

TBC

FOREIGN_KEY_TO: RelationField = RelationField('foreignKeyTo') class-attribute

TBC

IS_CLUSTERED: BooleanField = BooleanField('isClustered', 'isClustered') class-attribute

Whether this column is a clustered column (true) or not (false).

IS_DIST: BooleanField = BooleanField('isDist', 'isDist') class-attribute

Whether this column is a distribution column (true) or not (false).

IS_FOREIGN: BooleanField = BooleanField('isForeign', 'isForeign') class-attribute

When true, this column is a foreign key to another table. NOTE: this must be true when using the foreignKeyTo relationship to specify columns that refer to this column as a foreign key.

IS_INDEXED: BooleanField = BooleanField('isIndexed', 'isIndexed') class-attribute

When true, this column is indexed in the database.

IS_NULLABLE: BooleanField = BooleanField('isNullable', 'isNullable') class-attribute

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

IS_PARTITION: BooleanField = BooleanField('isPartition', 'isPartition') class-attribute

Whether this column is a partition column (true) or not (false).

IS_PINNED: BooleanField = BooleanField('isPinned', 'isPinned') class-attribute

Whether this column is pinned (true) or not (false).

IS_PRIMARY: BooleanField = BooleanField('isPrimary', 'isPrimary') class-attribute

When true, this column is the primary key for the table.

IS_SORT: BooleanField = BooleanField('isSort', 'isSort') class-attribute

Whether this column is a sort column (true) or not (false).

MATERIALISED_VIEW: RelationField = RelationField('materialisedView') class-attribute

TBC

MAX_LENGTH: NumericField = NumericField('maxLength', 'maxLength') class-attribute

Maximum length of a value in this column.

METRIC_TIMESTAMPS: RelationField = RelationField('metricTimestamps') class-attribute

TBC

MONGO_DB_COLLECTION: RelationField = RelationField('mongoDBCollection') class-attribute

TBC

NESTED_COLUMNS: RelationField = RelationField('nestedColumns') class-attribute

TBC

NESTED_COLUMN_COUNT: NumericField = NumericField('nestedColumnCount', 'nestedColumnCount') class-attribute

Number of columns nested within this (STRUCT or NESTED) column.

NESTED_COLUMN_ORDER: KeywordField = KeywordField('nestedColumnOrder', 'nestedColumnOrder') class-attribute

Order (position) in which this column appears in the nested Column (nest level starts at 1).

NOSQL_COLLECTION_NAME: KeywordTextField = KeywordTextField('nosqlCollectionName', 'nosqlCollectionName.keyword', 'nosqlCollectionName') class-attribute

Simple name of the cosmos/mongo collection in which this SQL asset (column) exists, or empty if it does not exist within a cosmos/mongo collection.

NOSQL_COLLECTION_QUALIFIED_NAME: KeywordField = KeywordField('nosqlCollectionQualifiedName', 'nosqlCollectionQualifiedName') class-attribute

Unique name of the cosmos/mongo collection in which this SQL asset (column) exists, or empty if it does not exist within a cosmos/mongo collection.

NUMERIC_SCALE: NumericField = NumericField('numericScale', 'numericScale') class-attribute

Number of digits allowed to the right of the decimal point.

ORDER: NumericField = NumericField('order', 'order') class-attribute

Order (position) in which this column appears in the table (starting at 1).

PARENT_COLUMN: RelationField = RelationField('parentColumn') class-attribute

TBC

PARENT_COLUMN_NAME: KeywordTextField = KeywordTextField('parentColumnName', 'parentColumnName.keyword', 'parentColumnName') class-attribute

Simple name of the column this column is nested within, for STRUCT and NESTED columns.

PARENT_COLUMN_QUALIFIED_NAME: KeywordTextField = KeywordTextField('parentColumnQualifiedName', 'parentColumnQualifiedName', 'parentColumnQualifiedName.text') class-attribute

Unique name of the column this column is nested within, for STRUCT and NESTED columns.

PARTITION_ORDER: NumericField = NumericField('partitionOrder', 'partitionOrder') class-attribute

Order (position) of this partition column in the table.

PINNED_AT: NumericField = NumericField('pinnedAt', 'pinnedAt') class-attribute

Time (epoch) at which this column was pinned, in milliseconds.

PINNED_BY: KeywordField = KeywordField('pinnedBy', 'pinnedBy') class-attribute

User who pinned this column.

PRECISION: NumericField = NumericField('precision', 'precision') class-attribute

Total number of digits allowed, when the dataType is numeric.

QUERIES: RelationField = RelationField('queries') class-attribute

TBC

RAW_DATA_TYPE_DEFINITION: TextField = TextField('rawDataTypeDefinition', 'rawDataTypeDefinition') class-attribute

Raw data type definition of this column.

SNOWFLAKE_DYNAMIC_TABLE: RelationField = RelationField('snowflakeDynamicTable') class-attribute

TBC

SUB_DATA_TYPE: KeywordField = KeywordField('subDataType', 'subDataType') class-attribute

Sub-data type of this column.

TABLE: RelationField = RelationField('table') class-attribute

TBC

TABLE_PARTITION: RelationField = RelationField('tablePartition') class-attribute

TBC

VALIDATIONS: KeywordField = KeywordField('validations', 'validations') class-attribute

Validations for this column.

VIEW: RelationField = RelationField('view') class-attribute

TBC

Classes

Attributes

Bases: Attributes

Functions
create(*, name: str, parent_qualified_name: str, parent_type: type, order: int, parent_name: Optional[str] = None, database_name: Optional[str] = None, database_qualified_name: Optional[str] = None, schema_name: Optional[str] = None, schema_qualified_name: Optional[str] = None, table_name: Optional[str] = None, table_qualified_name: Optional[str] = None, connection_qualified_name: Optional[str] = None) -> Column.Attributes classmethod

Builds the minimal object necessary to create a Column.

:param name: name of the Column :param parent_qualified_name: unique name of the table / view / materialized view / table partition / snowflake dynamic table in which this Column exist :param parent_type: type of parent (table, view, materialized view, table partition, snowflake dynamic table), should be a TYPE_NAME static string :param order: the order the Column appears within its parent (the Column's position) :param parent_name: simple name of the table / view / materialized view / table partition / snowflake dynamic table in which the Column is created :param database_name: simple name of the database in which the Column should be created :param database_qualified_name: unique name of the database in which the Column should be created :param schema_name: simple name of the schema in which the Column should be created :param schema_qualified_name: unique name of the schema in which the Column should be created :param table_name: (deprecated - unused) :param table_qualified_name: (deprecated - unused) :param connection_qualified_name: unique name of the connection in which the Column should be created :returns: the minimal request necessary to create the Column

Source code in pyatlan/model/assets/core/column.py 
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
@classmethod
@init_guid
def create(
    cls,
    *,
    name: str,
    parent_qualified_name: str,
    parent_type: type,
    order: int,
    parent_name: Optional[str] = None,
    database_name: Optional[str] = None,
    database_qualified_name: Optional[str] = None,
    schema_name: Optional[str] = None,
    schema_qualified_name: Optional[str] = None,
    table_name: Optional[str] = None,
    table_qualified_name: Optional[str] = None,
    connection_qualified_name: Optional[str] = None,
) -> Column.Attributes:
    """
    Builds the minimal object necessary to create a Column.

    :param name: name of the Column
    :param parent_qualified_name: unique name of the table / view / materialized view
    / table partition / snowflake dynamic table in which this Column exist
    :param parent_type: type of parent (table, view, materialized view,
    table partition, snowflake dynamic table), should be a TYPE_NAME static string
    :param order: the order the Column appears within its parent (the Column's position)
    :param parent_name: simple name of the table / view / materialized view
    / table partition / snowflake dynamic table in which the Column is created
    :param database_name: simple name of the database in which the Column should be created
    :param database_qualified_name: unique name of the database in which the Column should be created
    :param schema_name: simple name of the schema in which the Column should be created
    :param schema_qualified_name: unique name of the schema in which the Column should be created
    :param table_name: (deprecated - unused)
    :param table_qualified_name: (deprecated - unused)
    :param connection_qualified_name: unique name of the connection in which the Column should be created
    :returns: the minimal request necessary to create the Column
    """
    validate_required_fields(
        ["name", "parent_qualified_name", "parent_type", "order"],
        [name, parent_qualified_name, parent_type, order],
    )
    if connection_qualified_name:
        connector_name = AtlanConnectorType.get_connector_name(
            connection_qualified_name
        )
    else:
        connection_qn, connector_name = AtlanConnectorType.get_connector_name(
            parent_qualified_name, "parent_qualified_name", 6
        )
    if order < 0:
        raise ValueError("Order must be be a positive integer")

    fields = parent_qualified_name.split("/")
    qualified_name = f"{parent_qualified_name}/{name}"
    connection_qualified_name = connection_qualified_name or connection_qn
    database_name = database_name or fields[3]
    schema_name = schema_name or fields[4]
    parent_name = parent_name or fields[5]
    database_qualified_name = (
        database_qualified_name
        or f"{connection_qualified_name}/{database_name}"
    )
    schema_qualified_name = (
        schema_qualified_name or f"{database_qualified_name}/{schema_name}"
    )

    column = Column.Attributes(
        name=name,
        order=order,
        qualified_name=qualified_name,
        connector_name=connector_name,
        connection_qualified_name=connection_qualified_name,
        schema_name=schema_name,
        schema_qualified_name=schema_qualified_name,
        database_name=database_name,
        database_qualified_name=database_qualified_name,
    )

    if parent_type == Table:
        column.table_qualified_name = parent_qualified_name
        column.table = Table.ref_by_qualified_name(parent_qualified_name)
        column.table_name = parent_name
    elif parent_type == View:
        column.view_qualified_name = parent_qualified_name
        column.view = View.ref_by_qualified_name(parent_qualified_name)
        column.view_name = parent_name
    elif parent_type == MaterialisedView:
        column.view_qualified_name = parent_qualified_name
        column.materialised_view = MaterialisedView.ref_by_qualified_name(
            parent_qualified_name
        )
        column.view_name = parent_name
    elif parent_type == TablePartition:
        column.table_qualified_name = parent_qualified_name
        column.table_partition = TablePartition.ref_by_qualified_name(
            parent_qualified_name
        )
        column.table_name = parent_name
    elif parent_type == SnowflakeDynamicTable:
        column.table_qualified_name = parent_qualified_name
        column.snowflake_dynamic_table = (
            SnowflakeDynamicTable.ref_by_qualified_name(parent_qualified_name)
        )
        column.table_name = parent_name
    else:
        raise ValueError(
            "parent_type must be either Table, SnowflakeDynamicTable, View, MaterializeView or TablePartition"
        )
    return column

Functions

creator(*, name: str, parent_qualified_name: str, parent_type: type, order: int, parent_name: Optional[str] = None, database_name: Optional[str] = None, database_qualified_name: Optional[str] = None, schema_name: Optional[str] = None, schema_qualified_name: Optional[str] = None, table_name: Optional[str] = None, table_qualified_name: Optional[str] = None, connection_qualified_name: Optional[str] = None) -> Column classmethod 

creator(
    *,
    name: str,
    parent_qualified_name: str,
    parent_type: type,
    order: int,
) -> Column

creator(
    *,
    name: str,
    parent_qualified_name: str,
    parent_type: type,
    order: int,
    parent_name: str,
    database_name: str,
    database_qualified_name: str,
    schema_name: str,
    schema_qualified_name: str,
    table_name: str,
    table_qualified_name: str,
    connection_qualified_name: str,
) -> Column

Builds the minimal object necessary to create a Column.

:param name: name of the Column :param parent_qualified_name: unique name of the table / view / materialized view / table partition / snowflake dynamic table in which this Column exists :param parent_type: type of parent (table, view, materialized view, table partition, snowflake dynamic table), should be a TYPE_NAME static string :param order: the order the Column appears within its parent (the Column's position) :param parent_name: simple name of the table / view / materialized view / table partition / snowflake dynamic table in which the Column should be created :param database_name: simple name of the database in which the Column should be created :param database_qualified_name: unique name of the database in which the Column should be created :param schema_name: simple name of the schema in which the Column should be created :param schema_qualified_name: unique name of the schema in which the Column should be created :param table_name: (deprecated - unused) :param table_qualified_name: (deprecated - unused) :param connection_qualified_name: unique name of the connection in which the Column should be created :returns: the minimal request necessary to create the Column

Source code in pyatlan/model/assets/core/column.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
@classmethod
@init_guid
def creator(
    cls,
    *,
    name: str,
    parent_qualified_name: str,
    parent_type: type,
    order: int,
    parent_name: Optional[str] = None,
    database_name: Optional[str] = None,
    database_qualified_name: Optional[str] = None,
    schema_name: Optional[str] = None,
    schema_qualified_name: Optional[str] = None,
    table_name: Optional[str] = None,
    table_qualified_name: Optional[str] = None,
    connection_qualified_name: Optional[str] = None,
) -> Column:
    """
    Builds the minimal object necessary to create a Column.

    :param name: name of the Column
    :param parent_qualified_name: unique name of the table / view / materialized view
    / table partition / snowflake dynamic table in which this Column exists
    :param parent_type: type of parent (table, view, materialized view,
    table partition, snowflake dynamic table), should be a TYPE_NAME static string
    :param order: the order the Column appears within its parent (the Column's position)
    :param parent_name: simple name of the table / view / materialized view / table partition
    / snowflake dynamic table in which the Column should be created
    :param database_name: simple name of the database in which the Column should be created
    :param database_qualified_name: unique name of the database in which the Column should be created
    :param schema_name: simple name of the schema in which the Column should be created
    :param schema_qualified_name: unique name of the schema in which the Column should be created
    :param table_name: (deprecated - unused)
    :param table_qualified_name: (deprecated - unused)
    :param connection_qualified_name: unique name of the connection in which the Column should be created
    :returns: the minimal request necessary to create the Column
    """
    if table_name:
        warn(
            ("`table_name` is deprecated, please use `parent_name` instead"),
            DeprecationWarning,
            stacklevel=2,
        )
    if table_qualified_name:
        warn(
            (
                "`table_qualified_name` is deprecated, please use `parent_qualified_name` instead"
            ),
            DeprecationWarning,
            stacklevel=2,
        )
    return Column(
        attributes=Column.Attributes.create(
            name=name,
            parent_qualified_name=parent_qualified_name,
            parent_type=parent_type,
            order=order,
            parent_name=parent_name,
            database_name=database_name,
            database_qualified_name=database_qualified_name,
            schema_name=schema_name,
            schema_qualified_name=schema_qualified_name,
            table_name=table_name,
            table_qualified_name=table_qualified_name,
            connection_qualified_name=connection_qualified_name,
        )
    )

DataContract

pyatlan.model.assets.core.data_contract.DataContract(__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

DATA_CONTRACT_ASSET_CERTIFIED: RelationField = RelationField('dataContractAssetCertified') class-attribute

TBC

DATA_CONTRACT_ASSET_GUID: KeywordField = KeywordField('dataContractAssetGuid', 'dataContractAssetGuid') class-attribute

Unique identifier of the asset associated with this data contract.

DATA_CONTRACT_ASSET_LATEST: RelationField = RelationField('dataContractAssetLatest') class-attribute

TBC

DATA_CONTRACT_JSON: TextField = TextField('dataContractJson', 'dataContractJson') class-attribute

(Deprecated) Replaced by dataContractSpec attribute.

DATA_CONTRACT_NEXT_VERSION: RelationField = RelationField('dataContractNextVersion') class-attribute

TBC

DATA_CONTRACT_PREVIOUS_VERSION: RelationField = RelationField('dataContractPreviousVersion') class-attribute

TBC

DATA_CONTRACT_SPEC: TextField = TextField('dataContractSpec', 'dataContractSpec') class-attribute

Actual content of the contract in YAML string format. Any changes to this string should create a new instance (with new sequential version number).

DATA_CONTRACT_VERSION: NumericField = NumericField('dataContractVersion', 'dataContractVersion') class-attribute

Version of the contract.

Database

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

Bases: SQL

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

FABRIC_WORKSPACE: RelationField = RelationField('fabricWorkspace') class-attribute

TBC

SCHEMAS: RelationField = RelationField('schemas') class-attribute

TBC

SCHEMA_COUNT: NumericField = NumericField('schemaCount', 'schemaCount') class-attribute

Number of schemas in this database.

Function

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

Bases: SQL

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

FUNCTION_ARGUMENTS: KeywordField = KeywordField('functionArguments', 'functionArguments') class-attribute

Arguments that are passed in to the function.

FUNCTION_DEFINITION: TextField = TextField('functionDefinition', 'functionDefinition') class-attribute

Code or set of statements that determine the output of the function.

FUNCTION_EXTERNAL_ACCESS_INTEGRATIONS: KeywordField = KeywordField('functionExternalAccessIntegrations', 'functionExternalAccessIntegrations') class-attribute

Names of external access integrations used by the function.

FUNCTION_INSTALLED_PACKAGES: KeywordField = KeywordField('functionInstalledPackages', 'functionInstalledPackages') class-attribute

Packages actually installed for the function.

FUNCTION_IS_DMF: BooleanField = BooleanField('functionIsDMF', 'functionIsDMF') class-attribute

Whether the function is a data metric function.

FUNCTION_IS_EXTERNAL: BooleanField = BooleanField('functionIsExternal', 'functionIsExternal') class-attribute

Whether the function is stored or executed externally (true) or internally (false).

FUNCTION_IS_MEMOIZABLE: BooleanField = BooleanField('functionIsMemoizable', 'functionIsMemoizable') class-attribute

Whether the function must re-compute if there are no underlying changes in the values (false) or not (true).

FUNCTION_IS_SECURE: BooleanField = BooleanField('functionIsSecure', 'functionIsSecure') class-attribute

Whether sensitive information of the function is omitted for unauthorized users (true) or not (false).

FUNCTION_LANGUAGE: KeywordField = KeywordField('functionLanguage', 'functionLanguage') class-attribute

Programming language in which the function is written.

FUNCTION_PACKAGES: KeywordField = KeywordField('functionPackages', 'functionPackages') class-attribute

Packages requested by the function.

FUNCTION_RETURN_TYPE: KeywordField = KeywordField('functionReturnType', 'functionReturnType') class-attribute

Data type of the value returned by the function.

FUNCTION_RUNTIME_VERSION: KeywordTextField = KeywordTextField('functionRuntimeVersion', 'functionRuntimeVersion.keyword', 'functionRuntimeVersion') class-attribute

Version of the language runtime used by the function.

FUNCTION_SCHEMA: RelationField = RelationField('functionSchema') class-attribute

TBC

FUNCTION_SECRETS: KeywordField = KeywordField('functionSecrets', 'functionSecrets') class-attribute

Secret variables used by the function.

FUNCTION_TYPE: KeywordField = KeywordField('functionType', 'functionType') class-attribute

Type of function.

SQL_PROCESSES: RelationField = RelationField('sqlProcesses') class-attribute

TBC

MaterialisedView

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

Bases: SQL

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

ALIAS: TextField = TextField('alias', 'alias') class-attribute

Alias for this materialized view.

ATLAN_SCHEMA: RelationField = RelationField('atlanSchema') class-attribute

TBC

COLUMNS: RelationField = RelationField('columns') class-attribute

TBC

COLUMN_COUNT: NumericField = NumericField('columnCount', 'columnCount') class-attribute

Number of columns in this materialized view.

DEFINITION: TextField = TextField('definition', 'definition') class-attribute

SQL definition of this materialized view.

IS_QUERY_PREVIEW: BooleanField = BooleanField('isQueryPreview', 'isQueryPreview') class-attribute

Whether it's possible to run a preview query on this materialized view (true) or not (false).

IS_TEMPORARY: BooleanField = BooleanField('isTemporary', 'isTemporary') class-attribute

Whether this materialized view is temporary (true) or not (false).

QUERY_PREVIEW_CONFIG: KeywordField = KeywordField('queryPreviewConfig', 'queryPreviewConfig') class-attribute

Configuration for the query preview of this materialized view.

REFRESH_METHOD: KeywordField = KeywordField('refreshMethod', 'refreshMethod') class-attribute

Refresh method for this materialized view.

REFRESH_MODE: KeywordField = KeywordField('refreshMode', 'refreshMode') class-attribute

Refresh mode for this materialized view.

ROW_COUNT: NumericField = NumericField('rowCount', 'rowCount') class-attribute

Number of rows in this materialized view.

SIZE_BYTES: NumericField = NumericField('sizeBytes', 'sizeBytes') class-attribute

Size of this materialized view, in bytes.

STALENESS: TextField = TextField('staleness', 'staleness') class-attribute

Staleness of this materialized view.

STALE_SINCE_DATE: NumericField = NumericField('staleSinceDate', 'staleSinceDate') class-attribute

Time (epoch) from which this materialized view is stale, in milliseconds.

Partial

pyatlan.model.assets.core.partial.Partial(__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

PARTIAL_PARENT_QUALIFIED_NAME: KeywordField = KeywordField('partialParentQualifiedName', 'partialParentQualifiedName') class-attribute

Unique name of the field's parent asset.

PARTIAL_PARENT_TYPE: KeywordField = KeywordField('partialParentType', 'partialParentType') class-attribute

Type of the field's parent asset.

PARTIAL_RESOLVED_TYPE_NAME: KeywordField = KeywordField('partialResolvedTypeName', 'partialResolvedTypeName') class-attribute

Atlan-mapped type name of this partial asset.

PARTIAL_STRUCTURE_JSON: KeywordField = KeywordField('partialStructureJSON', 'partialStructureJSON') class-attribute

Complete JSON structure of this partial asset, as a string.

PARTIAL_UNKNOWN_ATTRIBUTES_HASH_ID: KeywordField = KeywordField('partialUnknownAttributesHashId', 'partialUnknownAttributesHashId') class-attribute

Hash ID of the unknown attributes for this partial asset.

PartialField

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

Bases: Partial

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

PARTIAL_DATA_TYPE: KeywordField = KeywordField('partialDataType', 'partialDataType') class-attribute

Type of data captured as values in the field.

PARTIAL_PARENT_ASSET: RelationField = RelationField('partialParentAsset') class-attribute

TBC

PartialObject

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

Bases: Partial

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

PARTIAL_PARENT_ASSET: RelationField = RelationField('partialParentAsset') class-attribute

TBC

Procedure

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

Bases: SQL

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

ATLAN_SCHEMA: RelationField = RelationField('atlanSchema') class-attribute

TBC

DEFINITION: TextField = TextField('definition', 'definition') class-attribute

SQL definition of the procedure.

SQL_ARGUMENTS: KeywordField = KeywordField('sqlArguments', 'sqlArguments') class-attribute

List of procedure arguments with name and type information.

SQL_CATALOG_ID: KeywordField = KeywordField('sqlCatalogId', 'sqlCatalogId') class-attribute

Internal ID for the database containing the procedure.

SQL_EXTERNAL_ACCESS_INTEGRATIONS: KeywordField = KeywordField('sqlExternalAccessIntegrations', 'sqlExternalAccessIntegrations') class-attribute

Names of external access integrations used by the procedure.

SQL_INSTALLED_PACKAGES: KeywordField = KeywordField('sqlInstalledPackages', 'sqlInstalledPackages') class-attribute

Packages actually installed for the procedure.

SQL_LANGUAGE: KeywordTextField = KeywordTextField('sqlLanguage', 'sqlLanguage.keyword', 'sqlLanguage') class-attribute

Programming language used for the procedure (e.g., SQL, JavaScript, Python, Scala).

SQL_OWNER_ROLE_TYPE: KeywordTextField = KeywordTextField('sqlOwnerRoleType', 'sqlOwnerRoleType.keyword', 'sqlOwnerRoleType') class-attribute

Type of role that owns the procedure.

SQL_PACKAGES: KeywordField = KeywordField('sqlPackages', 'sqlPackages') class-attribute

Packages requested by the procedure.

SQL_PROCEDURE_RETURN: KeywordField = KeywordField('sqlProcedureReturn', 'sqlProcedureReturn') class-attribute

Detailed information about the procedure's return type.

SQL_PROCESSES: RelationField = RelationField('sqlProcesses') class-attribute

TBC

SQL_RUNTIME_VERSION: KeywordTextField = KeywordTextField('sqlRuntimeVersion', 'sqlRuntimeVersion.keyword', 'sqlRuntimeVersion') class-attribute

Version of the language runtime used by the procedure.

SQL_SCHEMA_ID: KeywordField = KeywordField('sqlSchemaId', 'sqlSchemaId') class-attribute

Internal ID for the schema containing the procedure.

SQL_SECRETS: KeywordField = KeywordField('sqlSecrets', 'sqlSecrets') class-attribute

Secret variables used by the procedure.

Query

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

Bases: SQL

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

COLLECTION_QUALIFIED_NAME: KeywordTextField = KeywordTextField('collectionQualifiedName', 'collectionQualifiedName', 'collectionQualifiedName.text') class-attribute

Unique name of the collection in which this query exists.

COLUMNS: RelationField = RelationField('columns') class-attribute

TBC

DEFAULT_DATABASE_QUALIFIED_NAME: KeywordTextField = KeywordTextField('defaultDatabaseQualifiedName', 'defaultDatabaseQualifiedName', 'defaultDatabaseQualifiedName.text') class-attribute

Unique name of the default database to use for this query.

DEFAULT_SCHEMA_QUALIFIED_NAME: KeywordTextField = KeywordTextField('defaultSchemaQualifiedName', 'defaultSchemaQualifiedName', 'defaultSchemaQualifiedName.text') class-attribute

Unique name of the default schema to use for this query.

IS_PRIVATE: BooleanField = BooleanField('isPrivate', 'isPrivate') class-attribute

Whether this query is private (true) or shared (false).

IS_SQL_SNIPPET: BooleanField = BooleanField('isSqlSnippet', 'isSqlSnippet') class-attribute

Whether this query is a SQL snippet (true) or not (false).

IS_VISUAL_QUERY: BooleanField = BooleanField('isVisualQuery', 'isVisualQuery') class-attribute

Whether this query is a visual query (true) or not (false).

LONG_RAW_QUERY: TextField = TextField('longRawQuery', 'longRawQuery') class-attribute

Raw SQL query string.

PARENT: RelationField = RelationField('parent') class-attribute

TBC

PARENT_QUALIFIED_NAME: KeywordTextField = KeywordTextField('parentQualifiedName', 'parentQualifiedName', 'parentQualifiedName.text') class-attribute

Unique name of the parent collection or folder in which this query exists.

RAW_QUERY: TextField = TextField('rawQuery', 'rawQuery') class-attribute

Deprecated. See 'longRawQuery' instead.

RAW_QUERY_TEXT: RelationField = RelationField('rawQueryText') class-attribute

TABLES: RelationField = RelationField('tables') class-attribute

TBC

VARIABLES_SCHEMA_BASE64: TextField = TextField('variablesSchemaBase64', 'variablesSchemaBase64') class-attribute

Base64-encoded string of the variables to use in this query.

VIEWS: RelationField = RelationField('views') class-attribute

TBC

VISUAL_BUILDER_SCHEMA_BASE64: TextField = TextField('visualBuilderSchemaBase64', 'visualBuilderSchemaBase64') class-attribute

Base64-encoded string for the visual query builder.

SQL

pyatlan.model.assets.core.s_q_l.SQL(__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

CALCULATION_VIEW_NAME: KeywordTextField = KeywordTextField('calculationViewName', 'calculationViewName.keyword', 'calculationViewName') class-attribute

Simple name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.

CALCULATION_VIEW_QUALIFIED_NAME: KeywordField = KeywordField('calculationViewQualifiedName', 'calculationViewQualifiedName') class-attribute

Unique name of the calculation view in which this SQL asset exists, or empty if it does not exist within a calculation view.

DATABASE_NAME: KeywordTextField = KeywordTextField('databaseName', 'databaseName.keyword', 'databaseName') class-attribute

Simple name of the database in which this SQL asset exists, or empty if it does not exist within a database.

DATABASE_QUALIFIED_NAME: KeywordField = KeywordField('databaseQualifiedName', 'databaseQualifiedName') class-attribute

Unique name of the database in which this SQL asset exists, or empty if it does not exist within a database.

DBT_MODELS: RelationField = RelationField('dbtModels') class-attribute

TBC

DBT_SEED_ASSETS: RelationField = RelationField('dbtSeedAssets') class-attribute

TBC

DBT_SOURCES: RelationField = RelationField('dbtSources') class-attribute

TBC

DBT_TESTS: RelationField = RelationField('dbtTests') class-attribute

TBC

IS_PROFILED: BooleanField = BooleanField('isProfiled', 'isProfiled') class-attribute

Whether this asset has been profiled (true) or not (false).

LAST_PROFILED_AT: NumericField = NumericField('lastProfiledAt', 'lastProfiledAt') class-attribute

Time (epoch) at which this asset was last profiled, in milliseconds.

QUERY_COUNT: NumericField = NumericField('queryCount', 'queryCount') class-attribute

Number of times this asset has been queried.

QUERY_COUNT_UPDATED_AT: NumericField = NumericField('queryCountUpdatedAt', 'queryCountUpdatedAt') class-attribute

Time (epoch) at which the query count was last updated, in milliseconds.

QUERY_USER_COUNT: NumericField = NumericField('queryUserCount', 'queryUserCount') class-attribute

Number of unique users who have queried this asset.

QUERY_USER_MAP: KeywordField = KeywordField('queryUserMap', 'queryUserMap') class-attribute

Map of unique users who have queried this asset to the number of times they have queried it.

SCHEMA_NAME: KeywordTextField = KeywordTextField('schemaName', 'schemaName.keyword', 'schemaName') class-attribute

Simple name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.

SCHEMA_QUALIFIED_NAME: KeywordField = KeywordField('schemaQualifiedName', 'schemaQualifiedName') class-attribute

Unique name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.

SQL_AI_MODEL_CONTEXT_QUALIFIED_NAME: KeywordField = KeywordField('sqlAIModelContextQualifiedName', 'sqlAIModelContextQualifiedName') class-attribute

Unique name of the context in which the model versions exist, or empty if it does not exist within an AI model context.

SQL_DBT_MODELS: RelationField = RelationField('sqlDbtModels') class-attribute

TBC

SQL_DBT_SOURCES: RelationField = RelationField('sqlDBTSources') class-attribute

TBC

SQL_IS_SECURE: BooleanField = BooleanField('sqlIsSecure', 'sqlIsSecure') class-attribute

Whether this asset is secure (true) or not (false).

TABLE_NAME: KeywordTextField = KeywordTextField('tableName', 'tableName.keyword', 'tableName') class-attribute

Simple name of the table in which this SQL asset exists, or empty if it does not exist within a table.

TABLE_QUALIFIED_NAME: KeywordField = KeywordField('tableQualifiedName', 'tableQualifiedName') class-attribute

Unique name of the table in which this SQL asset exists, or empty if it does not exist within a table.

VIEW_NAME: KeywordTextField = KeywordTextField('viewName', 'viewName.keyword', 'viewName') class-attribute

Simple name of the view in which this SQL asset exists, or empty if it does not exist within a view.

VIEW_QUALIFIED_NAME: KeywordField = KeywordField('viewQualifiedName', 'viewQualifiedName') class-attribute

Unique name of the view in which this SQL asset exists, or empty if it does not exist within a view.

Schema

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

Bases: SQL

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

BIGQUERY_ROUTINES: RelationField = RelationField('bigqueryRoutines') class-attribute

TBC

CALCULATION_VIEWS: RelationField = RelationField('calculationViews') class-attribute

TBC

DATABASE: RelationField = RelationField('database') class-attribute

TBC

DATABRICKS_AI_MODEL_CONTEXTS: RelationField = RelationField('databricksAIModelContexts') class-attribute

TBC

DATABRICKS_VOLUMES: RelationField = RelationField('databricksVolumes') class-attribute

TBC

FUNCTIONS: RelationField = RelationField('functions') class-attribute

TBC

LINKED_SCHEMA_QUALIFIED_NAME: KeywordField = KeywordField('linkedSchemaQualifiedName', 'linkedSchemaQualifiedName') class-attribute

Unique name of the Linked Schema on which this Schema is dependent. This concept is mostly applicable for linked datasets/datasource in Google BigQuery via Analytics Hub Listing

MATERIALISED_VIEWS: RelationField = RelationField('materialisedViews') class-attribute

TBC

PROCEDURES: RelationField = RelationField('procedures') class-attribute

TBC

SCHEMA_EXTERNAL_LOCATION: KeywordField = KeywordField('schemaExternalLocation', 'schemaExternalLocation') class-attribute

External location of this schema, for example: an S3 object location.

SNOWFLAKE_AI_MODEL_CONTEXTS: RelationField = RelationField('snowflakeAIModelContexts') class-attribute

TBC

SNOWFLAKE_DYNAMIC_TABLES: RelationField = RelationField('snowflakeDynamicTables') class-attribute

TBC

SNOWFLAKE_PIPES: RelationField = RelationField('snowflakePipes') class-attribute

TBC

SNOWFLAKE_STAGES: RelationField = RelationField('snowflakeStages') class-attribute

TBC

SNOWFLAKE_STREAMS: RelationField = RelationField('snowflakeStreams') class-attribute

TBC

SNOWFLAKE_TAGS: RelationField = RelationField('snowflakeTags') class-attribute

TBC

TABLES: RelationField = RelationField('tables') class-attribute

TBC

TABLE_COUNT: NumericField = NumericField('tableCount', 'tableCount') class-attribute

Number of tables in this schema.

VIEWS: RelationField = RelationField('views') class-attribute

TBC

VIEWS_COUNT: NumericField = NumericField('viewsCount', 'viewsCount') class-attribute

Number of views in this schema.

Table

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

Bases: SQL

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

ALIAS: TextField = TextField('alias', 'alias') class-attribute

Alias for this table.

ATLAN_SCHEMA: RelationField = RelationField('atlanSchema') class-attribute

TBC

COLUMNS: RelationField = RelationField('columns') class-attribute

TBC

COLUMN_COUNT: NumericField = NumericField('columnCount', 'columnCount') class-attribute

Number of columns in this table.

DIMENSIONS: RelationField = RelationField('dimensions') class-attribute

TBC

EXTERNAL_LOCATION: TextField = TextField('externalLocation', 'externalLocation') class-attribute

External location of this table, for example: an S3 object location.

EXTERNAL_LOCATION_FORMAT: KeywordField = KeywordField('externalLocationFormat', 'externalLocationFormat') class-attribute

Format of the external location of this table, for example: JSON, CSV, PARQUET, etc.

EXTERNAL_LOCATION_REGION: TextField = TextField('externalLocationRegion', 'externalLocationRegion') class-attribute

Region of the external location of this table, for example: S3 region.

FACTS: RelationField = RelationField('facts') class-attribute

TBC

ICEBERG_CATALOG_NAME: KeywordField = KeywordField('icebergCatalogName', 'icebergCatalogName') class-attribute

Iceberg table catalog name (can be any user defined name)

ICEBERG_CATALOG_SOURCE: KeywordField = KeywordField('icebergCatalogSource', 'icebergCatalogSource') class-attribute

Iceberg table catalog type (glue, polaris, snowflake)

ICEBERG_CATALOG_TABLE_NAME: KeywordField = KeywordField('icebergCatalogTableName', 'icebergCatalogTableName') class-attribute

Catalog table name (actual table name on the catalog side).

ICEBERG_CATALOG_TABLE_NAMESPACE: KeywordField = KeywordField('icebergCatalogTableNamespace', 'icebergCatalogTableNamespace') class-attribute

Catalog table namespace (actual database name on the catalog side).

ICEBERG_TABLE_BASE_LOCATION: KeywordField = KeywordField('icebergTableBaseLocation', 'icebergTableBaseLocation') class-attribute

Iceberg table base location inside the external volume.

ICEBERG_TABLE_TYPE: KeywordField = KeywordField('icebergTableType', 'icebergTableType') class-attribute

Iceberg table type (managed vs unmanaged)

IS_PARTITIONED: BooleanField = BooleanField('isPartitioned', 'isPartitioned') class-attribute

Whether this table is partitioned (true) or not (false).

IS_QUERY_PREVIEW: BooleanField = BooleanField('isQueryPreview', 'isQueryPreview') class-attribute

Whether preview queries are allowed for this table (true) or not (false).

IS_SHARDED: BooleanField = BooleanField('isSharded', 'isSharded') class-attribute

Whether this table is a sharded table (true) or not (false).

IS_TEMPORARY: BooleanField = BooleanField('isTemporary', 'isTemporary') class-attribute

Whether this table is temporary (true) or not (false).

PARTITIONS: RelationField = RelationField('partitions') class-attribute

TBC

PARTITION_COUNT: NumericField = NumericField('partitionCount', 'partitionCount') class-attribute

Number of partitions in this table.

PARTITION_LIST: TextField = TextField('partitionList', 'partitionList') class-attribute

List of partitions in this table.

PARTITION_STRATEGY: KeywordField = KeywordField('partitionStrategy', 'partitionStrategy') class-attribute

Partition strategy for this table.

QUERIES: RelationField = RelationField('queries') class-attribute

TBC

QUERY_PREVIEW_CONFIG: KeywordField = KeywordField('queryPreviewConfig', 'queryPreviewConfig') class-attribute

Configuration for preview queries.

ROW_COUNT: NumericField = NumericField('rowCount', 'rowCount') class-attribute

Number of rows in this table.

SIZE_BYTES: NumericField = NumericField('sizeBytes', 'sizeBytes') class-attribute

Size of this table, in bytes.

TABLE_DEFINITION: TextField = TextField('tableDefinition', 'tableDefinition') class-attribute

Definition of the table.

TABLE_EXTERNAL_VOLUME_NAME: KeywordField = KeywordField('tableExternalVolumeName', 'tableExternalVolumeName') class-attribute

External volume name for the table.

TABLE_IMPALA_PARAMETERS: KeywordField = KeywordField('tableImpalaParameters', 'tableImpalaParameters') class-attribute

Extra attributes for Impala

TABLE_OBJECT_COUNT: NumericField = NumericField('tableObjectCount', 'tableObjectCount') class-attribute

Number of objects in this table.

TABLE_RETENTION_TIME: NumericField = NumericField('tableRetentionTime', 'tableRetentionTime') class-attribute

Data retention time in days.

TABLE_TYPE: KeywordField = KeywordField('tableType', 'tableType') class-attribute

Type of the table.

TablePartition

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

Bases: SQL

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

ALIAS: TextField = TextField('alias', 'alias') class-attribute

Alias for this partition.

CHILD_TABLE_PARTITIONS: RelationField = RelationField('childTablePartitions') class-attribute

TBC

COLUMNS: RelationField = RelationField('columns') class-attribute

TBC

COLUMN_COUNT: NumericField = NumericField('columnCount', 'columnCount') class-attribute

Number of columns in this partition.

CONSTRAINT: TextField = TextField('constraint', 'constraint') class-attribute

Constraint that defines this table partition.

EXTERNAL_LOCATION: TextField = TextField('externalLocation', 'externalLocation') class-attribute

External location of this partition, for example: an S3 object location.

EXTERNAL_LOCATION_FORMAT: KeywordField = KeywordField('externalLocationFormat', 'externalLocationFormat') class-attribute

Format of the external location of this partition, for example: JSON, CSV, PARQUET, etc.

EXTERNAL_LOCATION_REGION: TextField = TextField('externalLocationRegion', 'externalLocationRegion') class-attribute

Region of the external location of this partition, for example: S3 region.

IS_PARTITIONED: BooleanField = BooleanField('isPartitioned', 'isPartitioned') class-attribute

Whether this partition is further partitioned (true) or not (false).

IS_QUERY_PREVIEW: BooleanField = BooleanField('isQueryPreview', 'isQueryPreview') class-attribute

Whether preview queries for this partition are allowed (true) or not (false).

IS_TEMPORARY: BooleanField = BooleanField('isTemporary', 'isTemporary') class-attribute

Whether this partition is temporary (true) or not (false).

PARENT_TABLE: RelationField = RelationField('parentTable') class-attribute

TBC

PARENT_TABLE_PARTITION: RelationField = RelationField('parentTablePartition') class-attribute

TBC

PARTITION_COUNT: NumericField = NumericField('partitionCount', 'partitionCount') class-attribute

Number of sub-partitions of this partition.

PARTITION_LIST: TextField = TextField('partitionList', 'partitionList') class-attribute

List of sub-partitions in this partition.

PARTITION_STRATEGY: KeywordField = KeywordField('partitionStrategy', 'partitionStrategy') class-attribute

Partition strategy of this partition.

QUERY_PREVIEW_CONFIG: KeywordField = KeywordField('queryPreviewConfig', 'queryPreviewConfig') class-attribute

Configuration for the preview queries.

ROW_COUNT: NumericField = NumericField('rowCount', 'rowCount') class-attribute

Number of rows in this partition.

SIZE_BYTES: NumericField = NumericField('sizeBytes', 'sizeBytes') class-attribute

Size of this partition, in bytes.

Classes

Attributes

Bases: Attributes

Functions
creator(*, name: str, connection_qualified_name: Optional[str] = None, database_name: Optional[str] = None, database_qualified_name: Optional[str] = None, schema_name: Optional[str] = None, schema_qualified_name: Optional[str] = None, table_name: Optional[str] = None, table_qualified_name: str) -> TablePartition.Attributes classmethod

Builds the minimal object necessary to create a table partition.

:param name: name of the TablePartition :param connection_qualified_name: unique name of the connection in which to create the TablePartition :param database_name: simple name of the Database in which to create the TablePartition :param database_qualified_name: unique name of the Database in which to create the TablePartition :param schema_name: simple name of the Schema in which to create the TablePartition :param schema_qualified_name: unique name of the Schema in which to create the TablePartition :param table_name: simple name of the Table in which to create the TablePartition :param table_qualified_name: unique name of the table in which this table partition exists :returns: the minimal request necessary to create the table partition

Source code in pyatlan/model/assets/core/table_partition.py 
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
@classmethod
@init_guid
def creator(
    cls,
    *,
    name: str,
    connection_qualified_name: Optional[str] = None,
    database_name: Optional[str] = None,
    database_qualified_name: Optional[str] = None,
    schema_name: Optional[str] = None,
    schema_qualified_name: Optional[str] = None,
    table_name: Optional[str] = None,
    table_qualified_name: str,
) -> TablePartition.Attributes:
    """
    Builds the minimal object necessary to create a table partition.

    :param name: name of the TablePartition
    :param connection_qualified_name: unique name of the connection in which to create the TablePartition
    :param database_name: simple name of the Database in which to create the TablePartition
    :param database_qualified_name: unique name of the Database in which to create the TablePartition
    :param schema_name: simple name of the Schema in which to create the TablePartition
    :param schema_qualified_name: unique name of the Schema in which to create the TablePartition
    :param table_name: simple name of the Table in which to create the TablePartition
    :param table_qualified_name: unique name of the table in which this table partition exists
    :returns: the minimal request necessary to create the table partition
    """
    validate_required_fields(
        ["name", "table_qualified_name"],
        [name, table_qualified_name],
    )
    assert table_qualified_name  # noqa: S101
    if connection_qualified_name:
        connector_name = AtlanConnectorType.get_connector_name(
            connection_qualified_name
        )
    else:
        connection_qn, connector_name = AtlanConnectorType.get_connector_name(
            table_qualified_name, "table_qualified_name", 6
        )

    fields = table_qualified_name.split("/")

    connection_qualified_name = connection_qualified_name or connection_qn
    database_name = database_name or fields[3]
    schema_name = schema_name or fields[4]
    table_name = table_name or fields[5]
    database_qualified_name = (
        database_qualified_name
        or f"{connection_qualified_name}/{database_name}"
    )
    schema_qualified_name = (
        schema_qualified_name or f"{database_qualified_name}/{schema_name}"
    )

    qualified_name = f"{schema_qualified_name}/{name}"

    return TablePartition.Attributes(
        name=name,
        qualified_name=qualified_name,
        database_name=database_name,
        database_qualified_name=database_qualified_name,
        schema_name=schema_name,
        schema_qualified_name=schema_qualified_name,
        connector_name=connector_name,
        connection_qualified_name=connection_qualified_name,
        table_name=table_name,
        table_qualified_name=table_qualified_name,
    )

Functions

creator(*, name: str, connection_qualified_name: Optional[str] = None, database_name: Optional[str] = None, database_qualified_name: Optional[str] = None, schema_name: Optional[str] = None, schema_qualified_name: Optional[str] = None, table_name: Optional[str] = None, table_qualified_name: str) -> TablePartition classmethod 

creator(
    *, name: str, table_qualified_name: str
) -> TablePartition

creator(
    *,
    name: str,
    connection_qualified_name: str,
    database_name: str,
    database_qualified_name: str,
    schema_name: str,
    schema_qualified_name: str,
    table_name: str,
    table_qualified_name: str,
) -> TablePartition

Builds the minimal object necessary to create a table partition.

:param name: name of the TablePartition :param connection_qualified_name: unique name of the connection in which to create the TablePartition :param database_name: simple name of the Database in which to create the TablePartition :param database_qualified_name: unique name of the Database in which to create the TablePartition :param schema_name: simple name of the Schema in which to create the TablePartition :param schema_qualified_name: unique name of the Schema in which to create the TablePartition :param table_name: simple name of the Table in which to create the TablePartition :param table_qualified_name: unique name of the table in which this table partition exists :returns: the minimal request necessary to create the table partition

Source code in pyatlan/model/assets/core/table_partition.py 
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
@classmethod
@init_guid
def creator(
    cls,
    *,
    name: str,
    connection_qualified_name: Optional[str] = None,
    database_name: Optional[str] = None,
    database_qualified_name: Optional[str] = None,
    schema_name: Optional[str] = None,
    schema_qualified_name: Optional[str] = None,
    table_name: Optional[str] = None,
    table_qualified_name: str,
) -> TablePartition:
    """
    Builds the minimal object necessary to create a table partition.

    :param name: name of the TablePartition
    :param connection_qualified_name: unique name of the connection in which to create the TablePartition
    :param database_name: simple name of the Database in which to create the TablePartition
    :param database_qualified_name: unique name of the Database in which to create the TablePartition
    :param schema_name: simple name of the Schema in which to create the TablePartition
    :param schema_qualified_name: unique name of the Schema in which to create the TablePartition
    :param table_name: simple name of the Table in which to create the TablePartition
    :param table_qualified_name: unique name of the table in which this table partition exists
    :returns: the minimal request necessary to create the table partition
    """
    attributes = TablePartition.Attributes.creator(
        name=name,
        connection_qualified_name=connection_qualified_name,
        database_name=database_name,
        database_qualified_name=database_qualified_name,
        schema_name=schema_name,
        schema_qualified_name=schema_qualified_name,
        table_name=table_name,
        table_qualified_name=table_qualified_name,
    )
    return cls(attributes=attributes)

View

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

Bases: SQL

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

ALIAS: TextField = TextField('alias', 'alias') class-attribute

Alias for this view.

ATLAN_SCHEMA: RelationField = RelationField('atlanSchema') class-attribute

TBC

COLUMNS: RelationField = RelationField('columns') class-attribute

TBC

COLUMN_COUNT: NumericField = NumericField('columnCount', 'columnCount') class-attribute

Number of columns in this view.

DEFINITION: TextField = TextField('definition', 'definition') class-attribute

SQL definition of this view.

IS_QUERY_PREVIEW: BooleanField = BooleanField('isQueryPreview', 'isQueryPreview') class-attribute

Whether preview queries are allowed on this view (true) or not (false).

IS_TEMPORARY: BooleanField = BooleanField('isTemporary', 'isTemporary') class-attribute

Whether this view is temporary (true) or not (false).

QUERIES: RelationField = RelationField('queries') class-attribute

TBC

QUERY_PREVIEW_CONFIG: KeywordField = KeywordField('queryPreviewConfig', 'queryPreviewConfig') class-attribute

Configuration for preview queries on this view.

ROW_COUNT: NumericField = NumericField('rowCount', 'rowCount') class-attribute

Number of rows in this view.

SIZE_BYTES: NumericField = NumericField('sizeBytes', 'sizeBytes') class-attribute

Size of this view, in bytes.