Column¶

Instance of a column in Atlan.

Complete reference

This is a complete reference for the Column object in Atlan, showing every possible property and relationship that can exist for these objects. For an introduction, you probably want to start with:

Snippets — small, atomic examples of single-step use cases.
Patterns — walkthroughs of common multi-step implementation patterns.

Column inherits its attributes and relationships from these other types:

classDiagram
    direction RL
    class Column
    link Column "../column"
    class SQL {
        <<abstract>>
    }
    link SQL "../sql"
    SQL <|-- Column : extends
    class Catalog {
        <<abstract>>
    }
    link Catalog "../catalog"
    Catalog <|-- SQL : extends
    class Asset {
        <<abstract>>
    }
    link Asset "../asset"
    Asset <|-- Catalog : extends
    class Referenceable {
        <<abstract>>
    }
    link Referenceable "../referenceable"
    Referenceable <|-- Asset : extends

Properties¶

Inherited properties

These attributes are inherited from Column's supertypes (shown above):

typeName ¶

Type of this asset.

guid ¶

Globally-unique identifier for this asset.

classifications ¶

Tags assigned to the asset. (1)

Uses a different name in SDKs

atlanTags
atlan_tags

For more information, see the tag assets snippets.

businessAttributes ¶

Map of custom metadata attributes and values defined on the asset. (1)

Uses a different name in SDKs

customMetadataSets
custom_metadata

For more information, see the change custom metadata snippets.

status ¶

Status of the asset. (1)

Treat as read-only

You should not try to set status on an asset. Instead, see the asset CRUD snippets on deleting and restoring assets.

createdBy ¶

User or account that created the asset.

updatedBy ¶

User or account that last updated the asset.

createTime ¶

Time (epoch) at which the asset was created, in milliseconds.

updateTime ¶

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

deleteHandler ¶

Details on the handler used for deletion of the asset. (1)

Treat as read-only

You should not try to set deleteHandler on an asset. Instead, see the asset CRUD snippets on deleting assets.

classificationNames ¶

Hashed-string names of the Atlan tags that exist on the asset. (1)

Uses a different name in SDKs

atlanTagNames
atlan_tag_names

Use classifications to make changes to tags.

isIncomplete ¶

Unused.

meaningNames ¶

Human-readable names of terms that have been linked to this asset.

meanings ¶

Details of terms that have been linked to this asset. (1)

Do not use

These should not be used, as they can be inconsistent. Instead, see the link terms and assets snippets.

pendingTasks ¶

Unique identifiers (GUIDs) for any background tasks that are yet to operate on this asset.

adminGroups ¶

List of groups who administer this asset. (This is only used for certain asset types.)

adminRoles ¶

List of roles who administer this asset. (This is only used for Connection assets.)

adminUsers ¶

List of users who administer this asset. (This is only used for certain asset types.)

announcementMessage ¶

Detailed message to include in the announcement on this asset.

announcementTitle ¶

Brief title for the announcement on this asset. Required when announcementType is specified.

announcementType ¶

Type of announcement on this asset.

announcementUpdatedAt ¶

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

announcementUpdatedBy ¶

Name of the user who last updated the announcement.

applicationQualifiedName ¶

Qualified name of the Application that contains this asset.

assetAnomaloAppliedCheckTypes ¶

All associated Anomalo check types.

assetAnomaloCheckCount ¶

Total number of checks present in Anomalo for this asset.

assetAnomaloCheckStatuses ¶

Stringified JSON object containing status of all Anomalo checks associated to this asset.

assetAnomaloDQStatus ¶

Status of data quality from Anomalo.

assetAnomaloFailedCheckCount ¶

Total number of checks failed in Anomalo for this asset.

assetAnomaloFailedCheckTypes ¶

All associated Anomalo failed check types.

assetAnomaloLastCheckRunAt ¶

Time (epoch) at which the last check was run via Anomalo.

assetAnomaloSourceUrl ¶

URL of the source in Anomalo.

assetCoverImage ¶

TBC

assetDbtAccountName ¶

Name of the account in which this asset exists in dbt.

assetDbtAlias ¶

Alias of this asset in dbt.

assetDbtEnvironmentDbtVersion ¶

Version of the environment in which this asset is materialized in dbt.

assetDbtEnvironmentName ¶

Name of the environment in which this asset is materialized in dbt.

assetDbtJobLastRun ¶

Time (epoch) at which the job that materialized this asset in dbt last ran, in milliseconds.

assetDbtJobLastRunArtifactS3Path ¶

Path in S3 to the artifacts saved from the last run of the job that materialized this asset in dbt.

