Skip to content

Table

Source code in docs_src/capo_glue/types/table.py
class Table(TypedDict, closed=True):
    name: "capo_glue.types.name_string.NameString"
    """<p>The table name. For Hive compatibility, this must be entirely lowercase.</p>"""
    database_name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.</p>"""
    description: NotRequired["capo_glue.types.description_string.DescriptionString"]
    """<p>A description of the table.</p>"""
    owner: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The owner of the table.</p>"""
    create_time: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The time when the table definition was created in the Data Catalog.</p>"""
    update_time: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The last time that the table was updated.</p>"""
    last_access_time: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.</p>"""
    last_analyzed_time: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The last time that column statistics were computed for this table.</p>"""
    retention: "capo_glue.types.non_negative_integer.NonNegativeInteger"
    """<p>The retention time for this table.</p>"""
    storage_descriptor: NotRequired[
        "capo_glue.types.storage_descriptor.StorageDescriptor"
    ]
    """<p>A storage descriptor containing information about the physical storage of this table.</p>"""
    partition_keys: NotRequired["capo_glue.types.column_list.ColumnList"]
    """<p>A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.</p> <p>When you create a table used by Amazon Athena, and you do not specify any <code>partitionKeys</code>, you must at least set the value of <code>partitionKeys</code> to an empty list. For example:</p> <p> <code>"PartitionKeys": []</code> </p>"""
    view_original_text: NotRequired["capo_glue.types.view_text_string.ViewTextString"]
    """<p>Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a <code>VIRTUAL_VIEW</code>, certain Athena configuration encoded in base64.</p>"""
    view_expanded_text: NotRequired["capo_glue.types.view_text_string.ViewTextString"]
    """<p>Included for Apache Hive compatibility. Not used in the normal course of Glue operations.</p>"""
    table_type: NotRequired["capo_glue.types.table_type_string.TableTypeString"]
    """<p>The type of this table. Glue will create tables with the <code>EXTERNAL_TABLE</code> type. Other services, such as Athena, may create tables with additional table types. </p> <p>Glue related table types:</p> <dl> <dt>EXTERNAL_TABLE</dt> <dd> <p>Hive compatible attribute - indicates a non-Hive managed table.</p> </dd> <dt>GOVERNED</dt> <dd> <p>Used by Lake Formation. The Glue Data Catalog understands <code>GOVERNED</code>.</p> </dd> </dl>"""
    parameters: NotRequired["capo_glue.types.parameters_map.ParametersMap"]
    """<p>These key-value pairs define properties associated with the table.</p>"""
    created_by: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The person or entity who created the table.</p>"""
    is_registered_with_lake_formation: "capo_glue.types.boolean.Boolean"
    """<p>Indicates whether the table has been registered with Lake Formation.</p>"""
    target_table: NotRequired["capo_glue.types.table_identifier.TableIdentifier"]
    """<p>A <code>TableIdentifier</code> structure that describes a target table for resource linking.</p>"""
    catalog_id: NotRequired["capo_glue.types.catalog_id_string.CatalogIdString"]
    """<p>The ID of the Data Catalog in which the table resides.</p>"""
    version_id: NotRequired["capo_glue.types.version_string.VersionString"]
    """<p>The ID of the table version.</p>"""
    federated_table: NotRequired["capo_glue.types.federated_table.FederatedTable"]
    """<p>A <code>FederatedTable</code> structure that references an entity outside the Glue Data Catalog.</p>"""
    view_definition: NotRequired["capo_glue.types.view_definition.ViewDefinition"]
    """<p>A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.</p>"""
    is_multi_dialect_view: NotRequired[
        "capo_glue.types.nullable_boolean.NullableBoolean"
    ]
    """<p>Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.</p>"""
    is_materialized_view: NotRequired[
        "capo_glue.types.nullable_boolean.NullableBoolean"
    ]
    """<p>Indicates a table is a <code>MaterializedView</code>.</p>"""
    iceberg_table_metadata: NotRequired[
        "capo_glue.types.iceberg_table_metadata.IcebergTableMetadata"
    ]
    """<p>The latest Apache Iceberg table metadata for the table, including format version, schemas, partition specifications, and sort orders. This field is populated for Iceberg tables and reflects the current state of the table's Iceberg metadata.</p>"""
    status: NotRequired["capo_glue.types.table_status.TableStatus"]
    """<p>Indicates the the state of an asynchronous change to a table.</p>"""
    rls_properties: NotRequired["capo_glue.types.rls_properties.RLSProperties"]
    """<p>A <code>RLSProperties</code> structure that describes the default row-level security policy of the table.</p>"""

