Skip to content

Snowflake

SnowflakeAIModelContext

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

Bases: AIModel

Description

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

Attributes

AI_MODEL_DATASETS_DSL: TextField = TextField('aiModelDatasetsDSL', 'aiModelDatasetsDSL') class-attribute

Search DSL used to define which assets/datasets are part of the AI model.

AI_MODEL_STATUS: KeywordField = KeywordField('aiModelStatus', 'aiModelStatus') class-attribute

Status of the AI model.

AI_MODEL_VERSION: KeywordField = KeywordField('aiModelVersion', 'aiModelVersion') class-attribute

Version of the AI model.

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.

CATALOG_DATASET_GUID: KeywordField = KeywordField('catalogDatasetGuid', 'catalogDatasetGuid') class-attribute

Unique identifier of the dataset this asset belongs to.

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

ETHICAL_AI_ACCOUNTABILITY_CONFIG: KeywordField = KeywordField('ethicalAIAccountabilityConfig', 'ethicalAIAccountabilityConfig') class-attribute

Accountability configuration for ensuring the ethical use of an AI asset

ETHICAL_AI_BIAS_MITIGATION_CONFIG: KeywordField = KeywordField('ethicalAIBiasMitigationConfig', 'ethicalAIBiasMitigationConfig') class-attribute

Bias mitigation configuration for ensuring the ethical use of an AI asset

ETHICAL_AI_ENVIRONMENTAL_CONSCIOUSNESS_CONFIG: KeywordField = KeywordField('ethicalAIEnvironmentalConsciousnessConfig', 'ethicalAIEnvironmentalConsciousnessConfig') class-attribute

Environmental consciousness configuration for ensuring the ethical use of an AI asset

ETHICAL_AI_FAIRNESS_CONFIG: KeywordField = KeywordField('ethicalAIFairnessConfig', 'ethicalAIFairnessConfig') class-attribute

Fairness configuration for ensuring the ethical use of an AI asset

ETHICAL_AI_PRIVACY_CONFIG: KeywordField = KeywordField('ethicalAIPrivacyConfig', 'ethicalAIPrivacyConfig') class-attribute

Privacy configuration for ensuring the ethical use of an AI asset

ETHICAL_AI_RELIABILITY_AND_SAFETY_CONFIG: KeywordField = KeywordField('ethicalAIReliabilityAndSafetyConfig', 'ethicalAIReliabilityAndSafetyConfig') class-attribute

Reliability and safety configuration for ensuring the ethical use of an AI asset

ETHICAL_AI_TRANSPARENCY_CONFIG: KeywordField = KeywordField('ethicalAITransparencyConfig', 'ethicalAITransparencyConfig') class-attribute

Transparency configuration for ensuring the ethical use of an AI asset

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.

SNOWFLAKE_AI_MODEL_SCHEMA: RelationField = RelationField('snowflakeAIModelSchema') class-attribute

TBC

SNOWFLAKE_AI_MODEL_VERSIONS: RelationField = RelationField('snowflakeAIModelVersions') class-attribute

TBC

SNOWFLAKE_SEMANTIC_LOGICAL_TABLES: RelationField = RelationField('snowflakeSemanticLogicalTables') class-attribute

TBC

SQL_AI_INSIGHTS_LAST_ANALYZED_AT: NumericField = NumericField('sqlAiInsightsLastAnalyzedAt', 'sqlAiInsightsLastAnalyzedAt') class-attribute

Time (epoch) at which this asset was last analyzed for AI insights, in milliseconds.

Number of popular business questions associated with this asset.

Number of popular filter patterns associated with this asset.

Number of popular join patterns associated with this asset.

SQL_AI_INSIGHTS_RELATIONSHIP_COUNT: NumericField = NumericField('sqlAiInsightsRelationshipCount', 'sqlAiInsightsRelationshipCount') class-attribute

Number of relationship insights associated with this asset.

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_HAS_AI_INSIGHTS: BooleanField = BooleanField('sqlHasAiInsights', 'sqlHasAiInsights') class-attribute

Whether this asset has any AI insights data available.

SQL_INSIGHT_BUSINESS_QUESTIONS: RelationField = RelationField('sqlInsightBusinessQuestions') class-attribute

