Skip to content

SchemaDefinition

Used by
Source code in docs_src/capo_keyspaces/types/schema_definition.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class SchemaDefinition(TypedDict, closed=True):
    all_columns: "capo_keyspaces.types.column_definition_list.ColumnDefinitionList"
    """<p>The regular columns of the table.</p>"""
    partition_keys: "capo_keyspaces.types.partition_key_list.PartitionKeyList"
    """<p>The columns that are part of the partition key of the table .</p>"""
    clustering_keys: NotRequired[
        "capo_keyspaces.types.clustering_key_list.ClusteringKeyList"
    ]
    """<p>The columns that are part of the clustering key of the table.</p>"""
    static_columns: NotRequired[
        "capo_keyspaces.types.static_column_list.StaticColumnList"
    ]
    """<p>The columns that have been defined as <code>STATIC</code>. Static columns store values that are shared by all rows in the same partition.</p>"""

all_columns instance-attribute 

all_columns: ColumnDefinitionList

The regular columns of the table.

clustering_keys instance-attribute 

clustering_keys: NotRequired[ClusteringKeyList]

The columns that are part of the clustering key of the table.

partition_keys instance-attribute 

partition_keys: PartitionKeyList

The columns that are part of the partition key of the table .

static_columns instance-attribute 

static_columns: NotRequired[StaticColumnList]

The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition.