ORIONIS API REFERENCE

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

orionis.orm.schema.column.ColumnOptions

class documentation

class ColumnOptions: (source)

View In Hierarchy

Secondary, type-specific knobs mirroring SQLAlchemy constructor args.

A single options object keeps ColumnDefinition constructible with a handful of parameters while still exposing every keyword that the equivalent SQLAlchemy Core type accepts, one attribute per keyword.

Instance Variable as_decimal Whether numeric values are returned as Decimal.
Instance Variable as_tuple Whether array results are converted to tuples.
Instance Variable as_uuid Whether UUID values are interpreted as uuid.UUID objects.
Instance Variable collation Column-level collation for string columns.
Instance Variable comparator Predicate used to compare pickled values for equality.
Instance Variable constraint_name Explicit name for the generated CHECK constraint.
Instance Variable create_constraint Whether to add a CHECK constraint for non-native enum/boolean.
Instance Variable day_precision Day precision for native interval columns.
Instance Variable decimal_return_scale Default scale applied when converting floats to decimals.
Instance Variable dimensions Fixed number of dimensions for array columns.
Instance Variable enum_name Name of the enumerated database type, when applicable.
Instance Variable enum_values Allowed values for enum columns.
Instance Variable impl Binary-storing type used in place of the default.
Instance Variable item_type Element type declaration for array columns.
Instance Variable length Maximum length for string-like or binary columns.
Instance Variable native Whether to use the backend's native INTERVAL type.
Instance Variable native_enum Whether to use the backend's native ENUM type.
Instance Variable native_uuid Whether to use the backend's native UUID-storing type.
Instance Variable none_as_null Whether None persists as SQL NULL in JSON columns.
Instance Variable pickler Object exposing dumps/loads, defaults to pickle.
Instance Variable precision Total digits for numeric/decimal columns.
Instance Variable protocol Pickle protocol used by pickle-backed columns.
Instance Variable scale Decimal digits for numeric/decimal columns.
Instance Variable second_precision Fractional seconds precision for native interval columns.
Instance Variable timezone Whether the datetime column is timezone-aware.
Instance Variable validate_strings Whether to validate string values against enum members.
Instance Variable zero_indexes Whether array indexes convert between zero- and one-based conventions.
as_decimal: bool = (source)

Whether numeric values are returned as Decimal.

as_tuple: bool = (source)

Whether array results are converted to tuples.

as_uuid: bool = (source)

Whether UUID values are interpreted as uuid.UUID objects.

collation: str or None = (source)

Column-level collation for string columns.

comparator: Callable or None = (source)

Predicate used to compare pickled values for equality.

constraint_name: str or None = (source)

Explicit name for the generated CHECK constraint.

create_constraint: bool = (source)

Whether to add a CHECK constraint for non-native enum/boolean.

day_precision: int or None = (source)

Day precision for native interval columns.

decimal_return_scale: int or None = (source)

Default scale applied when converting floats to decimals.

dimensions: int or None = (source)

Fixed number of dimensions for array columns.

enum_name: str or None = (source)

Name of the enumerated database type, when applicable.

enum_values: tuple of str = (source)

Allowed values for enum columns.

impl: object or None = (source)

Binary-storing type used in place of the default.

item_type: ColumnDefinition or None = (source)

Element type declaration for array columns.

length: int or None = (source)

Maximum length for string-like or binary columns.

native: bool = (source)

Whether to use the backend's native INTERVAL type.

native_enum: bool = (source)

Whether to use the backend's native ENUM type.

native_uuid: bool = (source)

Whether to use the backend's native UUID-storing type.

none_as_null: bool = (source)

Whether None persists as SQL NULL in JSON columns.

pickler: object or None = (source)

Object exposing dumps/loads, defaults to pickle.

precision: int or None = (source)

Total digits for numeric/decimal columns.

protocol: int = (source)

Pickle protocol used by pickle-backed columns.

scale: int or None = (source)

Decimal digits for numeric/decimal columns.

second_precision: int or None = (source)

Fractional seconds precision for native interval columns.

timezone: bool = (source)

Whether the datetime column is timezone-aware.

validate_strings: bool = (source)

Whether to validate string values against enum members.

zero_indexes: bool = (source)

Whether array indexes convert between zero- and one-based conventions.