Skip to content

ColumnMetadata

Source code in docs_src/capo_rds_data/types/column_metadata.py
class ColumnMetadata(TypedDict, closed=True):
    name: NotRequired["capo_rds_data.types.string.String"]
    """<p>The name of the column.</p>"""
    type: "capo_rds_data.types.integer.Integer"
    """<p>The type of the column.</p>"""
    type_name: NotRequired["capo_rds_data.types.string.String"]
    """<p>The database-specific data type of the column.</p>"""
    label: NotRequired["capo_rds_data.types.string.String"]
    """<p>The label for the column.</p>"""
    schema_name: NotRequired["capo_rds_data.types.string.String"]
    """<p>The name of the schema that owns the table that includes the column.</p>"""
    table_name: NotRequired["capo_rds_data.types.string.String"]
    """<p>The name of the table that includes the column.</p>"""
    is_auto_increment: "capo_rds_data.types.boolean.Boolean"
    """<p>A value that indicates whether the column increments automatically.</p>"""
    is_signed: "capo_rds_data.types.boolean.Boolean"
    """<p>A value that indicates whether an integer column is signed.</p>"""
    is_currency: "capo_rds_data.types.boolean.Boolean"
    """<p>A value that indicates whether the column contains currency values.</p>"""
    is_case_sensitive: "capo_rds_data.types.boolean.Boolean"
    """<p>A value that indicates whether the column is case-sensitive.</p>"""
    nullable: "capo_rds_data.types.integer.Integer"
    """<p>A value that indicates whether the column is nullable.</p>"""
    precision: "capo_rds_data.types.integer.Integer"
    """<p>The precision value of a decimal number column.</p>"""
    scale: "capo_rds_data.types.integer.Integer"
    """<p>The scale value of a decimal number column.</p>"""
    array_base_column_type: "capo_rds_data.types.integer.Integer"
    """<p>The type of the column.</p>"""

array_base_column_type instance-attribute

array_base_column_type: Integer

The type of the column.

is_auto_increment instance-attribute

is_auto_increment: Boolean

A value that indicates whether the column increments automatically.

is_case_sensitive instance-attribute

is_case_sensitive: Boolean

A value that indicates whether the column is case-sensitive.

is_currency instance-attribute

is_currency: Boolean

A value that indicates whether the column contains currency values.

is_signed instance-attribute

is_signed: Boolean

A value that indicates whether an integer column is signed.

label instance-attribute

label: NotRequired[String]

The label for the column.

name instance-attribute

name: NotRequired[String]

The name of the column.

nullable instance-attribute

nullable: Integer

A value that indicates whether the column is nullable.

precision instance-attribute

precision: Integer

The precision value of a decimal number column.

scale instance-attribute

scale: Integer

The scale value of a decimal number column.

schema_name instance-attribute

schema_name: NotRequired[String]

The name of the schema that owns the table that includes the column.

table_name instance-attribute

table_name: NotRequired[String]

The name of the table that includes the column.

type instance-attribute

type: Integer

The type of the column.

type_name instance-attribute

type_name: NotRequired[String]

The database-specific data type of the column.