orionis.orm.schema.types.Boolean

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.

class documentation

class Boolean(ColumnDefinition): (source)

A bool datatype, typically BOOLEAN or SMALLINT in DDL.

Method	`__init__`	Construct a Boolean.
Class Variable	`__slots__`	Undocumented

def __init__(self, *, create_constraint: bool = False, name: str | None = None): (source) ¶

Construct a Boolean.

Parameters
create_constraint:`bool, optional`	When the boolean is emulated as int/smallint, also create a CHECK constraint ensuring 1 or 0 as a value.
name:`str or None, optional`	Name of the CHECK constraint, when generated.

Returns
`None`	This method does not return a value.

Undocumented