MongoDBCollection¶
- class pyatlan.model.assets.MongoDBCollection(*, typeName: str = 'MongoDBCollection', attributes: MongoDBCollection.Attributes = None, businessAttributes: Dict[str, Any] | None = None, createdBy: str | None = None, createTime: int | None = None, deleteHandler: str | None = None, guid: str = None, isIncomplete: bool | None = None, labels: List[str] | None = None, relationshipAttributes: RelationshipAttributes | Dict[str, Any] | None = None, status: EntityStatus | None = None, updatedBy: str | None = None, updateTime: int | None = None, version: int | None = None, classifications: List[AtlanTag] | None = None, classificationNames: List[str] | None = None, displayText: str | None = None, entityStatus: str | None = None, relationshipGuid: str | None = None, relationshipStatus: str | None = None, relationshipType: str | None = None, meaningNames: List[str] | None = None, meanings: List[Meaning] | None = None, customAttributes: Dict[str, Any] | None = None, scrubbed: bool | None = None, pendingTasks: List[str] | None = None, uniqueAttributes: Dict[str, Any] | None = None, appendRelationshipAttributes: Dict[str, Any] | None = None, removeRelationshipAttributes: Dict[str, Any] | None = None, addOrUpdateClassifications: List[AtlanTag] | None = None, removeClassifications: List[AtlanTag] | None = None, semantic: SaveSemantic | None = None, depth: int | None = None, immediateUpstream: List[LineageRef] | None = None, immediateDownstream: List[LineageRef] | None = None)[source]¶
Description
- ALIAS: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>¶
Alias for this table.
- CALCULATION_VIEW_NAME: ClassVar[KeywordTextField] = <pyatlan.model.fields.atlan_fields.KeywordTextField object>¶
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: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
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: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Number of columns in this table.
- DATABASE_NAME: ClassVar[KeywordTextField] = <pyatlan.model.fields.atlan_fields.KeywordTextField object>¶
Simple name of the database in which this SQL asset exists, or empty if it does not exist within a database.
- DATABASE_QUALIFIED_NAME: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Unique name of the database in which this SQL asset exists, or empty if it does not exist within a database.
- EXTERNAL_LOCATION: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>¶
External location of this table, for example: an S3 object location.
- EXTERNAL_LOCATION_FORMAT: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Format of the external location of this table, for example: JSON, CSV, PARQUET, etc.
- EXTERNAL_LOCATION_REGION: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>¶
Region of the external location of this table, for example: S3 region.
- ICEBERG_CATALOG_NAME: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Iceberg table catalog name (can be any user defined name)
- ICEBERG_CATALOG_SOURCE: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Iceberg table catalog type (glue, polaris, snowflake)
- ICEBERG_CATALOG_TABLE_NAME: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Catalog table name (actual table name on the catalog side).
- ICEBERG_CATALOG_TABLE_NAMESPACE: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Catalog table namespace (actual database name on the catalog side).
- ICEBERG_TABLE_BASE_LOCATION: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Iceberg table base location inside the external volume.
- ICEBERG_TABLE_TYPE: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Iceberg table type (managed vs unmanaged)
- IS_PARTITIONED: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶
Whether this table is partitioned (true) or not (false).
- IS_PROFILED: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶
Whether this asset has been profiled (true) or not (false).
- IS_QUERY_PREVIEW: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶
Whether preview queries are allowed for this table (true) or not (false).
- IS_SHARDED: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶
Whether this table is a sharded table (true) or not (false).
- IS_TEMPORARY: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶
Whether this table is temporary (true) or not (false).
- LAST_PROFILED_AT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Time (epoch) at which this asset was last profiled, in milliseconds.
- MONGO_DB_COLLECTION_AVERAGE_OBJECT_SIZE: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Average size of an object in the collection.
- MONGO_DB_COLLECTION_EXPIRE_AFTER_SECONDS: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Seconds after which documents in a time series collection or clustered collection expire.
- MONGO_DB_COLLECTION_IS_CAPPED: ClassVar[BooleanField] = <pyatlan.model.fields.atlan_fields.BooleanField object>¶
Whether the collection is capped (true) or not (false).
- MONGO_DB_COLLECTION_MAXIMUM_DOCUMENT_COUNT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Maximum number of documents allowed in a capped collection.
- MONGO_DB_COLLECTION_MAX_SIZE: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Maximum size allowed in a capped collection.
- MONGO_DB_COLLECTION_NUM_INDEXES: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Number of indexes on the collection.
- MONGO_DB_COLLECTION_NUM_ORPHAN_DOCS: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Number of orphaned documents in the collection.
- MONGO_DB_COLLECTION_SCHEMA_DEFINITION: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>¶
Definition of the schema applicable for the collection.
- MONGO_DB_COLLECTION_SUBTYPE: ClassVar[KeywordTextField] = <pyatlan.model.fields.atlan_fields.KeywordTextField object>¶
Subtype of a MongoDB collection, for example: Capped, Time Series, etc.
- MONGO_DB_COLLECTION_TIME_FIELD: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>¶
Name of the field containing the date in each time series document.
- MONGO_DB_COLLECTION_TIME_GRANULARITY: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Closest match to the time span between consecutive incoming measurements.
- MONGO_DB_COLLECTION_TOTAL_INDEX_SIZE: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Total size of all indexes.
- MONGO_DB_DATABASE: ClassVar[RelationField] = <pyatlan.model.fields.atlan_fields.RelationField object>¶
TBC
- NO_SQL_SCHEMA_DEFINITION: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>¶
Represents attributes for describing the key schema for the table and indexes.
- PARTITION_COUNT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Number of partitions in this table.
- PARTITION_LIST: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>¶
List of partitions in this table.
- PARTITION_STRATEGY: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Partition strategy for this table.
- QUERY_COUNT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Number of times this asset has been queried.
- QUERY_COUNT_UPDATED_AT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Time (epoch) at which the query count was last updated, in milliseconds.
- QUERY_PREVIEW_CONFIG: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Configuration for preview queries.
- QUERY_USER_COUNT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Number of unique users who have queried this asset.
- QUERY_USER_MAP: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Map of unique users who have queried this asset to the number of times they have queried it.
- ROW_COUNT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Number of rows in this table.
- SCHEMA_NAME: ClassVar[KeywordTextField] = <pyatlan.model.fields.atlan_fields.KeywordTextField object>¶
Simple name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
- SCHEMA_QUALIFIED_NAME: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Unique name of the schema in which this SQL asset exists, or empty if it does not exist within a schema.
- SIZE_BYTES: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Size of this table, in bytes.
- TABLE_DEFINITION: ClassVar[TextField] = <pyatlan.model.fields.atlan_fields.TextField object>¶
Definition of the table.
- TABLE_EXTERNAL_VOLUME_NAME: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
External volume name for the table.
- TABLE_IMPALA_PARAMETERS: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Extra attributes for Impala
- TABLE_NAME: ClassVar[KeywordTextField] = <pyatlan.model.fields.atlan_fields.KeywordTextField object>¶
Simple name of the table in which this SQL asset exists, or empty if it does not exist within a table.
- TABLE_OBJECT_COUNT: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Number of objects in this table.
- TABLE_QUALIFIED_NAME: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Unique name of the table in which this SQL asset exists, or empty if it does not exist within a table.
- TABLE_RETENTION_TIME: ClassVar[NumericField] = <pyatlan.model.fields.atlan_fields.NumericField object>¶
Data retention time in days.
- TABLE_TYPE: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Type of the table.
- VIEW_NAME: ClassVar[KeywordTextField] = <pyatlan.model.fields.atlan_fields.KeywordTextField object>¶
Simple name of the view in which this SQL asset exists, or empty if it does not exist within a view.
- VIEW_QUALIFIED_NAME: ClassVar[KeywordField] = <pyatlan.model.fields.atlan_fields.KeywordField object>¶
Unique name of the view in which this SQL asset exists, or empty if it does not exist within a view.