Skip to content

ColumnInfo

Source code in docs_src/capo_athena/types/column_info.py
class ColumnInfo(TypedDict, closed=True):
    catalog_name: NotRequired["capo_athena.types.string.String"]
    """<p>The catalog to which the query results belong.</p>"""
    schema_name: NotRequired["capo_athena.types.string.String"]
    """<p>The schema name (database name) to which the query results belong.</p>"""
    table_name: NotRequired["capo_athena.types.string.String"]
    """<p>The table name for the query results.</p>"""
    name: "capo_athena.types.string.String"
    """<p>The name of the column.</p>"""
    label: NotRequired["capo_athena.types.string.String"]
    """<p>A column label.</p>"""
    type: "capo_athena.types.string.String"
    """<p>The data type of the column.</p>"""
    precision: "capo_athena.types.integer.Integer"
    """<p>For <code>DECIMAL</code> data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.</p>"""
    scale: "capo_athena.types.integer.Integer"
    """<p>For <code>DECIMAL</code> data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.</p>"""
    nullable: NotRequired["capo_athena.types.column_nullable.ColumnNullable"]
    """<p>Unsupported constraint. This value always shows as <code>UNKNOWN</code>.</p>"""
    case_sensitive: "capo_athena.types.boolean.Boolean"
    """<p>Indicates whether values in the column are case-sensitive.</p>"""

case_sensitive instance-attribute

case_sensitive: Boolean

Indicates whether values in the column are case-sensitive.

catalog_name instance-attribute

catalog_name: NotRequired[String]

The catalog to which the query results belong.

label instance-attribute

label: NotRequired[String]

A column label.

name instance-attribute

name: String

The name of the column.

nullable instance-attribute

nullable: NotRequired[ColumnNullable]

Unsupported constraint. This value always shows as UNKNOWN.

precision instance-attribute

precision: Integer

For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.

scale instance-attribute

scale: Integer

For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.

schema_name instance-attribute

schema_name: NotRequired[String]

The schema name (database name) to which the query results belong.

table_name instance-attribute

table_name: NotRequired[String]

The table name for the query results.

type instance-attribute

type: String

The data type of the column.