TBC

SQL_INSIGHT_INCOMING_JOINS: RelationField = RelationField('sqlInsightIncomingJoins') class-attribute

TBC

SQL_INSIGHT_OUTGOING_JOINS: RelationField = RelationField('sqlInsightOutgoingJoins') 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.

SnowflakeAIModelVersion

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

Bases: AIModelVersion

Description

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

Attributes

AI_MODEL_QUALIFIED_NAME: KeywordField = KeywordField('aiModelQualifiedName', 'aiModelQualifiedName') class-attribute

Unique name of the AI model to which this version belongs, used to navigate from a version back to its parent model.

AI_MODEL_VERSION_METRICS: KeywordField = KeywordField('aiModelVersionMetrics', 'aiModelVersionMetrics') class-attribute

Evaluation and performance metrics recorded for this AI model version, stored as key-value pairs (e.g. accuracy, F1 score, precision, recall).

AI_MODEL_VERSION_STAGE: KeywordField = KeywordField('aiModelVersionStage', 'aiModelVersionStage') class-attribute

Lifecycle deployment stage of this AI model version, indicating its readiness for production use.

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.

CATALOG_DATASET_GUID: KeywordField = KeywordField('catalogDatasetGuid', 'catalogDatasetGuid') class-attribute

Unique identifier of the dataset this asset belongs to.

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

ETHICAL_AI_ACCOUNTABILITY_CONFIG: KeywordField = KeywordField('ethicalAIAccountabilityConfig', 'ethicalAIAccountabilityConfig') class-attribute

Accountability configuration for ensuring the ethical use of an AI asset

ETHICAL_AI_BIAS_MITIGATION_CONFIG: KeywordField = KeywordField('ethicalAIBiasMitigationConfig', 'ethicalAIBiasMitigationConfig') class-attribute

Bias mitigation configuration for ensuring the ethical use of an AI asset

ETHICAL_AI_ENVIRONMENTAL_CONSCIOUSNESS_CONFIG: KeywordField = KeywordField('ethicalAIEnvironmentalConsciousnessConfig', 'ethicalAIEnvironmentalConsciousnessConfig') class-attribute

Environmental consciousness configuration for ensuring the ethical use of an AI asset

ETHICAL_AI_FAIRNESS_CONFIG: KeywordField = KeywordField('ethicalAIFairnessConfig', 'ethicalAIFairnessConfig') class-attribute

Fairness configuration for ensuring the ethical use of an AI asset

ETHICAL_AI_PRIVACY_CONFIG: KeywordField = KeywordField('ethicalAIPrivacyConfig', 'ethicalAIPrivacyConfig') class-attribute

Privacy configuration for ensuring the ethical use of an AI asset

ETHICAL_AI_RELIABILITY_AND_SAFETY_CONFIG: KeywordField = KeywordField('ethicalAIReliabilityAndSafetyConfig', 'ethicalAIReliabilityAndSafetyConfig') class-attribute

Reliability and safety configuration for ensuring the ethical use of an AI asset

ETHICAL_AI_TRANSPARENCY_CONFIG: KeywordField = KeywordField('ethicalAITransparencyConfig', 'ethicalAITransparencyConfig') class-attribute

Transparency configuration for ensuring the ethical use of an AI asset

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.

SNOWFLAKE_AI_MODEL_CONTEXT: RelationField = RelationField('snowflakeAIModelContext') class-attribute

TBC

SNOWFLAKE_AI_MODEL_VERSION_ALIASES: KeywordField = KeywordField('snowflakeAIModelVersionAliases', 'snowflakeAIModelVersionAliases') class-attribute

The aliases for the model version.

SNOWFLAKE_AI_MODEL_VERSION_FUNCTIONS: KeywordField = KeywordField('snowflakeAIModelVersionFunctions', 'snowflakeAIModelVersionFunctions') class-attribute

Functions used in the model version.

SNOWFLAKE_AI_MODEL_VERSION_METRICS: KeywordField = KeywordField('snowflakeAIModelVersionMetrics', 'snowflakeAIModelVersionMetrics') class-attribute

Metrics for an individual experiment.

