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.constraints.ForeignReference

class documentation

class ForeignReference: (source)

Constructor: ForeignReference.parse(reference)

View In Hierarchy

Immutable value object describing a foreign key reference.

Class Method parse Build a reference from a "table.column" qualified string.
Method qualified Return the reference in its qualified "table.column" form.
Instance Variable column Name of the referenced column.
Instance Variable table Name of the referenced table.
def parse(cls, reference: str) -> ForeignReference: (source)

Build a reference from a "table.column" qualified string.

Parameters
reference:strQualified reference in the form "table.column".
Returns
ForeignReferenceParsed reference value object.
Raises
ValueErrorIf the reference is not a non-empty "table.column" string.
def qualified(self) -> str: (source)

Return the reference in its qualified "table.column" form.

Returns
strQualified reference string.
column: str = (source)

Name of the referenced column.

table: str = (source)

Name of the referenced table.