assetDbtJobLastRunArtifactsSaved ¶

Whether artifacts were saved from the last run of the job that materialized this asset in dbt (true) or not (false).

assetDbtJobLastRunCreatedAt ¶

Time (epoch) at which the job that materialized this asset in dbt was last created, in milliseconds.

assetDbtJobLastRunDequedAt ¶

Time (epoch) at which the job that materialized this asset in dbt was dequeued, in milliseconds.

assetDbtJobLastRunExecutedByThreadId ¶

Thread ID of the user who executed the last run of the job that materialized this asset in dbt.

assetDbtJobLastRunGitBranch ¶

Branch in git from which the last run of the job that materialized this asset in dbt ran.

assetDbtJobLastRunGitSha ¶

SHA hash in git for the last run of the job that materialized this asset in dbt.

assetDbtJobLastRunHasDocsGenerated ¶

Whether docs were generated from the last run of the job that materialized this asset in dbt (true) or not (false).

assetDbtJobLastRunHasSourcesGenerated ¶

Whether sources were generated from the last run of the job that materialized this asset in dbt (true) or not (false).

assetDbtJobLastRunNotificationsSent ¶

Whether notifications were sent from the last run of the job that materialized this asset in dbt (true) or not (false).

assetDbtJobLastRunOwnerThreadId ¶

Thread ID of the owner of the last run of the job that materialized this asset in dbt.

assetDbtJobLastRunQueuedDuration ¶

Total duration the job that materialized this asset in dbt spent being queued.

assetDbtJobLastRunQueuedDurationHumanized ¶

Human-readable total duration of the last run of the job that materialized this asset in dbt spend being queued.

assetDbtJobLastRunRunDuration ¶

Run duration of the last run of the job that materialized this asset in dbt.

assetDbtJobLastRunRunDurationHumanized ¶

Human-readable run duration of the last run of the job that materialized this asset in dbt.

assetDbtJobLastRunStartedAt ¶

Time (epoch) at which the job that materialized this asset in dbt was started running, in milliseconds.

assetDbtJobLastRunStatusMessage ¶

Status message of the last run of the job that materialized this asset in dbt.

assetDbtJobLastRunTotalDuration ¶

Total duration of the last run of the job that materialized this asset in dbt.

assetDbtJobLastRunTotalDurationHumanized ¶

Human-readable total duration of the last run of the job that materialized this asset in dbt.

assetDbtJobLastRunUpdatedAt ¶

Time (epoch) at which the job that materialized this asset in dbt was last updated, in milliseconds.

assetDbtJobLastRunUrl ¶

URL of the last run of the job that materialized this asset in dbt.

assetDbtJobName ¶

Name of the job that materialized this asset in dbt.

assetDbtJobNextRun ¶

Time (epoch) when the next run of the job that materializes this asset in dbt is scheduled.

assetDbtJobNextRunHumanized ¶

Human-readable time when the next run of the job that materializes this asset in dbt is scheduled.

assetDbtJobSchedule ¶

Schedule of the job that materialized this asset in dbt.

assetDbtJobScheduleCronHumanized ¶

Human-readable cron schedule of the job that materialized this asset in dbt.

assetDbtJobStatus ¶

Status of the job that materialized this asset in dbt.

assetDbtMeta ¶

Metadata for this asset in dbt, specifically everything under the 'meta' key in the dbt object.

assetDbtPackageName ¶

Name of the package in which this asset exists in dbt.

assetDbtProjectName ¶

Name of the project in which this asset exists in dbt.

assetDbtSemanticLayerProxyUrl ¶

URL of the semantic layer proxy for this asset in dbt.

assetDbtSourceFreshnessCriteria ¶

Freshness criteria for the source of this asset in dbt.

assetDbtTags ¶

List of tags attached to this asset in dbt.

assetDbtTestStatus ¶

All associated dbt test statuses.

assetDbtUniqueId ¶

Unique identifier of this asset in dbt.

assetDbtWorkflowLastUpdated ¶

Name of the DBT workflow in Atlan that last updated the asset.

assetIcon ¶

Name of the icon to use for this asset. (Only applies to glossaries, currently.)

assetMcAlertQualifiedNames ¶

List of unique Monte Carlo alert names attached to this asset.

assetMcIncidentNames ¶

List of Monte Carlo incident names attached to this asset.

assetMcIncidentPriorities ¶

List of Monte Carlo incident priorities associated with this asset.

assetMcIncidentQualifiedNames ¶

List of unique Monte Carlo incident names attached to this asset.

assetMcIncidentSeverities ¶

List of Monte Carlo incident severities associated with this asset.