SNOWFLAKE_AI_MODEL_VERSION_NAME: KeywordField = KeywordField('snowflakeAIModelVersionName', 'snowflakeAIModelVersionName') class-attribute

Version part of the model name.

SNOWFLAKE_AI_MODEL_VERSION_TYPE: KeywordField = KeywordField('snowflakeAIModelVersionType', 'snowflakeAIModelVersionType') class-attribute

The type of the model version.

SNOWFLAKE_SEMANTIC_LOGICAL_TABLES: RelationField = RelationField('snowflakeSemanticLogicalTables') class-attribute

TBC

SQL_AI_INSIGHTS_LAST_ANALYZED_AT: NumericField = NumericField('sqlAiInsightsLastAnalyzedAt', 'sqlAiInsightsLastAnalyzedAt') class-attribute

Time (epoch) at which this asset was last analyzed for AI insights, in milliseconds.

Number of popular business questions associated with this asset.

Number of popular filter patterns associated with this asset.

Number of popular join patterns associated with this asset.

SQL_AI_INSIGHTS_RELATIONSHIP_COUNT: NumericField = NumericField('sqlAiInsightsRelationshipCount', 'sqlAiInsightsRelationshipCount') class-attribute

Number of relationship insights associated with this asset.

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_HAS_AI_INSIGHTS: BooleanField = BooleanField('sqlHasAiInsights', 'sqlHasAiInsights') class-attribute

Whether this asset has any AI insights data available.

SQL_INSIGHT_BUSINESS_QUESTIONS: RelationField = RelationField('sqlInsightBusinessQuestions') class-attribute

TBC

SQL_INSIGHT_INCOMING_JOINS: RelationField = RelationField('sqlInsightIncomingJoins') class-attribute

TBC

SQL_INSIGHT_OUTGOING_JOINS: RelationField = RelationField('sqlInsightOutgoingJoins') 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.

SnowflakeDynamicTable

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

Bases: Table

Description

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

Attributes

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

SQL statements used to define the dynamic table.

SnowflakePipe

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

Bases: SQL

Description

Source code in pyatlan/model/assets/core/referenceable.py
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 this pipe.

SNOWFLAKE_PIPE_IS_AUTO_INGEST_ENABLED: BooleanField = BooleanField('snowflakePipeIsAutoIngestEnabled', 'snowflakePipeIsAutoIngestEnabled') class-attribute

Whether auto-ingest is enabled for this pipe (true) or not (false).

SNOWFLAKE_PIPE_NOTIFICATION_CHANNEL_NAME: KeywordTextField = KeywordTextField('snowflakePipeNotificationChannelName', 'snowflakePipeNotificationChannelName', 'snowflakePipeNotificationChannelName.text') class-attribute

Name of the notification channel for this pipe.

SnowflakeStage

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

Bases: SQL

Description

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

Attributes

SNOWFLAKE_STAGE_EXTERNAL_LOCATION: KeywordField = KeywordField('snowflakeStageExternalLocation', 'snowflakeStageExternalLocation') class-attribute

The URL or cloud storage path specifying the external location where the stage data files are stored. This is NULL for internal stages.

SNOWFLAKE_STAGE_EXTERNAL_LOCATION_REGION: KeywordField = KeywordField('snowflakeStageExternalLocationRegion', 'snowflakeStageExternalLocationRegion') class-attribute

The geographic region identifier where the external stage is located in cloud storage. This is NULL for internal stages.

SNOWFLAKE_STAGE_STORAGE_INTEGRATION: KeywordField = KeywordField('snowflakeStageStorageIntegration', 'snowflakeStageStorageIntegration') class-attribute

The name of the storage integration associated with the stage; NULL for internal stages or stages that do not use a storage integration.

SNOWFLAKE_STAGE_TYPE: KeywordField = KeywordField('snowflakeStageType', 'snowflakeStageType') class-attribute

Categorization of the stage type in Snowflake, which can be 'Internal Named' or 'External Named', indicating whether the stage storage is within Snowflake or in external cloud storage.

SQL_STAGE_SCHEMA: RelationField = RelationField('sqlStageSchema') class-attribute

TBC

SnowflakeStream

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

Bases: SQL

Description

Source code in pyatlan/model/assets/core/referenceable.py
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

