Column¶

class pyatlan.model.assets.Column(*, typeName: str = 'Column', attributes: Column.Attributes = None, businessAttributes: Dict[str, Any] | None = None, createdBy: str | None = None, createTime: int | None = None, deleteHandler: str | None = None, guid: str = None, isIncomplete: bool | None = None, labels: List[str] | None = None, relationshipAttributes: RelationshipAttributes | Dict[str, Any] | None = None, status: EntityStatus | None = None, updatedBy: str | None = None, updateTime: int | None = None, version: int | None = None, classifications: List[AtlanTag] | None = None, classificationNames: List[str] | None = None, displayText: str | None = None, entityStatus: str | None = None, relationshipGuid: str | None = None, relationshipStatus: str | None = None, relationshipType: str | None = None, meaningNames: List[str] | None = None, meanings: List[Meaning] | None = None, customAttributes: Dict[str, Any] | None = None, scrubbed: bool | None = None, pendingTasks: List[str] | None = None, uniqueAttributes: Dict[str, Any] | None = None, appendRelationshipAttributes: Dict[str, Any] | None = None, removeRelationshipAttributes: Dict[str, Any] | None = None, addOrUpdateClassifications: List[AtlanTag] | None = None, removeClassifications: List[AtlanTag] | None = None, semantic: SaveSemantic | None = None, depth: int | None = None, immediateUpstream: List[LineageRef] | None = None, immediateDownstream: List[LineageRef] | None = None)[source]¶

Description

CALCULATION_VIEW: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

COLUMN_AVERAGE: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Average value in this column.

COLUMN_AVERAGE_LENGTH: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Average length of values in a string column.

COLUMN_COMPRESSION: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶: Compression type of this column.

COLUMN_DBT_MODEL_COLUMNS: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

COLUMN_DEPTH_LEVEL: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Level of nesting of this column, used for STRUCT and NESTED columns.

COLUMN_DISTINCT_VALUES_COUNT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Number of rows that contain distinct values.

COLUMN_DISTINCT_VALUES_COUNT_LONG: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Number of rows that contain distinct values.

COLUMN_DUPLICATE_VALUES_COUNT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Number of rows that contain duplicate values.

COLUMN_DUPLICATE_VALUES_COUNT_LONG: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Number of rows that contain duplicate values.

COLUMN_ENCODING: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶: Encoding type of this column.

COLUMN_HIERARCHY: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶: List of top-level upstream nested columns.

COLUMN_HISTOGRAM: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶: List of values in a histogram that represents the contents of this column.

COLUMN_IS_MEASURE: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶: When true, this column is of type measure/calculated.

COLUMN_MAX: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Greatest value in a numeric column.

COLUMN_MAXIMUM_STRING_LENGTH: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Length of the longest value in a string column.

COLUMN_MAXS: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>¶: List of the greatest values in a column.

COLUMN_MEAN: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Arithmetic mean of the values in a numeric column.

COLUMN_MEASURE_TYPE: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶: The type of measure/calculated column this is, eg: base, calculated, derived.

COLUMN_MEDIAN: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Calculated median of the values in a numeric column.

COLUMN_MIN: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Least value in a numeric column.

COLUMN_MINIMUM_STRING_LENGTH: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Length of the shortest value in a string column.

COLUMN_MINS: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>¶: List of the least values in a column.

COLUMN_MISSING_VALUES_COUNT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Number of rows in a column that do not contain content.

COLUMN_MISSING_VALUES_COUNT_LONG: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Number of rows in a column that do not contain content.

COLUMN_MISSING_VALUES_PERCENTAGE: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Percentage of rows in a column that do not contain content.

COLUMN_STANDARD_DEVIATION: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Calculated standard deviation of the values in a numeric column.

COLUMN_SUM: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Calculated sum of the values in a numeric column.

COLUMN_TOP_VALUES: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶: List of top values in this column.

COLUMN_UNIQUENESS_PERCENTAGE: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: 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: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Number of rows in which a value in this column appears only once.

COLUMN_UNIQUE_VALUES_COUNT_LONG: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Number of rows in which a value in this column appears only once.

COLUMN_VARIANCE: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Calculated variance of the values in a numeric column.

COSMOS_MONGO_DB_COLLECTION: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

DATA_QUALITY_METRIC_DIMENSIONS: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

DATA_TYPE: ClassVar[KeywordTextField] = <pyatlan.model.fields.atlan_fields.KeywordTextField object>¶: Data type of values in this column.

DBT_METRICS: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

DBT_MODEL_COLUMNS: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

DEFAULT_VALUE: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>¶: Default value for this column.

FOREIGN_KEY_FROM: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

FOREIGN_KEY_TO: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

IS_CLUSTERED: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶: Whether this column is a clustered column (true) or not (false).

IS_DIST: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶: Whether this column is a distribution column (true) or not (false).

IS_FOREIGN: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶: 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: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶: When true, this column is indexed in the database.

IS_NULLABLE: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶: When true, the values in this column can be null.

IS_PARTITION: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶: Whether this column is a partition column (true) or not (false).

IS_PINNED: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶: Whether this column is pinned (true) or not (false).

IS_PRIMARY: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶: When true, this column is the primary key for the table.

IS_SORT: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶: Whether this column is a sort column (true) or not (false).

MATERIALISED_VIEW: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

MAX_LENGTH: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Maximum length of a value in this column.

METRIC_TIMESTAMPS: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

NESTED_COLUMNS: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

NESTED_COLUMN_COUNT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Number of columns nested within this (STRUCT or NESTED) column.

NESTED_COLUMN_ORDER: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶: Order (position) in which this column appears in the nested Column (nest level starts at 1).

NOSQL_COLLECTION_NAME: ClassVar[KeywordTextField] = <pyatlan.model.fields.atlan_fields.KeywordTextField object>¶: 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: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶: 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: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Number of digits allowed to the right of the decimal point.

ORDER: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Order (position) in which this column appears in the table (starting at 1).

PARENT_COLUMN: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

PARENT_COLUMN_NAME: ClassVar[KeywordTextField] = <pyatlan.model.fields.atlan_fields.KeywordTextField object>¶: Simple name of the column this column is nested within, for STRUCT and NESTED columns.

PARENT_COLUMN_QUALIFIED_NAME: ClassVar[KeywordTextField] = <pyatlan.model.fields.atlan_fields.KeywordTextField object>¶: Unique name of the column this column is nested within, for STRUCT and NESTED columns.

PARTITION_ORDER: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Order (position) of this partition column in the table.

PINNED_AT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Time (epoch) at which this column was pinned, in milliseconds.

PINNED_BY: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶: User who pinned this column.

PRECISION: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶: Total number of digits allowed, when the dataType is numeric.

QUERIES: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

RAW_DATA_TYPE_DEFINITION: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>¶: Raw data type definition of this column.

SNOWFLAKE_DYNAMIC_TABLE: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

SUB_DATA_TYPE: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶: Sub-data type of this column.

TABLE: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

TABLE_PARTITION: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

VALIDATIONS: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶: Validations for this column.

VIEW: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶: TBC

classmethod creator(*, name: str, parent_qualified_name: str, parent_type: type, order: int) → Column[source]¶

classmethod 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.

Parameters:

name – name of the Column
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