assetMcIncidentStates ¶

List of Monte Carlo incident states associated with this asset.

assetMcIncidentSubTypes ¶

List of Monte Carlo incident sub-types associated with this asset.

assetMcIncidentTypes ¶

List of Monte Carlo incident types associated with this asset.

assetMcIsMonitored ¶

Tracks whether this asset is monitored by MC or not

assetMcLastSyncRunAt ¶

Time (epoch) at which this asset was last synced from Monte Carlo.

assetMcMonitorNames ¶

List of Monte Carlo monitor names attached to this asset.

assetMcMonitorQualifiedNames ¶

List of unique Monte Carlo monitor names attached to this asset.

assetMcMonitorScheduleTypes ¶

Schedules of all associated Monte Carlo monitors.

assetMcMonitorStatuses ¶

Statuses of all associated Monte Carlo monitors.

assetMcMonitorTypes ¶

Types of all associated Monte Carlo monitors.

assetPoliciesCount ¶

Count of policies inside the asset

assetPolicyGUIDs ¶

Array of policy ids governing this asset

assetSodaCheckCount ¶

Number of checks done via Soda.

assetSodaCheckStatuses ¶

All associated Soda check statuses.

assetSodaDQStatus ¶

Status of data quality from Soda.

assetSodaLastScanAt ¶

TBC

assetSodaLastSyncRunAt ¶

TBC

assetSodaSourceURL ¶

TBC

assetTags ¶

List of tags attached to this asset.

assetThemeHex ¶

Color (in hexadecimal RGB) to use to represent this asset.

certificateStatus ¶

Status of this asset's certification.

certificateStatusMessage ¶

Human-readable descriptive message used to provide further detail to certificateStatus.

certificateUpdatedAt ¶

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

certificateUpdatedBy ¶

Name of the user who last updated the certification of this asset.

connectionName ¶

Simple name of the connection through which this asset is accessible.

connectionQualifiedName ¶

Unique name of the connection through which this asset is accessible.

connectorName ¶

Type of the connector through which this asset is accessible. (1)

Uses a different name in SDKs

connectorType
connector_type

dbtQualifiedName ¶

Unique name of this asset in dbt.

description ¶

Description of this asset, for example as crawled from a source. Fallback for display purposes, if userDescription is empty.

displayName ¶

Human-readable name of this asset used for display purposes (in user interface).

domainGUIDs ¶

Array of domain guids linked to this asset

hasContract ¶

Whether this asset has contract (true) or not (false).

__hasLineage ¶

Whether this asset has lineage (true) or not (false). (1)

Uses a different name in SDKs

hasLineage
has_lineage

isAIGenerated ¶

TBC

isDiscoverable ¶

Whether this asset is discoverable through the UI (true) or not (false).

isEditable ¶

Whether this asset can be edited in the UI (true) or not (false).

isPartial ¶

TBC

lastRowChangedAt ¶

Time (epoch) of the last operation that inserted, updated, or deleted rows, in milliseconds.

lastSyncRun ¶

Name of the last run of the crawler that last synchronized this asset.

lastSyncRunAt ¶

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

lastSyncWorkflowName ¶

Name of the crawler that last synchronized this asset.

lexicographicalSortOrder ¶

Custom order for sorting purpose, managed by client

name ¶

Name of this asset. Fallback for display purposes, if displayName is empty.

nonCompliantAssetPolicyGUIDs ¶

Array of policy ids non-compliant to this asset

ownerGroups ¶

List of groups who own this asset.

ownerUsers ¶

List of users who own this asset.

popularityScore ¶

Popularity score for this asset.

sampleDataUrl ¶

URL for sample data for this asset.

sourceCostUnit ¶

The unit of measure for sourceTotalCost.

sourceCreatedAt ¶

Time (epoch) at which this asset was created in the source system, in milliseconds.

sourceCreatedBy ¶

Name of the user who created this asset, in the source system.

sourceEmbedURL ¶

URL to create an embed for a resource (for example, an image of a dashboard) within Atlan.

sourceLastReadAt ¶

Timestamp of most recent read operation.

sourceOwners ¶

List of owners of this asset, in the source system.

sourceQueryComputeCostRecordList ¶

List of most expensive warehouses with extra insights. (1)

Uses a different name in SDKs

sourceQueryComputeCostRecords
source_query_compute_cost_records

sourceQueryComputeCostList ¶

List of most expensive warehouse names. (1)

Uses a different name in SDKs

sourceQueryComputeCosts
source_query_compute_costs

sourceReadCount ¶

Total count of all read operations at source.

