Class tigrbl.column.storage_spec.StorageSpec

tigrbl.column.storage_spec.StorageSpec dataclass

StorageSpec(
    type_=None,
    *,
    nullable=None,
    unique=False,
    index=False,
    primary_key=False,
    autoincrement=None,
    default=None,
    onupdate=None,
    server_default=None,
    refresh_on_return=False,
    transform=None,
    fk=None,
    check=None,
    comment=None,
)

Describe the database-level shape and behaviour of a column.

The spec maps closely to SQLAlchemy's :class:~sqlalchemy.Column keyword arguments: type_ and flags such as nullable or primary_key define the table schema while default and onupdate represent ORM side defaults. server_default and refresh_on_return support database-generated values. Optional helpers provide value transforms, foreign keys, check constraints and comments.

type_ class-attribute instance-attribute

type_ = None

nullable class-attribute instance-attribute

nullable = None

unique class-attribute instance-attribute

unique = False

index class-attribute instance-attribute

index = False

primary_key class-attribute instance-attribute

primary_key = False

autoincrement class-attribute instance-attribute

autoincrement = None

default class-attribute instance-attribute

default = None

onupdate class-attribute instance-attribute

onupdate = None

server_default class-attribute instance-attribute

server_default = None

refresh_on_return class-attribute instance-attribute

refresh_on_return = False

transform class-attribute instance-attribute

transform = None

fk class-attribute instance-attribute

fk = None

check class-attribute instance-attribute

check = None

comment class-attribute instance-attribute

comment = None