luminadb.models.helpers module

Model helpers

class luminadb.models.helpers.Constraint(column: str)

Bases: object

Base constraint class for models

apply(type_: BuilderColumn)

Apply this constraint to an column

property column

Columns

class luminadb.models.helpers.ConstraintEnum(value)

Bases: StrEnum

Constraints for update/delete

CASCADE = 'cascade'

DEFAULT = 'default'

NOACT = 'no act'

RESTRICT = 'restrict'

SETNULL = 'null'

class luminadb.models.helpers.Foreign(column: str, target: str | Type[Model])

Bases: Constraint

Foreign constraint

apply(type_: BuilderColumn)

Apply this constraint to an column

on_delete(constraint: ConstraintEnum)

On delete constraint

on_update(constraint: ConstraintEnum)

On update constraint

resolve()

Resolve if current target is a Model

property target

Target foreign constraint

class luminadb.models.helpers.Primary(column: str, auto: bool = False)

Bases: Constraint

Primary constraint

Accepts optional auto flag to enable auto-increment on integer primary columns when using the BuilderColumn API.

apply(type_: BuilderColumn)

Apply this constraint as primary. If auto was requested, enable auto increment on the builder column as well.

property auto: bool

Auto increment

class luminadb.models.helpers.Unique(column: str)

Bases: Constraint

Unique constraint

apply(type_: BuilderColumn)

Apply this constraint to an column

class luminadb.models.helpers.Validators(fn: Callable[[Any], bool], if_fail: str)

Bases: object

Base class to hold validators

validate(instance: BaseModel)

Validate a value

luminadb.models.helpers.hook(fn_or_name: Callable[[Model], None]) → staticmethod[[Callable[[Model], None]], None]

luminadb.models.helpers.hook(fn_or_name: str)

Register a hook

luminadb.models.helpers.initiate_hook(cls: Type[BaseModel], member: Callable)

Initiate hooks

luminadb.models.helpers.initiate_validators(cls: Type[BaseModel], member: Callable)

Initiate validators

luminadb.models.helpers.validate(fn_or_column: FuncT) → staticmethod[[FuncT], bool]

luminadb.models.helpers.validate(fn_or_column: str, reason: str | None = None)

Register a validator