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.

package documentation

Group the orm schema types components and public imports.

Module _constants Define constants for orm schema types.
Module big_integer A type for bigger int integers. Typically generates BIGINT.
Module boolean A bool datatype, typically BOOLEAN or SMALLINT in DDL.
Module column_type Logical column types understood by the Orionis SQL compiler.
Module date A type for datetime.date() objects.
Module date_time A type for datetime.datetime() objects.
Module double A type for double FLOAT. Typically generates DOUBLE.
Module enum_type String-backed enumeration column.
Module float_type Type representing floating point types, such as FLOAT or REAL.
Module integer A type for int integers.
Module interval A type for datetime.timedelta() objects.
Module large_binary A type for large binary byte data, such as BLOB/BYTEA.
Module match_type Refers to the return type of the MATCH operator.
Module numeric Declare a non-integer numeric column using the logical NUMERIC kind.
Module numeric_common Describe the numeric-common placeholder kind.
Module pickle_type Holds Python objects, serialized using pickle.
Module schema_type Describe the schema-level placeholder kind.
Module small_integer A type for smaller int integers. Typically generates SMALLINT.
Module strict_array Represent a SQL ARRAY type.
Module strict_big_int The SQL BIGINT type.
Module strict_binary The SQL BINARY type.
Module strict_blob The SQL BLOB type.
Module strict_char The SQL CHAR type.
Module strict_clob The CLOB type, found in Oracle Database and Informix.
Module strict_decimal The SQL DECIMAL type.
Module strict_double_precision The SQL DOUBLE PRECISION type.
Module strict_int Alias of INTEGER.
Module strict_json Represent a SQL JSON type.
Module strict_nchar The SQL NCHAR type.
Module strict_nvarchar The SQL NVARCHAR type.
Module strict_real The SQL REAL type.
Module strict_small_int The SQL SMALLINT type.
Module strict_timestamp The SQL TIMESTAMP type.
Module strict_var_binary The SQL VARBINARY type.
Module strict_varchar The SQL VARCHAR type.
Module string_type Declare a variable-length SQL string using the logical VARCHAR kind.
Module text A variably sized string type. In SQL, usually CLOB/TEXT.
Module time_type A type for datetime.time() objects.
Module unicode A variable length Unicode string type, e.g. NVARCHAR.
Module unicode_text An unbounded-length Unicode string type, e.g. NCLOB/NTEXT.
Module uuid_type Represent a database agnostic UUID datatype.

From __init__.py:

Class BigInteger A type for bigger int integers. Typically generates BIGINT.
Class Boolean A bool datatype, typically BOOLEAN or SMALLINT in DDL.
Class ColumnType Logical column types understood by the Orionis SQL compiler.
Class Date A type for datetime.date() objects.
Class DateTime A type for datetime.datetime() objects.
Class Double A type for double FLOAT. Typically generates DOUBLE.
Class Enum String-backed enumeration column.
Class Float Type representing floating point types, such as FLOAT or REAL.
Class Integer A type for int integers.
Class Interval A type for datetime.timedelta() objects.
Class LargeBinary A type for large binary byte data, such as BLOB/BYTEA.
Class MatchType Refers to the return type of the MATCH operator.
Class Numeric Declare a non-integer numeric column using the logical NUMERIC kind.
Class NumericCommon Describe the numeric-common placeholder kind.
Class PickleType Holds Python objects, serialized using pickle.
Class SchemaType Describe the schema-level placeholder kind.
Class SmallInteger A type for smaller int integers. Typically generates SMALLINT.
Class StrictArray Represent a SQL ARRAY type.
Class StrictBigInt The SQL BIGINT type.
Class StrictBinary The SQL BINARY type.
Class StrictBlob The SQL BLOB type.
Class StrictChar The SQL CHAR type.
Class StrictClob The CLOB type, found in Oracle Database and Informix.
Class StrictDecimal The SQL DECIMAL type.
Class StrictDoublePrecision The SQL DOUBLE PRECISION type.
Class StrictInt Alias of INTEGER.
Class StrictJson Represent a SQL JSON type.
Class StrictNChar The SQL NCHAR type.
Class StrictNVarChar The SQL NVARCHAR type.
Class StrictReal The SQL REAL type.
Class StrictSmallInt The SQL SMALLINT type.
Class StrictTimestamp The SQL TIMESTAMP type.
Class StrictVarBinary The SQL VARBINARY type.
Class StrictVarChar The SQL VARCHAR type.
Class String Declare a variable-length SQL string using the logical VARCHAR kind.
Class Text A variably sized string type. In SQL, usually CLOB/TEXT.
Class Time A type for datetime.time() objects.
Class Unicode A variable length Unicode string type, e.g. NVARCHAR.
Class UnicodeText An unbounded-length Unicode string type, e.g. NCLOB/NTEXT.
Class Uuid Represent a database agnostic UUID datatype.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
def __dir__() -> list[str]: (source)

List loaded attributes and declared public exports.

Returns
list[str]Sorted attribute names available on this package.
def __getattr__(name: str) -> object: (source)

Resolve and cache a public package export.

Parameters
name:strPublic attribute requested from this package.
Returns
objectExported object from its defining module.
Raises
AttributeErrorIf the requested attribute is not exported.
_EXPORTS: dict = (source)

Public export names mapped to their defining modules and attributes.

Value
{'BigInteger': ('orionis.orm.schema.types.big_integer', 'BigInteger'),
 'Boolean': ('orionis.orm.schema.types.boolean', 'Boolean'),
 'ColumnType': ('orionis.orm.schema.types.column_type', 'ColumnType'),
 'Date': ('orionis.orm.schema.types.date', 'Date'),
 'DateTime': ('orionis.orm.schema.types.date_time', 'DateTime'),
 'Double': ('orionis.orm.schema.types.double', 'Double'),
 'Enum': ('orionis.orm.schema.types.enum_type', 'Enum'),
...