Skip to content

StorageDescriptor

Source code in docs_src/capo_glue/types/storage_descriptor.py
class StorageDescriptor(TypedDict, closed=True):
    columns: NotRequired["capo_glue.types.column_list.ColumnList"]
    """<p>A list of the <code>Columns</code> in the table.</p>"""
    location: NotRequired["capo_glue.types.location_string.LocationString"]
    """<p>The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.</p>"""
    additional_locations: NotRequired[
        "capo_glue.types.location_string_list.LocationStringList"
    ]
    """<p>A list of locations that point to the path where a Delta table is located.</p>"""
    input_format: NotRequired["capo_glue.types.format_string.FormatString"]
    """<p>The input format: <code>SequenceFileInputFormat</code> (binary), or <code>TextInputFormat</code>, or a custom format.</p>"""
    output_format: NotRequired["capo_glue.types.format_string.FormatString"]
    """<p>The output format: <code>SequenceFileOutputFormat</code> (binary), or <code>IgnoreKeyTextOutputFormat</code>, or a custom format.</p>"""
    compressed: "capo_glue.types.boolean.Boolean"
    """<p> <code>True</code> if the data in the table is compressed, or <code>False</code> if not.</p>"""
    number_of_buckets: "capo_glue.types.integer.Integer"
    """<p>Must be specified if the table contains any dimension columns.</p>"""
    serde_info: NotRequired["capo_glue.types.ser_de_info.SerDeInfo"]
    """<p>The serialization/deserialization (SerDe) information.</p>"""
    bucket_columns: NotRequired["capo_glue.types.name_string_list.NameStringList"]
    """<p>A list of reducer grouping columns, clustering columns, and bucketing columns in the table.</p>"""
    sort_columns: NotRequired["capo_glue.types.order_list.OrderList"]
    """<p>A list specifying the sort order of each bucket in the table.</p>"""
    parameters: NotRequired["capo_glue.types.parameters_map.ParametersMap"]
    """<p>The user-supplied properties in key-value form.</p>"""
    skewed_info: NotRequired["capo_glue.types.skewed_info.SkewedInfo"]
    """<p>The information about values that appear frequently in a column (skewed values).</p>"""
    stored_as_sub_directories: "capo_glue.types.boolean.Boolean"
    """<p> <code>True</code> if the table data is stored in subdirectories, or <code>False</code> if not.</p>"""
    schema_reference: NotRequired["capo_glue.types.schema_reference.SchemaReference"]
    """<p>An object that references a schema stored in the Glue Schema Registry.</p> <p>When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.</p>"""

additional_locations instance-attribute

additional_locations: NotRequired[LocationStringList]

A list of locations that point to the path where a Delta table is located.

bucket_columns instance-attribute

bucket_columns: NotRequired[NameStringList]

A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

columns instance-attribute

columns: NotRequired[ColumnList]

A list of the Columns in the table.

compressed instance-attribute

compressed: Boolean

True if the data in the table is compressed, or False if not.

input_format instance-attribute

input_format: NotRequired[FormatString]

The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

location instance-attribute

location: NotRequired[LocationString]

The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

number_of_buckets instance-attribute

number_of_buckets: Integer

Must be specified if the table contains any dimension columns.

output_format instance-attribute

output_format: NotRequired[FormatString]

The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

parameters instance-attribute

parameters: NotRequired[ParametersMap]

The user-supplied properties in key-value form.

schema_reference instance-attribute

schema_reference: NotRequired[SchemaReference]

An object that references a schema stored in the Glue Schema Registry.

When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

serde_info instance-attribute

serde_info: NotRequired[SerDeInfo]

The serialization/deserialization (SerDe) information.

skewed_info instance-attribute

skewed_info: NotRequired[SkewedInfo]

The information about values that appear frequently in a column (skewed values).

sort_columns instance-attribute

sort_columns: NotRequired[OrderList]

A list specifying the sort order of each bucket in the table.

stored_as_sub_directories instance-attribute

stored_as_sub_directories: Boolean

True if the table data is stored in subdirectories, or False if not.