Skip to content

TableInput

Source code in docs_src/capo_glue/types/table_input.py
class TableInput(TypedDict, closed=True):
    name: "capo_glue.types.name_string.NameString"
    """<p>The table name. For Hive compatibility, this is folded to lowercase when it is stored.</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 table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.</p>"""
    last_access_time: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The last time that the table was accessed.</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>"""
    target_table: NotRequired["capo_glue.types.table_identifier.TableIdentifier"]
    """<p>A <code>TableIdentifier</code> structure that describes a target table for resource linking.</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. Specify this field to create a federated table, which points to a table in an external metastore instead of describing data managed in the Glue Data Catalog.</p>"""
    view_definition: NotRequired[
        "capo_glue.types.view_definition_input.ViewDefinitionInput"
    ]
    """<p>A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.</p>"""

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. Specify this field to create a federated table, which points to a table in an external metastore instead of describing data managed in the Glue Data Catalog.

last_access_time instance-attribute

last_access_time: NotRequired[Timestamp]

The last time that the table was accessed.

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 is folded to lowercase when it is stored.

owner instance-attribute

owner: NotRequired[NameString]

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

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.

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.

view_definition instance-attribute

view_definition: NotRequired[ViewDefinitionInput]

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.