luminadb.column module

Column

class luminadb.column.BuilderColumn(_from_typelist: list[str] | None = None)

Bases: object

Builder Column – Column Implementation using Builder Column

allow_null()

Allow null

auto_increment() → Self

Enable auto increment for this column (only for integer).

default(default_value: Any)

Set default value

foreign(source: str) → Self

Set foreign reference

on_delete(action: Literal['null', 'cascade', 'no act', 'default', 'restrict'])

Set on delete action

on_update(action: Literal['null', 'cascade', 'no act', 'default', 'restrict'])

Set on update action

primary() → Self

Set primary

set_type(name: str) → Callable[[str], Self]

Set type from name, this will be handled by class’ type checking. This is a setup function. You need to do .set_type(type_name)(name) to do similiar effect to .integer(name) as for example

to_column()

Conver from BuilderColumn to Column

unique() → Self

Set unique

class luminadb.column.Column

Bases: object

tip: for foreign_ref, you can split with / to separate table and column name. e.g: user/id

property auto_increment

Auto increment enabled?

property default

Default value

property foreign

Is foreign enabled?

classmethod from_json(json: str)

Convert JSON to a column

property name

Column Name

property nullable

Nullable

property on_delete

Delete setting

property on_update

Update setting

property primary

Is primary or not?

property raw_source

Source / Foreign Reference

property source

Source / Foreign Reference

property source_column

Source column / Foreign reference column

to_json()

Convert column info as JSON

property type

Type

property unique

Is unique

luminadb.column.blob(name: str) → BuilderColumn

Create a blob column with name

luminadb.column.create_calls(typename: str, types: list[str]) → Callable[[str], BuilderColumn]

Create a dynamic call for types. This is intended to mimic this module’s real(), text(), … with custom types.

luminadb.column.integer(name: str) → BuilderColumn

Create a integer column with name

luminadb.column.real(name: str) → BuilderColumn

Create a real column with name

luminadb.column.text(name: str) → BuilderColumn

Create a text column with name