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 foundation config database enums components and public imports.

Module connection_name Enumerate the built-in database connection names supported by Orionis.
Module mysql_charsets Enumerate MySQL character sets usable by the configured connection drivers.
Module mysql_collations Enumerate common MySQL collations.
Module mysql_engine Enumerate supported MySQL storage engines.
Module oracle_encoding Enumerate Oracle database character encodings.
Module oracle_nencoding Represent Oracle national character sets supported by Oracle Database.
Module pgsql_charsets Enumerate PostgreSQL encodings supported for database storage.
Module pgsql_collations Enumerate common PostgreSQL collations.
Module pgsql_mode Define SSL modes for PostgreSQL connections.
Module redshift_mode Enumerate certificate verification modes supported by the AWS connector.
Module sqlite_foreign_key Represent the state of foreign key constraints in SQLite.
Module sqlite_journal Enumerate SQLite journal modes.
Module sqlite_synchronous Represent SQLite synchronous settings for transaction durability.
Module sqlserver_charset Enumerate SQLCHAR encodings documented for SQL Server ODBC on Linux and macOS.

From __init__.py:

Function __dir__ List loaded attributes and declared enum exports.
Function __getattr__ Resolve and cache a public database enum.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
def __dir__() -> list[str]: (source)

List loaded attributes and declared enum exports.

Returns
list[str]Sorted names without importing unrelated driver catalogs.
def __getattr__(name: str) -> object: (source)

Resolve and cache a public database enum.

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

Public export names mapped to their defining modules and attributes.

Value
{'ConnectionName': ('orionis.foundation.config.database.enums.connection_name',
                    'ConnectionName'),
 'MySQLCharset': ('orionis.foundation.config.database.enums.mysql_charsets',
                  'MySQLCharset'),
 'MySQLCollation': ('orionis.foundation.config.database.enums.mysql_collations',
                    'MySQLCollation'),
 'MySQLEngine': ('orionis.foundation.config.database.enums.mysql_engine', 'MySQL↵
...