sourceReadExpensiveQueryRecordList ¶

List of the most expensive queries that accessed this asset. (1)

Uses a different name in SDKs

sourceReadExpensiveQueryRecords
source_read_expensive_query_records

sourceReadPopularQueryRecordList ¶

List of the most popular queries that accessed this asset. (1)

Uses a different name in SDKs

sourceReadPopularQueryRecords
source_read_popular_query_records

sourceReadQueryCost ¶

Total cost of read queries at source.

sourceReadRecentUserRecordList ¶

List of usernames with extra insights for the most recent users who read this asset. (1)

Uses a different name in SDKs

sourceReadRecentUserRecords
source_read_recent_user_records

sourceReadRecentUserList ¶

List of usernames of the most recent users who read this asset. (1)

Uses a different name in SDKs

sourceReadRecentUsers
source_read_recent_users

sourceReadSlowQueryRecordList ¶

List of the slowest queries that accessed this asset. (1)

Uses a different name in SDKs

sourceReadSlowQueryRecords
source_read_slow_query_records

sourceReadTopUserRecordList ¶

List of usernames with extra insights for the users who read this asset the most. (1)

Uses a different name in SDKs

sourceReadTopUserRecords
source_read_top_user_records

sourceReadTopUserList ¶

List of usernames of the users who read this asset the most. (1)

Uses a different name in SDKs

sourceReadTopUsers
source_read_top_users

sourceReadUserCount ¶

Total number of unique users that read data from asset.

sourceTotalCost ¶

Total cost of all operations at source.

sourceURL ¶

URL to the resource within the source application, used to create a button to view this asset in the source application.

sourceUpdatedAt ¶

Time (epoch) at which this asset was last updated in the source system, in milliseconds.

sourceUpdatedBy ¶

Name of the user who last updated this asset, in the source system.

starredBy ¶

Users who have starred this asset.

starredCount ¶

Number of users who have starred this asset.

starredDetailsList ¶

List of usernames with extra information of the users who have starred an asset. (1)

Uses a different name in SDKs

starredDetails
starred_details

subType ¶

Subtype of this asset.

tenantId ¶

Name of the Atlan workspace in which this asset exists.

userDescription ¶

Description of this asset, as provided by a user. If present, this will be used for the description in user interface.

viewScore ¶

View score for this asset.

viewerGroups ¶

List of groups who can view assets contained in a collection. (This is only used for certain asset types.)

viewerUsers ¶

List of users who can view assets contained in a collection. (This is only used for certain asset types.)

calculationViewName ¶

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

calculationViewQualifiedName ¶

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

databaseName ¶

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

databaseQualifiedName ¶

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

isProfiled ¶

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

lastProfiledAt ¶

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

queryCount ¶

Number of times this asset has been queried.

queryCountUpdatedAt ¶

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

queryUserCount ¶

Number of unique users who have queried this asset.

queryUserMap ¶

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

schemaName ¶

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

schemaQualifiedName ¶

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

tableName ¶

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

tableQualifiedName ¶

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

viewName ¶

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

viewQualifiedName ¶

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

These attributes are specific to instances of Column (and all of its subtypes).

columnAverage ¶

Average value in this column.

columnAverageLength ¶

Average length of values in a string column.

columnDepthLevel ¶

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

columnDistinctValuesCount ¶

Number of rows that contain distinct values.

columnDistinctValuesCountLong ¶

Number of rows that contain distinct values.

columnDuplicateValuesCount ¶

Number of rows that contain duplicate values.

columnDuplicateValuesCountLong ¶

Number of rows that contain duplicate values.

columnHierarchy ¶

List of top-level upstream nested columns.

columnHistogram ¶

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

columnMax ¶

Greatest value in a numeric column.

columnMaximumStringLength ¶

Length of the longest value in a string column.

columnMaxs ¶

List of the greatest values in a column.

columnMean ¶

Arithmetic mean of the values in a numeric column.

columnMedian ¶

Calculated median of the values in a numeric column.

columnMin ¶

Least value in a numeric column.

columnMinimumStringLength ¶

Length of the shortest value in a string column.

columnMins ¶

List of the least values in a column.

columnMissingValuesCount ¶

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

columnMissingValuesCountLong ¶

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

columnMissingValuesPercentage ¶

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

columnStandardDeviation ¶

Calculated standard deviation of the values in a numeric column.

columnSum ¶

Calculated sum of the values in a numeric column.

columnTopValues ¶

List of top values in this column.

columnUniqueValuesCount ¶

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

columnUniqueValuesCountLong ¶

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

columnUniquenessPercentage ¶

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.