SNOWFLAKE_STREAM_IS_STALE: BooleanField = BooleanField('snowflakeStreamIsStale', 'snowflakeStreamIsStale') class-attribute

Whether this stream is stale (true) or not (false).

SNOWFLAKE_STREAM_MODE: KeywordField = KeywordField('snowflakeStreamMode', 'snowflakeStreamMode') class-attribute

Mode of this stream.

SNOWFLAKE_STREAM_SOURCE_TYPE: KeywordField = KeywordField('snowflakeStreamSourceType', 'snowflakeStreamSourceType') class-attribute

Type of the source of this stream.

SNOWFLAKE_STREAM_STALE_AFTER: NumericField = NumericField('snowflakeStreamStaleAfter', 'snowflakeStreamStaleAfter') class-attribute

Time (epoch) after which this stream will be stale, in milliseconds.

SNOWFLAKE_STREAM_TYPE: KeywordField = KeywordField('snowflakeStreamType', 'snowflakeStreamType') class-attribute

Type of this stream, for example: standard, append-only, insert-only, etc.

SnowflakeTag

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

Bases: Tag

Description

Source code in pyatlan/model/assets/core/referenceable.py
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_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.

CATALOG_DATASET_GUID: KeywordField = KeywordField('catalogDatasetGuid', 'catalogDatasetGuid') class-attribute

Unique identifier of the dataset this asset belongs to.

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.

MAPPED_CLASSIFICATION_NAME: KeywordField = KeywordField('mappedClassificationName', 'mappedClassificationName') class-attribute

Name of the classification in Atlan that is mapped to this tag.

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.

SNOWFLAKE_SEMANTIC_LOGICAL_TABLES: RelationField = RelationField('snowflakeSemanticLogicalTables') class-attribute

TBC

SQL_AI_INSIGHTS_LAST_ANALYZED_AT: NumericField = NumericField('sqlAiInsightsLastAnalyzedAt', 'sqlAiInsightsLastAnalyzedAt') class-attribute

Time (epoch) at which this asset was last analyzed for AI insights, in milliseconds.

Number of popular business questions associated with this asset.

Number of popular filter patterns associated with this asset.

Number of popular join patterns associated with this asset.

SQL_AI_INSIGHTS_RELATIONSHIP_COUNT: NumericField = NumericField('sqlAiInsightsRelationshipCount', 'sqlAiInsightsRelationshipCount') class-attribute

Number of relationship insights associated with this asset.

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_HAS_AI_INSIGHTS: BooleanField = BooleanField('sqlHasAiInsights', 'sqlHasAiInsights') class-attribute

Whether this asset has any AI insights data available.

SQL_INSIGHT_BUSINESS_QUESTIONS: RelationField = RelationField('sqlInsightBusinessQuestions') class-attribute

TBC

SQL_INSIGHT_INCOMING_JOINS: RelationField = RelationField('sqlInsightIncomingJoins') class-attribute

TBC

SQL_INSIGHT_OUTGOING_JOINS: RelationField = RelationField('sqlInsightOutgoingJoins') 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.

TAG_ALLOWED_VALUES: KeywordTextField = KeywordTextField('tagAllowedValues', 'tagAllowedValues', 'tagAllowedValues.text') class-attribute

Allowed values for the tag in the source system. These are denormalized from tagAttributes for ease of querying.

TAG_ATTRIBUTES: KeywordField = KeywordField('tagAttributes', 'tagAttributes') class-attribute

Attributes associated with the tag in the source system.

TAG_ID: KeywordField = KeywordField('tagId', 'tagId') class-attribute

Unique identifier of the tag in the source system.

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.

BigqueryTag

pyatlan.model.assets.bigquery_tag.BigqueryTag(__pydantic_self__, **data: Any)

Bases: Tag

Description

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

Attributes

BIGQUERY_TAG_HIERARCHY: KeywordField = KeywordField('bigqueryTagHierarchy', 'bigqueryTagHierarchy') class-attribute

List of top-level upstream nested bigquery tags.

BIGQUERY_TAG_TAXONOMY_PROPERTIES: KeywordField = KeywordField('bigqueryTagTaxonomyProperties', 'bigqueryTagTaxonomyProperties') class-attribute