catalog_id instance-attribute

catalog_id: NotRequired[CatalogIdString]

The ID of the Data Catalog in which the table resides.

create_time instance-attribute

create_time: NotRequired[Timestamp]

The time when the table definition was created in the Data Catalog.

created_by instance-attribute

created_by: NotRequired[NameString]

The person or entity who created the table.

database_name instance-attribute

database_name: NotRequired[NameString]

The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.

description instance-attribute

description: NotRequired[DescriptionString]

A description of the table.

federated_table instance-attribute

federated_table: NotRequired[FederatedTable]

A FederatedTable structure that references an entity outside the Glue Data Catalog.

iceberg_table_metadata instance-attribute

iceberg_table_metadata: NotRequired[IcebergTableMetadata]

The latest Apache Iceberg table metadata for the table, including format version, schemas, partition specifications, and sort orders. This field is populated for Iceberg tables and reflects the current state of the table's Iceberg metadata.

is_materialized_view instance-attribute

is_materialized_view: NotRequired[NullableBoolean]

Indicates a table is a MaterializedView.

is_multi_dialect_view instance-attribute

is_multi_dialect_view: NotRequired[NullableBoolean]

Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.

is_registered_with_lake_formation instance-attribute

is_registered_with_lake_formation: Boolean

Indicates whether the table has been registered with Lake Formation.

last_access_time instance-attribute

last_access_time: NotRequired[Timestamp]

The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.

last_analyzed_time instance-attribute

last_analyzed_time: NotRequired[Timestamp]

The last time that column statistics were computed for this table.

name instance-attribute

name: NameString

The table name. For Hive compatibility, this must be entirely lowercase.

owner instance-attribute

owner: NotRequired[NameString]

The owner of the table.

parameters instance-attribute

parameters: NotRequired[ParametersMap]

These key-value pairs define properties associated with the table.

partition_keys instance-attribute

partition_keys: NotRequired[ColumnList]

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

"PartitionKeys": []

retention instance-attribute

retention: NonNegativeInteger

The retention time for this table.

rls_properties instance-attribute

rls_properties: NotRequired[RLSProperties]

A RLSProperties structure that describes the default row-level security policy of the table.

status instance-attribute

status: NotRequired[TableStatus]

Indicates the the state of an asynchronous change to a table.

storage_descriptor instance-attribute

storage_descriptor: NotRequired[StorageDescriptor]

A storage descriptor containing information about the physical storage of this table.

table_type instance-attribute

table_type: NotRequired[TableTypeString]

The type of this table. Glue will create tables with the EXTERNAL_TABLE type. Other services, such as Athena, may create tables with additional table types.

Glue related table types:

EXTERNAL_TABLE

Hive compatible attribute - indicates a non-Hive managed table.

GOVERNED

Used by Lake Formation. The Glue Data Catalog understands GOVERNED.

target_table instance-attribute

target_table: NotRequired[TableIdentifier]

A TableIdentifier structure that describes a target table for resource linking.

update_time instance-attribute

update_time: NotRequired[Timestamp]

The last time that the table was updated.

version_id instance-attribute

version_id: NotRequired[VersionString]

The ID of the table version.

view_definition instance-attribute

view_definition: NotRequired[ViewDefinition]

A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.

view_expanded_text instance-attribute

view_expanded_text: NotRequired[ViewTextString]

Included for Apache Hive compatibility. Not used in the normal course of Glue operations.

view_original_text instance-attribute

view_original_text: NotRequired[ViewTextString]

Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a VIRTUAL_VIEW, certain Athena configuration encoded in base64.