columnVariance ¶

Calculated variance of the values in a numeric column.

dataType ¶

Data type of values in this column.

defaultValue ¶

Default value for this column.

isClustered ¶

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

isDist ¶

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

isForeign ¶

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.

isIndexed ¶

When true, this column is indexed in the database.

isNullable ¶

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

isPartition ¶

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

isPinned ¶

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

isPrimary ¶

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

isSort ¶

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

maxLength ¶

Maximum length of a value in this column.

nestedColumnCount ¶

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

nestedColumnOrder ¶

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

nosqlCollectionName ¶

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.

nosqlCollectionQualifiedName ¶

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.

numericScale ¶

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

order ¶

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

parentColumnName ¶

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

parentColumnQualifiedName ¶

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

partitionOrder ¶

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

pinnedAt ¶

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

pinnedBy ¶

User who pinned this column.

precision ¶

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

rawDataTypeDefinition ¶

TBC

subDataType ¶

Sub-data type of this column.

validations ¶

Validations for this column.

Relationships¶

Inherited relationships

These relationships are inherited from Column's supertypes:

anomaloChecks (AnomaloCheck)¶

Checks that run on this asset.

application (Application)¶

Application asset containing this Asset.

meanings (AtlasGlossaryTerm)¶

Glossary terms that are linked to this asset. (1)

Uses a different name in SDKs

assignedTerms
assigned_terms

dataContractLatest (DataContract)¶

Latest version of the data contract (in any status) for this asset.

dataContractLatestCertified (DataContract)¶

Latest certified version of the data contract for this asset.

files (File)¶

TBC

inputPortDataProducts (DataProduct)¶

Data products for which this asset is an input port.

links (Link)¶

Links that are attached to this asset.

mcIncidents (MCIncident)¶

TBC

mcMonitors (MCMonitor)¶

Monitors that observe this asset.

metrics (Metric)¶

TBC

outputPortDataProducts (DataProduct)¶

Data products for which this asset is an output port.

readme (Readme)¶

README that is linked to this asset.

schemaRegistrySubjects (SchemaRegistrySubject)¶

TBC

sodaChecks (SodaCheck)¶

TBC

userDefRelationshipFrom (Referenceable)¶

TBC (1)

Uses a different name in SDKs

userDefRelationshipFroms
user_def_relationship_froms

userDefRelationshipTo (Referenceable)¶

TBC (1)

Uses a different name in SDKs

userDefRelationshipTos
user_def_relationship_tos

inputToAirflowTasks (AirflowTask)¶

Tasks to which this asset provides input.

inputToProcesses (Process)¶

Processes to which this asset provides input.

inputToSparkJobs (SparkJob)¶

TBC

modelImplementedAttributes (ModelAttribute)¶

Attributes implemented by this asset.

modelImplementedEntities (ModelEntity)¶

Entities implemented by this asset.

outputFromAirflowTasks (AirflowTask)¶

Tasks from which this asset is output.

outputFromProcesses (Process)¶

Processes from which this asset is produced as output.

outputFromSparkJobs (SparkJob)¶

TBC

dbtModels (DbtModel)¶

TBC

dbtSources (DbtSource)¶

TBC

dbtTests (DbtTest)¶

TBC

sqlDBTSources (DbtSource)¶

TBC

sqlDbtModels (DbtModel)¶

TBC

These relationships are specific to instances of Column (and all of its subtypes).

calculationView (CalculationView)¶

Calculate view in which this column exists.

columnDbtModelColumns (DbtModelColumn)¶

TBC

cosmosMongoDBCollection (CosmosMongoDBCollection)¶

Cosmos collection in which this column exists.

dataQualityMetricDimensions (Metric)¶

TBC

dbtMetrics (DbtMetric)¶

TBC

dbtModelColumns (DbtModelColumn)¶

TBC

foreignKeyFrom (Column)¶

Column this foreign key column refers to.

foreignKeyTo (Column)¶

Columns that use this column as a foreign key.

materialisedView (MaterialisedView)¶

Materialized view in which this column exists. (1)

Uses a different name in SDKs

materializedView
materialized_view

metricTimestamps (Metric)¶

TBC

nestedColumns (Column)¶

Nested columns that exist within this column.

parentColumn (Column)¶

Column in which this sub-column is nested.

queries (Query)¶

Queries that access this column.

snowflakeDynamicTable (SnowflakeDynamicTable)¶

Snowflake dynamic table in which this column exists.

table (Table)¶

Table in which this column exists.

tablePartition (TablePartition)¶

Table partition that contains this column.

view (View)¶

View in which this column exists.