NoSQL Databases¶
CosmosMongoDB¶
pyatlan.model.assets.core.cosmos_mongo_d_b.CosmosMongoDB(__pydantic_self__, **data: Any)
¶
CosmosMongoDBAccount¶
pyatlan.model.assets.core.cosmos_mongo_d_b_account.CosmosMongoDBAccount(__pydantic_self__, **data: Any)
¶
Bases: CosmosMongoDB
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
COSMOS_MONGO_DB_ACCOUNT_CONSISTENCY_POLICY: TextField = TextField('cosmosMongoDBAccountConsistencyPolicy', 'cosmosMongoDBAccountConsistencyPolicy')
class-attribute
¶
The consistency policy configured for the Cosmos MongoDB account.
COSMOS_MONGO_DB_ACCOUNT_DOCUMENT_ENDPOINT: TextField = TextField('cosmosMongoDBAccountDocumentEndpoint', 'cosmosMongoDBAccountDocumentEndpoint')
class-attribute
¶
The Document Endpoint URL for the Cosmos MongoDB account.
COSMOS_MONGO_DB_ACCOUNT_ENABLE_AUTOMATIC_FAILOVER: BooleanField = BooleanField('cosmosMongoDBAccountEnableAutomaticFailover', 'cosmosMongoDBAccountEnableAutomaticFailover')
class-attribute
¶
Indicates whether automatic failover is enabled for the Cosmos MongoDB account.
COSMOS_MONGO_DB_ACCOUNT_ENABLE_MULTIPLE_WRITE_LOCATIONS: BooleanField = BooleanField('cosmosMongoDBAccountEnableMultipleWriteLocations', 'cosmosMongoDBAccountEnableMultipleWriteLocations')
class-attribute
¶
Indicates whether multiple write locations are enabled for the Cosmos MongoDB account.
COSMOS_MONGO_DB_ACCOUNT_ENABLE_PARTITION_KEY_MONITOR: BooleanField = BooleanField('cosmosMongoDBAccountEnablePartitionKeyMonitor', 'cosmosMongoDBAccountEnablePartitionKeyMonitor')
class-attribute
¶
Indicates whether partition key monitoring is enabled for the Cosmos MongoDB account.
COSMOS_MONGO_DB_ACCOUNT_INSTANCE_ID: KeywordField = KeywordField('cosmosMongoDBAccountInstanceId', 'cosmosMongoDBAccountInstanceId')
class-attribute
¶
The unique identifier for the Cosmos MongoDB account.
COSMOS_MONGO_DB_ACCOUNT_IS_VIRTUAL_NETWORK_FILTER_ENABLED: BooleanField = BooleanField('cosmosMongoDBAccountIsVirtualNetworkFilterEnabled', 'cosmosMongoDBAccountIsVirtualNetworkFilterEnabled')
class-attribute
¶
Indicates whether the virtual network filter is enabled for the Cosmos MongoDB account.
COSMOS_MONGO_DB_ACCOUNT_LOCATIONS: TextField = TextField('cosmosMongoDBAccountLocations', 'cosmosMongoDBAccountLocations')
class-attribute
¶
The locations where the Cosmos MongoDB account is available.
COSMOS_MONGO_DB_ACCOUNT_MONGO_ENDPOINT: TextField = TextField('cosmosMongoDBAccountMongoEndpoint', 'cosmosMongoDBAccountMongoEndpoint')
class-attribute
¶
The MongoDB connection endpoint for the Cosmos MongoDB account.
COSMOS_MONGO_DB_ACCOUNT_PUBLIC_NETWORK_ACCESS: TextField = TextField('cosmosMongoDBAccountPublicNetworkAccess', 'cosmosMongoDBAccountPublicNetworkAccess')
class-attribute
¶
The status of public network access for the Cosmos MongoDB account.
COSMOS_MONGO_DB_ACCOUNT_READ_LOCATIONS: TextField = TextField('cosmosMongoDBAccountReadLocations', 'cosmosMongoDBAccountReadLocations')
class-attribute
¶
The read locations configured for the Cosmos MongoDB account.
COSMOS_MONGO_DB_ACCOUNT_RESOURCE_GROUP: KeywordField = KeywordField('cosmosMongoDBAccountResourceGroup', 'cosmosMongoDBAccountResourceGroup')
class-attribute
¶
The resource group that contains the Cosmos MongoDB account.
COSMOS_MONGO_DB_ACCOUNT_SUBSCRIPTION_ID: KeywordField = KeywordField('cosmosMongoDBAccountSubscriptionId', 'cosmosMongoDBAccountSubscriptionId')
class-attribute
¶
The ID of the subscription to which the Cosmos MongoDB account belongs.
COSMOS_MONGO_DB_ACCOUNT_TYPE: KeywordField = KeywordField('cosmosMongoDBAccountType', 'cosmosMongoDBAccountType')
class-attribute
¶
The type of the Cosmos MongoDB account, such as RU or VCORE.
COSMOS_MONGO_DB_ACCOUNT_WRITE_LOCATIONS: TextField = TextField('cosmosMongoDBAccountWriteLocations', 'cosmosMongoDBAccountWriteLocations')
class-attribute
¶
The write locations configured for the Cosmos MongoDB account.
COSMOS_MONGO_DB_DATABASES: RelationField = RelationField('cosmosMongoDBDatabases')
class-attribute
¶
TBC
COSMOS_MONGO_DB_DATABASE_COUNT: NumericField = NumericField('cosmosMongoDBDatabaseCount', 'cosmosMongoDBDatabaseCount')
class-attribute
¶
Number of databases in this Cosmos MongoDB account.
CosmosMongoDBCollection¶
pyatlan.model.assets.core.cosmos_mongo_d_b_collection.CosmosMongoDBCollection(__pydantic_self__, **data: Any)
¶
Bases: CosmosMongoDB
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
ALIAS: TextField = TextField('alias', 'alias')
class-attribute
¶
Alias for this table.
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.
COLUMNS: RelationField = RelationField('columns')
class-attribute
¶
TBC
COLUMN_COUNT: NumericField = NumericField('columnCount', 'columnCount')
class-attribute
¶
Number of columns in this table.
COSMOS_MONGO_DB_DATABASE: RelationField = RelationField('cosmosMongoDBDatabase')
class-attribute
¶
TBC
COSMOS_MONGO_DB_DATABASE_QUALIFIED_NAME: KeywordTextField = KeywordTextField('cosmosMongoDBDatabaseQualifiedName', 'cosmosMongoDBDatabaseQualifiedName', 'cosmosMongoDBDatabaseQualifiedName.text')
class-attribute
¶
Unique name of the database in which this collection exists.
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
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_PROFILED: BooleanField = BooleanField('isProfiled', 'isProfiled')
class-attribute
¶
Whether this asset has been profiled (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).
LAST_PROFILED_AT: NumericField = NumericField('lastProfiledAt', 'lastProfiledAt')
class-attribute
¶
Time (epoch) at which this asset was last profiled, in milliseconds.
MONGO_DB_COLLECTION_AVERAGE_OBJECT_SIZE: NumericField = NumericField('mongoDBCollectionAverageObjectSize', 'mongoDBCollectionAverageObjectSize')
class-attribute
¶
Average size of an object in the collection.
MONGO_DB_COLLECTION_EXPIRE_AFTER_SECONDS: NumericField = NumericField('mongoDBCollectionExpireAfterSeconds', 'mongoDBCollectionExpireAfterSeconds')
class-attribute
¶
Seconds after which documents in a time series collection or clustered collection expire.
MONGO_DB_COLLECTION_IS_CAPPED: BooleanField = BooleanField('mongoDBCollectionIsCapped', 'mongoDBCollectionIsCapped')
class-attribute
¶
Whether the collection is capped (true) or not (false).
MONGO_DB_COLLECTION_MAXIMUM_DOCUMENT_COUNT: NumericField = NumericField('mongoDBCollectionMaximumDocumentCount', 'mongoDBCollectionMaximumDocumentCount')
class-attribute
¶
Maximum number of documents allowed in a capped collection.
MONGO_DB_COLLECTION_MAX_SIZE: NumericField = NumericField('mongoDBCollectionMaxSize', 'mongoDBCollectionMaxSize')
class-attribute
¶
Maximum size allowed in a capped collection.
MONGO_DB_COLLECTION_NUM_INDEXES: NumericField = NumericField('mongoDBCollectionNumIndexes', 'mongoDBCollectionNumIndexes')
class-attribute
¶
Number of indexes on the collection.
MONGO_DB_COLLECTION_NUM_ORPHAN_DOCS: NumericField = NumericField('mongoDBCollectionNumOrphanDocs', 'mongoDBCollectionNumOrphanDocs')
class-attribute
¶
Number of orphaned documents in the collection.
MONGO_DB_COLLECTION_SCHEMA_DEFINITION: TextField = TextField('mongoDBCollectionSchemaDefinition', 'mongoDBCollectionSchemaDefinition')
class-attribute
¶
Definition of the schema applicable for the collection.
MONGO_DB_COLLECTION_SUBTYPE: KeywordTextField = KeywordTextField('mongoDBCollectionSubtype', 'mongoDBCollectionSubtype', 'mongoDBCollectionSubtype.text')
class-attribute
¶
Subtype of a MongoDB collection, for example: Capped, Time Series, etc.
MONGO_DB_COLLECTION_TIME_FIELD: TextField = TextField('mongoDBCollectionTimeField', 'mongoDBCollectionTimeField')
class-attribute
¶
Name of the field containing the date in each time series document.
MONGO_DB_COLLECTION_TIME_GRANULARITY: KeywordField = KeywordField('mongoDBCollectionTimeGranularity', 'mongoDBCollectionTimeGranularity')
class-attribute
¶
Closest match to the time span between consecutive incoming measurements.
MONGO_DB_COLLECTION_TOTAL_INDEX_SIZE: NumericField = NumericField('mongoDBCollectionTotalIndexSize', 'mongoDBCollectionTotalIndexSize')
class-attribute
¶
Total size of all indexes.
MONGO_DB_COLUMNS: RelationField = RelationField('mongoDBColumns')
class-attribute
¶
TBC
MONGO_DB_DATABASE: RelationField = RelationField('mongoDBDatabase')
class-attribute
¶
TBC
NO_SQL_SCHEMA_DEFINITION: TextField = TextField('noSQLSchemaDefinition', 'noSQLSchemaDefinition')
class-attribute
¶
Represents attributes for describing the key schema for the table and indexes.
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_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_PREVIEW_CONFIG: KeywordField = KeywordField('queryPreviewConfig', 'queryPreviewConfig')
class-attribute
¶
Configuration for preview queries.
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.
ROW_COUNT: NumericField = NumericField('rowCount', 'rowCount')
class-attribute
¶
Number of rows in this table.
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.
SIZE_BYTES: NumericField = NumericField('sizeBytes', 'sizeBytes')
class-attribute
¶
Size of this table, in bytes.
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_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_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_OBJECT_COUNT: NumericField = NumericField('tableObjectCount', 'tableObjectCount')
class-attribute
¶
Number of objects in this 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.
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.
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.
CosmosMongoDBDatabase¶
pyatlan.model.assets.core.cosmos_mongo_d_b_database.CosmosMongoDBDatabase(__pydantic_self__, **data: Any)
¶
Bases: CosmosMongoDB
Description
Source code in pyatlan/model/assets/core/referenceable.py
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.
COSMOS_MONGO_DB_ACCOUNT: RelationField = RelationField('cosmosMongoDBAccount')
class-attribute
¶
TBC
COSMOS_MONGO_DB_ACCOUNT_QUALIFIED_NAME: KeywordTextField = KeywordTextField('cosmosMongoDBAccountQualifiedName', 'cosmosMongoDBAccountQualifiedName', 'cosmosMongoDBAccountQualifiedName.text')
class-attribute
¶
Unique name of the account in which this database exists.
COSMOS_MONGO_DB_COLLECTIONS: RelationField = RelationField('cosmosMongoDBCollections')
class-attribute
¶
TBC
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
FABRIC_WORKSPACE: RelationField = RelationField('fabricWorkspace')
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.
MONGO_DB_COLLECTIONS: RelationField = RelationField('mongoDBCollections')
class-attribute
¶
TBC
MONGO_DB_DATABASE_COLLECTION_COUNT: NumericField = NumericField('mongoDBDatabaseCollectionCount', 'mongoDBDatabaseCollectionCount')
class-attribute
¶
Number of collections in the database.
NO_SQL_SCHEMA_DEFINITION: TextField = TextField('noSQLSchemaDefinition', 'noSQLSchemaDefinition')
class-attribute
¶
Represents attributes for describing the key schema for the table and indexes.
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.
SCHEMAS: RelationField = RelationField('schemas')
class-attribute
¶
TBC
SCHEMA_COUNT: NumericField = NumericField('schemaCount', 'schemaCount')
class-attribute
¶
Number of schemas in this database.
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.
DocumentDB¶
pyatlan.model.assets.core.document_d_b.DocumentDB(__pydantic_self__, **data: Any)
¶
DocumentDBCollection¶
pyatlan.model.assets.core.document_d_b_collection.DocumentDBCollection(__pydantic_self__, **data: Any)
¶
Bases: Table
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
ALIAS: TextField = TextField('alias', 'alias')
class-attribute
¶
Alias for this table.
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.
COLUMN_COUNT: NumericField = NumericField('columnCount', 'columnCount')
class-attribute
¶
Number of columns in this table.
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.
DOCUMENT_DB_COLLECTION_AVERAGE_OBJECT_SIZE: NumericField = NumericField('documentDBCollectionAverageObjectSize', 'documentDBCollectionAverageObjectSize')
class-attribute
¶
Average size of an object in the collection.
DOCUMENT_DB_COLLECTION_EXPIRE_AFTER_SECONDS: NumericField = NumericField('documentDBCollectionExpireAfterSeconds', 'documentDBCollectionExpireAfterSeconds')
class-attribute
¶
Seconds after which documents in a time series collection or clustered collection expire.
DOCUMENT_DB_COLLECTION_IS_CAPPED: BooleanField = BooleanField('documentDBCollectionIsCapped', 'documentDBCollectionIsCapped')
class-attribute
¶
Whether the collection is capped (true) or not (false).
DOCUMENT_DB_COLLECTION_MAXIMUM_DOCUMENT_COUNT: NumericField = NumericField('documentDBCollectionMaximumDocumentCount', 'documentDBCollectionMaximumDocumentCount')
class-attribute
¶
Maximum number of documents allowed in a capped collection.
DOCUMENT_DB_COLLECTION_MAX_SIZE: NumericField = NumericField('documentDBCollectionMaxSize', 'documentDBCollectionMaxSize')
class-attribute
¶
Maximum size allowed in a capped collection.
DOCUMENT_DB_COLLECTION_NUM_INDEXES: NumericField = NumericField('documentDBCollectionNumIndexes', 'documentDBCollectionNumIndexes')
class-attribute
¶
Number of indexes in the collection.
DOCUMENT_DB_COLLECTION_NUM_ORPHAN_DOCS: NumericField = NumericField('documentDBCollectionNumOrphanDocs', 'documentDBCollectionNumOrphanDocs')
class-attribute
¶
Number of orphaned documents in the collection.
DOCUMENT_DB_COLLECTION_SCHEMA_DEFINITION: TextField = TextField('documentDBCollectionSchemaDefinition', 'documentDBCollectionSchemaDefinition')
class-attribute
¶
Definition of the schema applicable for the collection.
DOCUMENT_DB_COLLECTION_SUBTYPE: KeywordField = KeywordField('documentDBCollectionSubtype', 'documentDBCollectionSubtype')
class-attribute
¶
Subtype of a DocumentDBCollection, for example: Capped, Time Series, etc.
DOCUMENT_DB_COLLECTION_TIME_FIELD: KeywordField = KeywordField('documentDBCollectionTimeField', 'documentDBCollectionTimeField')
class-attribute
¶
Name of the field containing the date in each time series document.
DOCUMENT_DB_COLLECTION_TIME_GRANULARITY: KeywordField = KeywordField('documentDBCollectionTimeGranularity', 'documentDBCollectionTimeGranularity')
class-attribute
¶
Closest match to the time span between consecutive incoming measurements.
DOCUMENT_DB_COLLECTION_TOTAL_INDEX_SIZE: NumericField = NumericField('documentDBCollectionTotalIndexSize', 'documentDBCollectionTotalIndexSize')
class-attribute
¶
Total size of all indexes.
DOCUMENT_DB_DATABASE: RelationField = RelationField('documentDBDatabase')
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.
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_PROFILED: BooleanField = BooleanField('isProfiled', 'isProfiled')
class-attribute
¶
Whether this asset has been profiled (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).
LAST_PROFILED_AT: NumericField = NumericField('lastProfiledAt', 'lastProfiledAt')
class-attribute
¶
Time (epoch) at which this asset was last profiled, in milliseconds.
NO_SQL_SCHEMA_DEFINITION: TextField = TextField('noSQLSchemaDefinition', 'noSQLSchemaDefinition')
class-attribute
¶
Represents attributes for describing the key schema for the table and indexes.
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.
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_PREVIEW_CONFIG: KeywordField = KeywordField('queryPreviewConfig', 'queryPreviewConfig')
class-attribute
¶
Configuration for preview queries.
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.
ROW_COUNT: NumericField = NumericField('rowCount', 'rowCount')
class-attribute
¶
Number of rows in this table.
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.
SIZE_BYTES: NumericField = NumericField('sizeBytes', 'sizeBytes')
class-attribute
¶
Size of this table, in bytes.
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_IS_SECURE: BooleanField = BooleanField('sqlIsSecure', 'sqlIsSecure')
class-attribute
¶
Whether this asset is secure (true) or not (false).
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_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_OBJECT_COUNT: NumericField = NumericField('tableObjectCount', 'tableObjectCount')
class-attribute
¶
Number of objects in this 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.
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.
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.
DocumentDBDatabase¶
pyatlan.model.assets.core.document_d_b_database.DocumentDBDatabase(__pydantic_self__, **data: Any)
¶
Bases: DocumentDB
Description
Source code in pyatlan/model/assets/core/referenceable.py
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
DOCUMENT_DB_COLLECTIONS: RelationField = RelationField('documentDBCollections')
class-attribute
¶
TBC
DOCUMENT_DB_DATABASE_COLLECTION_COUNT: NumericField = NumericField('documentDBDatabaseCollectionCount', 'documentDBDatabaseCollectionCount')
class-attribute
¶
Number of collections in the database.
FABRIC_WORKSPACE: RelationField = RelationField('fabricWorkspace')
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.
NO_SQL_SCHEMA_DEFINITION: TextField = TextField('noSQLSchemaDefinition', 'noSQLSchemaDefinition')
class-attribute
¶
Represents attributes for describing the key schema for the table and indexes.
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.
SCHEMAS: RelationField = RelationField('schemas')
class-attribute
¶
TBC
SCHEMA_COUNT: NumericField = NumericField('schemaCount', 'schemaCount')
class-attribute
¶
Number of schemas in this database.
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.
DynamoDBSecondaryIndex¶
pyatlan.model.assets.core.dynamo_d_b_secondary_index.DynamoDBSecondaryIndex(__pydantic_self__, **data: Any)
¶
Bases: Table
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
ALIAS: TextField = TextField('alias', 'alias')
class-attribute
¶
Alias for this table.
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.
COLUMN_COUNT: NumericField = NumericField('columnCount', 'columnCount')
class-attribute
¶
Number of columns in this table.
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.
DYNAMO_DB_PARTITION_KEY: KeywordField = KeywordField('dynamoDBPartitionKey', 'dynamoDBPartitionKey')
class-attribute
¶
Specifies the partition key of the DynamoDB table or index.
DYNAMO_DB_READ_CAPACITY_UNITS: NumericField = NumericField('dynamoDBReadCapacityUnits', 'dynamoDBReadCapacityUnits')
class-attribute
¶
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
DYNAMO_DB_SECONDARY_INDEX_PROJECTION_TYPE: KeywordField = KeywordField('dynamoDBSecondaryIndexProjectionType', 'dynamoDBSecondaryIndexProjectionType')
class-attribute
¶
Specifies attributes that are projected from the DynamoDB table into the index.
DYNAMO_DB_SORT_KEY: KeywordField = KeywordField('dynamoDBSortKey', 'dynamoDBSortKey')
class-attribute
¶
Specifies the sort key of the DynamoDB table or index.
DYNAMO_DB_STATUS: KeywordField = KeywordField('dynamoDBStatus', 'dynamoDBStatus')
class-attribute
¶
Status of the DynamoDB asset.
DYNAMO_DB_WRITE_CAPACITY_UNITS: NumericField = NumericField('dynamoDBWriteCapacityUnits', 'dynamoDBWriteCapacityUnits')
class-attribute
¶
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
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.
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_PROFILED: BooleanField = BooleanField('isProfiled', 'isProfiled')
class-attribute
¶
Whether this asset has been profiled (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).
LAST_PROFILED_AT: NumericField = NumericField('lastProfiledAt', 'lastProfiledAt')
class-attribute
¶
Time (epoch) at which this asset was last profiled, in milliseconds.
NO_SQL_SCHEMA_DEFINITION: TextField = TextField('noSQLSchemaDefinition', 'noSQLSchemaDefinition')
class-attribute
¶
Represents attributes for describing the key schema for the table and indexes.
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.
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_PREVIEW_CONFIG: KeywordField = KeywordField('queryPreviewConfig', 'queryPreviewConfig')
class-attribute
¶
Configuration for preview queries.
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.
ROW_COUNT: NumericField = NumericField('rowCount', 'rowCount')
class-attribute
¶
Number of rows in this table.
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.
SIZE_BYTES: NumericField = NumericField('sizeBytes', 'sizeBytes')
class-attribute
¶
Size of this table, in bytes.
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_IS_SECURE: BooleanField = BooleanField('sqlIsSecure', 'sqlIsSecure')
class-attribute
¶
Whether this asset is secure (true) or not (false).
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_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_OBJECT_COUNT: NumericField = NumericField('tableObjectCount', 'tableObjectCount')
class-attribute
¶
Number of objects in this 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.
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.
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.
MongoDBCollection¶
pyatlan.model.assets.core.mongo_d_b_collection.MongoDBCollection(__pydantic_self__, **data: Any)
¶
Bases: Table
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
ALIAS: TextField = TextField('alias', 'alias')
class-attribute
¶
Alias for this table.
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.
COLUMN_COUNT: NumericField = NumericField('columnCount', 'columnCount')
class-attribute
¶
Number of columns in this table.
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.
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.
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_PROFILED: BooleanField = BooleanField('isProfiled', 'isProfiled')
class-attribute
¶
Whether this asset has been profiled (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).
LAST_PROFILED_AT: NumericField = NumericField('lastProfiledAt', 'lastProfiledAt')
class-attribute
¶
Time (epoch) at which this asset was last profiled, in milliseconds.
MONGO_DB_COLLECTION_AVERAGE_OBJECT_SIZE: NumericField = NumericField('mongoDBCollectionAverageObjectSize', 'mongoDBCollectionAverageObjectSize')
class-attribute
¶
Average size of an object in the collection.
MONGO_DB_COLLECTION_EXPIRE_AFTER_SECONDS: NumericField = NumericField('mongoDBCollectionExpireAfterSeconds', 'mongoDBCollectionExpireAfterSeconds')
class-attribute
¶
Seconds after which documents in a time series collection or clustered collection expire.
MONGO_DB_COLLECTION_IS_CAPPED: BooleanField = BooleanField('mongoDBCollectionIsCapped', 'mongoDBCollectionIsCapped')
class-attribute
¶
Whether the collection is capped (true) or not (false).
MONGO_DB_COLLECTION_MAXIMUM_DOCUMENT_COUNT: NumericField = NumericField('mongoDBCollectionMaximumDocumentCount', 'mongoDBCollectionMaximumDocumentCount')
class-attribute
¶
Maximum number of documents allowed in a capped collection.
MONGO_DB_COLLECTION_MAX_SIZE: NumericField = NumericField('mongoDBCollectionMaxSize', 'mongoDBCollectionMaxSize')
class-attribute
¶
Maximum size allowed in a capped collection.
MONGO_DB_COLLECTION_NUM_INDEXES: NumericField = NumericField('mongoDBCollectionNumIndexes', 'mongoDBCollectionNumIndexes')
class-attribute
¶
Number of indexes on the collection.
MONGO_DB_COLLECTION_NUM_ORPHAN_DOCS: NumericField = NumericField('mongoDBCollectionNumOrphanDocs', 'mongoDBCollectionNumOrphanDocs')
class-attribute
¶
Number of orphaned documents in the collection.
MONGO_DB_COLLECTION_SCHEMA_DEFINITION: TextField = TextField('mongoDBCollectionSchemaDefinition', 'mongoDBCollectionSchemaDefinition')
class-attribute
¶
Definition of the schema applicable for the collection.
MONGO_DB_COLLECTION_SUBTYPE: KeywordTextField = KeywordTextField('mongoDBCollectionSubtype', 'mongoDBCollectionSubtype', 'mongoDBCollectionSubtype.text')
class-attribute
¶
Subtype of a MongoDB collection, for example: Capped, Time Series, etc.
MONGO_DB_COLLECTION_TIME_FIELD: TextField = TextField('mongoDBCollectionTimeField', 'mongoDBCollectionTimeField')
class-attribute
¶
Name of the field containing the date in each time series document.
MONGO_DB_COLLECTION_TIME_GRANULARITY: KeywordField = KeywordField('mongoDBCollectionTimeGranularity', 'mongoDBCollectionTimeGranularity')
class-attribute
¶
Closest match to the time span between consecutive incoming measurements.
MONGO_DB_COLLECTION_TOTAL_INDEX_SIZE: NumericField = NumericField('mongoDBCollectionTotalIndexSize', 'mongoDBCollectionTotalIndexSize')
class-attribute
¶
Total size of all indexes.
MONGO_DB_COLUMNS: RelationField = RelationField('mongoDBColumns')
class-attribute
¶
TBC
MONGO_DB_DATABASE: RelationField = RelationField('mongoDBDatabase')
class-attribute
¶
TBC
NO_SQL_SCHEMA_DEFINITION: TextField = TextField('noSQLSchemaDefinition', 'noSQLSchemaDefinition')
class-attribute
¶
Represents attributes for describing the key schema for the table and indexes.
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.
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_PREVIEW_CONFIG: KeywordField = KeywordField('queryPreviewConfig', 'queryPreviewConfig')
class-attribute
¶
Configuration for preview queries.
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.
ROW_COUNT: NumericField = NumericField('rowCount', 'rowCount')
class-attribute
¶
Number of rows in this table.
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.
SIZE_BYTES: NumericField = NumericField('sizeBytes', 'sizeBytes')
class-attribute
¶
Size of this table, in bytes.
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_IS_SECURE: BooleanField = BooleanField('sqlIsSecure', 'sqlIsSecure')
class-attribute
¶
Whether this asset is secure (true) or not (false).
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_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_OBJECT_COUNT: NumericField = NumericField('tableObjectCount', 'tableObjectCount')
class-attribute
¶
Number of objects in this 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.
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.
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.
MongoDBDatabase¶
pyatlan.model.assets.core.mongo_d_b_database.MongoDBDatabase(__pydantic_self__, **data: Any)
¶
Bases: Database
Description
Source code in pyatlan/model/assets/core/referenceable.py
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.
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.
MONGO_DB_COLLECTIONS: RelationField = RelationField('mongoDBCollections')
class-attribute
¶
TBC
MONGO_DB_DATABASE_COLLECTION_COUNT: NumericField = NumericField('mongoDBDatabaseCollectionCount', 'mongoDBDatabaseCollectionCount')
class-attribute
¶
Number of collections in the database.
NO_SQL_SCHEMA_DEFINITION: TextField = TextField('noSQLSchemaDefinition', 'noSQLSchemaDefinition')
class-attribute
¶
Represents attributes for describing the key schema for the table and indexes.
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_COUNT: NumericField = NumericField('schemaCount', 'schemaCount')
class-attribute
¶
Number of schemas in this database.
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_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.
NoSQL¶
pyatlan.model.assets.core.no_s_q_l.NoSQL(__pydantic_self__, **data: Any)
¶
MongoDB¶
pyatlan.model.assets.mongo_d_b.MongoDB(__pydantic_self__, **data: Any)
¶
DynamoDB¶
pyatlan.model.assets.dynamo_d_b.DynamoDB(__pydantic_self__, **data: Any)
¶
Bases: NoSQL
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
DYNAMO_DB_PARTITION_KEY: KeywordField = KeywordField('dynamoDBPartitionKey', 'dynamoDBPartitionKey')
class-attribute
¶
Specifies the partition key of the DynamoDB table or index.
DYNAMO_DB_READ_CAPACITY_UNITS: NumericField = NumericField('dynamoDBReadCapacityUnits', 'dynamoDBReadCapacityUnits')
class-attribute
¶
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
DYNAMO_DB_SORT_KEY: KeywordField = KeywordField('dynamoDBSortKey', 'dynamoDBSortKey')
class-attribute
¶
Specifies the sort key of the DynamoDB table or index.
DYNAMO_DB_STATUS: KeywordField = KeywordField('dynamoDBStatus', 'dynamoDBStatus')
class-attribute
¶
Status of the DynamoDB asset.
DYNAMO_DB_WRITE_CAPACITY_UNITS: NumericField = NumericField('dynamoDBWriteCapacityUnits', 'dynamoDBWriteCapacityUnits')
class-attribute
¶
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
DynamoDBTable¶
pyatlan.model.assets.dynamo_dbtable.DynamoDBTable(__pydantic_self__, **data: Any)
¶
Bases: Table
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
ALIAS: TextField = TextField('alias', 'alias')
class-attribute
¶
Alias for this table.
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.
COLUMN_COUNT: NumericField = NumericField('columnCount', 'columnCount')
class-attribute
¶
Number of columns in this table.
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.
DYNAMO_DB_COLUMNS: RelationField = RelationField('dynamoDBColumns')
class-attribute
¶
TBC
DYNAMO_DB_GLOBAL_SECONDARY_INDEXES: RelationField = RelationField('dynamoDBGlobalSecondaryIndexes')
class-attribute
¶
TBC
DYNAMO_DB_LOCAL_SECONDARY_INDEXES: RelationField = RelationField('dynamoDBLocalSecondaryIndexes')
class-attribute
¶
TBC
DYNAMO_DB_PARTITION_KEY: KeywordField = KeywordField('dynamoDBPartitionKey', 'dynamoDBPartitionKey')
class-attribute
¶
Specifies the partition key of the DynamoDB table or index.
DYNAMO_DB_READ_CAPACITY_UNITS: NumericField = NumericField('dynamoDBReadCapacityUnits', 'dynamoDBReadCapacityUnits')
class-attribute
¶
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
DYNAMO_DB_SORT_KEY: KeywordField = KeywordField('dynamoDBSortKey', 'dynamoDBSortKey')
class-attribute
¶
Specifies the sort key of the DynamoDB table or index.
DYNAMO_DB_STATUS: KeywordField = KeywordField('dynamoDBStatus', 'dynamoDBStatus')
class-attribute
¶
Status of the DynamoDB asset.
DYNAMO_DB_TABLE_GSI_COUNT: NumericField = NumericField('dynamoDBTableGSICount', 'dynamoDBTableGSICount')
class-attribute
¶
Represents the number of global secondary indexes on the table.
DYNAMO_DB_TABLE_LSI_COUNT: NumericField = NumericField('dynamoDBTableLSICount', 'dynamoDBTableLSICount')
class-attribute
¶
Represents the number of local secondary indexes on the table.
DYNAMO_DB_WRITE_CAPACITY_UNITS: NumericField = NumericField('dynamoDBWriteCapacityUnits', 'dynamoDBWriteCapacityUnits')
class-attribute
¶
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
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.
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_PROFILED: BooleanField = BooleanField('isProfiled', 'isProfiled')
class-attribute
¶
Whether this asset has been profiled (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).
LAST_PROFILED_AT: NumericField = NumericField('lastProfiledAt', 'lastProfiledAt')
class-attribute
¶
Time (epoch) at which this asset was last profiled, in milliseconds.
NO_SQL_SCHEMA_DEFINITION: TextField = TextField('noSQLSchemaDefinition', 'noSQLSchemaDefinition')
class-attribute
¶
Represents attributes for describing the key schema for the table and indexes.
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.
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_PREVIEW_CONFIG: KeywordField = KeywordField('queryPreviewConfig', 'queryPreviewConfig')
class-attribute
¶
Configuration for preview queries.
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.
ROW_COUNT: NumericField = NumericField('rowCount', 'rowCount')
class-attribute
¶
Number of rows in this table.
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.
SIZE_BYTES: NumericField = NumericField('sizeBytes', 'sizeBytes')
class-attribute
¶
Size of this table, in bytes.
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_IS_SECURE: BooleanField = BooleanField('sqlIsSecure', 'sqlIsSecure')
class-attribute
¶
Whether this asset is secure (true) or not (false).
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_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_OBJECT_COUNT: NumericField = NumericField('tableObjectCount', 'tableObjectCount')
class-attribute
¶
Number of objects in this 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.
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.
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.
DynamoDBLocalSecondaryIndex¶
pyatlan.model.assets.dynamo_d_b_local_secondary_index.DynamoDBLocalSecondaryIndex(__pydantic_self__, **data: Any)
¶
DynamoDBGlobalSecondaryIndex¶
pyatlan.model.assets.dynamo_d_b_global_secondary_index.DynamoDBGlobalSecondaryIndex(__pydantic_self__, **data: Any)
¶
DynamoDBAttribute¶
pyatlan.model.assets.dynamo_d_b_attribute.DynamoDBAttribute(__pydantic_self__, **data: Any)
¶
Bases: Column
Description
Source code in pyatlan/model/assets/core/referenceable.py
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.
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_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.
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.
DATA_TYPE: KeywordTextField = KeywordTextField('dataType', 'dataType', 'dataType.text')
class-attribute
¶
Data type of values in this column.
DEFAULT_VALUE: TextField = TextField('defaultValue', 'defaultValue')
class-attribute
¶
Default value for this column.
DYNAMO_DB_PARTITION_KEY: KeywordField = KeywordField('dynamoDBPartitionKey', 'dynamoDBPartitionKey')
class-attribute
¶
Specifies the partition key of the DynamoDB table or index.
DYNAMO_DB_READ_CAPACITY_UNITS: NumericField = NumericField('dynamoDBReadCapacityUnits', 'dynamoDBReadCapacityUnits')
class-attribute
¶
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
DYNAMO_DB_SORT_KEY: KeywordField = KeywordField('dynamoDBSortKey', 'dynamoDBSortKey')
class-attribute
¶
Specifies the sort key of the DynamoDB table or index.
DYNAMO_DB_STATUS: KeywordField = KeywordField('dynamoDBStatus', 'dynamoDBStatus')
class-attribute
¶
Status of the DynamoDB asset.
DYNAMO_DB_TABLE: RelationField = RelationField('dynamoDBTable')
class-attribute
¶
TBC
DYNAMO_DB_WRITE_CAPACITY_UNITS: NumericField = NumericField('dynamoDBWriteCapacityUnits', 'dynamoDBWriteCapacityUnits')
class-attribute
¶
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
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_PROFILED: BooleanField = BooleanField('isProfiled', 'isProfiled')
class-attribute
¶
Whether this asset has been profiled (true) or not (false).
IS_SORT: BooleanField = BooleanField('isSort', 'isSort')
class-attribute
¶
Whether this column is a sort column (true) or not (false).
LAST_PROFILED_AT: NumericField = NumericField('lastProfiledAt', 'lastProfiledAt')
class-attribute
¶
Time (epoch) at which this asset was last profiled, in milliseconds.
MAX_LENGTH: NumericField = NumericField('maxLength', 'maxLength')
class-attribute
¶
Maximum length of a value in this column.
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.
NO_SQL_SCHEMA_DEFINITION: TextField = TextField('noSQLSchemaDefinition', 'noSQLSchemaDefinition')
class-attribute
¶
Represents attributes for describing the key schema for the table and indexes.
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_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.
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.
RAW_DATA_TYPE_DEFINITION: TextField = TextField('rawDataTypeDefinition', 'rawDataTypeDefinition')
class-attribute
¶
Raw data type definition of this column.
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_IS_SECURE: BooleanField = BooleanField('sqlIsSecure', 'sqlIsSecure')
class-attribute
¶
Whether this asset is secure (true) or not (false).
SUB_DATA_TYPE: KeywordField = KeywordField('subDataType', 'subDataType')
class-attribute
¶
Sub-data type of this column.
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.
VALIDATIONS: KeywordField = KeywordField('validations', 'validations')
class-attribute
¶
Validations for this column.
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.
Cassandra¶
pyatlan.model.assets.cassandra.Cassandra(__pydantic_self__, **data: Any)
¶
Bases: NoSQL
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
CASSANDRA_KEYSPACE_NAME: KeywordField = KeywordField('cassandraKeyspaceName', 'cassandraKeyspaceName')
class-attribute
¶
Name of the keyspace for the Cassandra asset.
CASSANDRA_TABLE_NAME: KeywordField = KeywordField('cassandraTableName', 'cassandraTableName')
class-attribute
¶
Name of the table for the Cassandra asset.
CASSANDRA_TABLE_QUALIFIED_NAME: KeywordField = KeywordField('cassandraTableQualifiedName', 'cassandraTableQualifiedName')
class-attribute
¶
Unique name of table for Cassandra asset
CASSANDRA_VIEW_NAME: KeywordField = KeywordField('cassandraViewName', 'cassandraViewName')
class-attribute
¶
Name of view for Cassandra asset
CASSANDRA_VIEW_QUALIFIED_NAME: KeywordField = KeywordField('cassandraViewQualifiedName', 'cassandraViewQualifiedName')
class-attribute
¶
Unique name of view for Cassandra asset
CassandraTable¶
pyatlan.model.assets.cassandra_table.CassandraTable(__pydantic_self__, **data: Any)
¶
Bases: Cassandra
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
CASSANDRA_COLUMNS: RelationField = RelationField('cassandraColumns')
class-attribute
¶
TBC
CASSANDRA_INDEXES: RelationField = RelationField('cassandraIndexes')
class-attribute
¶
TBC
CASSANDRA_KEYSPACE: RelationField = RelationField('cassandraKeyspace')
class-attribute
¶
TBC
CASSANDRA_TABLE_BLOOM_FILTER_FP_CHANCE: NumericField = NumericField('cassandraTableBloomFilterFPChance', 'cassandraTableBloomFilterFPChance')
class-attribute
¶
Bloom filter false positive chance for the CassandraTable.
CASSANDRA_TABLE_CACHING: KeywordField = KeywordField('cassandraTableCaching', 'cassandraTableCaching')
class-attribute
¶
Caching behavior in Cassandra.
CASSANDRA_TABLE_COMMENT: KeywordField = KeywordField('cassandraTableComment', 'cassandraTableComment')
class-attribute
¶
Comment describing the CassandraTable's purpose or usage in Cassandra.
CASSANDRA_TABLE_COMPACTION: KeywordField = KeywordField('cassandraTableCompaction', 'cassandraTableCompaction')
class-attribute
¶
Compaction used for the CassandraTable in Cassandra.
CASSANDRA_TABLE_COMPRESSION: KeywordField = KeywordField('cassandraTableCompression', 'cassandraTableCompression')
class-attribute
¶
Compression used for the CassandraTable in Cassandra.
CASSANDRA_TABLE_CRC_CHECK_CHANCE: NumericField = NumericField('cassandraTableCRCCheckChance', 'cassandraTableCRCCheckChance')
class-attribute
¶
CRC check chance for the CassandraTable.
CASSANDRA_TABLE_DC_LOCAL_READ_REPAIR_CHANCE: NumericField = NumericField('cassandraTableDCLocalReadRepairChance', 'cassandraTableDCLocalReadRepairChance')
class-attribute
¶
Local read repair chance in Cassandra.
CASSANDRA_TABLE_DEFAULT_TTL: NumericField = NumericField('cassandraTableDefaultTTL', 'cassandraTableDefaultTTL')
class-attribute
¶
Default time-to-live for the CassandraTable in Cassandra.
CASSANDRA_TABLE_FLAGS: KeywordField = KeywordField('cassandraTableFlags', 'cassandraTableFlags')
class-attribute
¶
Flags associated with the CassandraTable.
CASSANDRA_TABLE_GC_GRACE_SECONDS: NumericField = NumericField('cassandraTableGCGraceSeconds', 'cassandraTableGCGraceSeconds')
class-attribute
¶
Grace period for garbage collection in the CassandraTable.
CASSANDRA_TABLE_ID: KeywordField = KeywordField('cassandraTableId', 'cassandraTableId')
class-attribute
¶
Unique identifier for the CassandraTable.
CASSANDRA_TABLE_MAX_INDEX_INTERVAL: NumericField = NumericField('cassandraTableMaxIndexInterval', 'cassandraTableMaxIndexInterval')
class-attribute
¶
Maximum index interval for the CassandraTable.
CASSANDRA_TABLE_MEMTABLE_FLUSH_PERIOD_IN_MS: NumericField = NumericField('cassandraTableMemtableFlushPeriodInMs', 'cassandraTableMemtableFlushPeriodInMs')
class-attribute
¶
Memtable flush period for the CassandraTable (in milliseconds).
CASSANDRA_TABLE_MIN_INDEX_INTERVAL: NumericField = NumericField('cassandraTableMinIndexInterval', 'cassandraTableMinIndexInterval')
class-attribute
¶
Minimum index interval for the CassandraTable.
CASSANDRA_TABLE_QUERY: KeywordField = KeywordField('cassandraTableQuery', 'cassandraTableQuery')
class-attribute
¶
Query used to create the CassandraTable in Cassandra.
CASSANDRA_TABLE_READ_REPAIR_CHANCE: NumericField = NumericField('cassandraTableReadRepairChance', 'cassandraTableReadRepairChance')
class-attribute
¶
Read repair chance for the CassandraTable.
CASSANDRA_TABLE_SPECULATIVE_RETRY: KeywordField = KeywordField('cassandraTableSpeculativeRetry', 'cassandraTableSpeculativeRetry')
class-attribute
¶
Speculative retry setting for the CassandraTable.
CASSANDRA_TABLE_VIRTUAL: BooleanField = BooleanField('cassandraTableVirtual', 'cassandraTableVirtual')
class-attribute
¶
Indicates whether the CassandraTable is virtual.
CassandraView¶
pyatlan.model.assets.cassandra_view.CassandraView(__pydantic_self__, **data: Any)
¶
Bases: Cassandra
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
CASSANDRA_COLUMNS: RelationField = RelationField('cassandraColumns')
class-attribute
¶
TBC
CASSANDRA_KEYSPACE: RelationField = RelationField('cassandraKeyspace')
class-attribute
¶
TBC
CASSANDRA_VIEW_BLOOM_FILTER_FP_CHANCE: NumericField = NumericField('cassandraViewBloomFilterFPChance', 'cassandraViewBloomFilterFPChance')
class-attribute
¶
False positive chance for the Bloom filter in the CassandraView.
CASSANDRA_VIEW_CACHING: KeywordField = KeywordField('cassandraViewCaching', 'cassandraViewCaching')
class-attribute
¶
Caching configuration in the CassandraView.
CASSANDRA_VIEW_COMMENT: KeywordField = KeywordField('cassandraViewComment', 'cassandraViewComment')
class-attribute
¶
Comment describing the CassandraView.
CASSANDRA_VIEW_COMPACTION: KeywordField = KeywordField('cassandraViewCompaction', 'cassandraViewCompaction')
class-attribute
¶
Compaction for the CassandraView.
CASSANDRA_VIEW_CRC_CHECK_CHANCE: NumericField = NumericField('cassandraViewCRCCheckChance', 'cassandraViewCRCCheckChance')
class-attribute
¶
CRC check chance for the CassandraView.
CASSANDRA_VIEW_DC_LOCAL_READ_REPAIR_CHANCE: NumericField = NumericField('cassandraViewDCLocalReadRepairChance', 'cassandraViewDCLocalReadRepairChance')
class-attribute
¶
DC-local read repair chance for the CassandraView.
CASSANDRA_VIEW_DEFAULT_TTL: NumericField = NumericField('cassandraViewDefaultTTL', 'cassandraViewDefaultTTL')
class-attribute
¶
Default time-to-live (TTL) for the CassandraView.
CASSANDRA_VIEW_GC_GRACE_SECONDS: NumericField = NumericField('cassandraViewGCGraceSeconds', 'cassandraViewGCGraceSeconds')
class-attribute
¶
Grace period for garbage collection in the CassandraView.
CASSANDRA_VIEW_INCLUDE_ALL_COLUMNS: BooleanField = BooleanField('cassandraViewIncludeAllColumns', 'cassandraViewIncludeAllColumns')
class-attribute
¶
Whether to include all columns in the CassandraView.
CASSANDRA_VIEW_MAX_INDEX_INTERVAL: NumericField = NumericField('cassandraViewMaxIndexInterval', 'cassandraViewMaxIndexInterval')
class-attribute
¶
Maximum index interval for the CassandraView.
CASSANDRA_VIEW_MEMBTABLE_FLUSH_PERIOD_IN_MS: NumericField = NumericField('cassandraViewMembtableFlushPeriodInMS', 'cassandraViewMembtableFlushPeriodInMS')
class-attribute
¶
Memtable flush period (in milliseconds) for the CassandraView.
CASSANDRA_VIEW_MIN_INDEX_INTERVAL: NumericField = NumericField('cassandraViewMinIndexInterval', 'cassandraViewMinIndexInterval')
class-attribute
¶
Minimum index interval for the CassandraView.
CASSANDRA_VIEW_QUERY: KeywordField = KeywordField('cassandraViewQuery', 'cassandraViewQuery')
class-attribute
¶
Query used in the CassandraView.
CASSANDRA_VIEW_READ_REPAIR_INTERVAL: NumericField = NumericField('cassandraViewReadRepairInterval', 'cassandraViewReadRepairInterval')
class-attribute
¶
Read repair interval for the CassandraView.
CASSANDRA_VIEW_SPECULATIVE_RETRY: KeywordField = KeywordField('cassandraViewSpeculativeRetry', 'cassandraViewSpeculativeRetry')
class-attribute
¶
SpeculativeRetry setting for the CassandraView.
CASSANDRA_VIEW_TABLE_ID: KeywordField = KeywordField('cassandraViewTableId', 'cassandraViewTableId')
class-attribute
¶
ID of the base table in the CassandraView.
CASSANDRA_VIEW_WHERE_CLAUSE: KeywordField = KeywordField('cassandraViewWhereClause', 'cassandraViewWhereClause')
class-attribute
¶
Where clause used for the CassandraView query.
CassandraColumn¶
pyatlan.model.assets.cassandra_column.CassandraColumn(__pydantic_self__, **data: Any)
¶
Bases: Cassandra
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
CASSANDRA_COLUMN_CLUSTERING_ORDER: KeywordField = KeywordField('cassandraColumnClusteringOrder', 'cassandraColumnClusteringOrder')
class-attribute
¶
Clustering order of the CassandraColumn.
CASSANDRA_COLUMN_IS_CLUSTERING_KEY: BooleanField = BooleanField('cassandraColumnIsClusteringKey', 'cassandraColumnIsClusteringKey')
class-attribute
¶
Is the CassandraColumn clustering key.
CASSANDRA_COLUMN_IS_PARTITION_KEY: BooleanField = BooleanField('cassandraColumnIsPartitionKey', 'cassandraColumnIsPartitionKey')
class-attribute
¶
Is the CassandraColumn partition key.
CASSANDRA_COLUMN_IS_STATIC: BooleanField = BooleanField('cassandraColumnIsStatic', 'cassandraColumnIsStatic')
class-attribute
¶
Indicates whether the CassandraColumn is static.
CASSANDRA_COLUMN_KIND: KeywordField = KeywordField('cassandraColumnKind', 'cassandraColumnKind')
class-attribute
¶
Kind of CassandraColumn (e.g. partition key, clustering column, etc).
CASSANDRA_COLUMN_POSITION: NumericField = NumericField('cassandraColumnPosition', 'cassandraColumnPosition')
class-attribute
¶
Position of the CassandraColumn.
CASSANDRA_COLUMN_TYPE: KeywordTextField = KeywordTextField('cassandraColumnType', 'cassandraColumnType.keyword', 'cassandraColumnType')
class-attribute
¶
Type of the CassandraColumn.
CASSANDRA_TABLE: RelationField = RelationField('cassandraTable')
class-attribute
¶
TBC
CASSANDRA_VIEW: RelationField = RelationField('cassandraView')
class-attribute
¶
TBC
CassandraIndex¶
pyatlan.model.assets.cassandra_index.CassandraIndex(__pydantic_self__, **data: Any)
¶
Bases: Cassandra
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
CASSANDRA_INDEX_KIND: KeywordField = KeywordField('cassandraIndexKind', 'cassandraIndexKind')
class-attribute
¶
Kind of index (e.g. COMPOSITES).
CASSANDRA_INDEX_OPTIONS: KeywordField = KeywordField('cassandraIndexOptions', 'cassandraIndexOptions')
class-attribute
¶
Options for the index.
CASSANDRA_INDEX_QUERY: KeywordField = KeywordField('cassandraIndexQuery', 'cassandraIndexQuery')
class-attribute
¶
Query used to create the index.
CASSANDRA_TABLE: RelationField = RelationField('cassandraTable')
class-attribute
¶
TBC
CassandraKeyspace¶
pyatlan.model.assets.cassandra_keyspace.CassandraKeyspace(__pydantic_self__, **data: Any)
¶
Bases: Cassandra
Description
Source code in pyatlan/model/assets/core/referenceable.py
Attributes¶
CASSANDRA_KEYSPACE_DURABLE_WRITES: BooleanField = BooleanField('cassandraKeyspaceDurableWrites', 'cassandraKeyspaceDurableWrites')
class-attribute
¶
Indicates whether durable writes are enabled for the CassandraKeyspace.
CASSANDRA_KEYSPACE_QUERY: KeywordField = KeywordField('cassandraKeyspaceQuery', 'cassandraKeyspaceQuery')
class-attribute
¶
Query associated with the CassandraKeyspace.
CASSANDRA_KEYSPACE_REPLICATION: KeywordField = KeywordField('cassandraKeyspaceReplication', 'cassandraKeyspaceReplication')
class-attribute
¶
Replication class for the CassandraKeyspace.
CASSANDRA_KEYSPACE_VIRTUAL: BooleanField = BooleanField('cassandraKeyspaceVirtual', 'cassandraKeyspaceVirtual')
class-attribute
¶
Indicates whether the CassandraKeyspace is virtual.
CASSANDRA_TABLES: RelationField = RelationField('cassandraTables')
class-attribute
¶
TBC
CASSANDRA_VIEWS: RelationField = RelationField('cassandraViews')
class-attribute
¶
TBC