Properties of the bigquery tag taxonomy attribute.

BIGQUERY_TAG_TYPE: KeywordField = KeywordField('bigqueryTagType', 'bigqueryTagType') class-attribute

The specific type or category of the Bigquery tag, which can be used for classification and organization of Bigquery assets.

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.

CATALOG_DATASET_GUID: KeywordField = KeywordField('catalogDatasetGuid', 'catalogDatasetGuid') class-attribute

Unique identifier of the dataset this asset belongs to.

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.

MAPPED_CLASSIFICATION_NAME: KeywordField = KeywordField('mappedClassificationName', 'mappedClassificationName') class-attribute

Name of the classification in Atlan that is mapped to this tag.

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.

SNOWFLAKE_SEMANTIC_LOGICAL_TABLES: RelationField = RelationField('snowflakeSemanticLogicalTables') class-attribute

TBC

SQL_AI_INSIGHTS_LAST_ANALYZED_AT: NumericField = NumericField('sqlAiInsightsLastAnalyzedAt', 'sqlAiInsightsLastAnalyzedAt') class-attribute

Time (epoch) at which this asset was last analyzed for AI insights, in milliseconds.

Number of popular business questions associated with this asset.

Number of popular filter patterns associated with this asset.

Number of popular join patterns associated with this asset.

SQL_AI_INSIGHTS_RELATIONSHIP_COUNT: NumericField = NumericField('sqlAiInsightsRelationshipCount', 'sqlAiInsightsRelationshipCount') class-attribute

Number of relationship insights associated with this asset.

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_HAS_AI_INSIGHTS: BooleanField = BooleanField('sqlHasAiInsights', 'sqlHasAiInsights') class-attribute

Whether this asset has any AI insights data available.

SQL_INSIGHT_BUSINESS_QUESTIONS: RelationField = RelationField('sqlInsightBusinessQuestions') class-attribute

TBC

SQL_INSIGHT_INCOMING_JOINS: RelationField = RelationField('sqlInsightIncomingJoins') class-attribute

TBC

SQL_INSIGHT_OUTGOING_JOINS: RelationField = RelationField('sqlInsightOutgoingJoins') 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.

TAG_ALLOWED_VALUES: KeywordTextField = KeywordTextField('tagAllowedValues', 'tagAllowedValues', 'tagAllowedValues.text') class-attribute

Allowed values for the tag in the source system. These are denormalized from tagAttributes for ease of querying.

TAG_ATTRIBUTES: KeywordField = KeywordField('tagAttributes', 'tagAttributes') class-attribute

Attributes associated with the tag in the source system.

TAG_ID: KeywordField = KeywordField('tagId', 'tagId') class-attribute

Unique identifier of the tag in the source system.

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.

BigqueryRoutine

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

Bases: Procedure

Description

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

Attributes

BIGQUERY_ATLAN_SCHEMA: RelationField = RelationField('bigqueryAtlanSchema') class-attribute

TBC

BIGQUERY_PROCESSES: RelationField = RelationField('bigqueryProcesses') class-attribute

TBC

BIGQUERY_ROUTINE_ARGUMENTS: KeywordField = KeywordField('bigqueryRoutineArguments', 'bigqueryRoutineArguments') class-attribute

Arguments that are passed in to the routine.

BIGQUERY_ROUTINE_DDL: KeywordField = KeywordField('bigqueryRoutineDdl', 'bigqueryRoutineDdl') class-attribute

The ddl statement used to create the bigquery routine.

BIGQUERY_ROUTINE_RETURN_TYPE: KeywordField = KeywordField('bigqueryRoutineReturnType', 'bigqueryRoutineReturnType') class-attribute

Return data type of the bigquery routine (null for stored procedures).

BIGQUERY_ROUTINE_SECURITY_TYPE: KeywordField = KeywordField('bigqueryRoutineSecurityType', 'bigqueryRoutineSecurityType') class-attribute

Security type of the routine, always null.

BIGQUERY_ROUTINE_TYPE: KeywordField = KeywordField('bigqueryRoutineType', 'bigqueryRoutineType') class-attribute

Type of bigquery routine (sp, udf, or tvf).