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.foundation.config.database

package documentation
(source)

Undocumented

Package entities Undocumented
Package enums No package docstring; 0/1 constant, 2/2 functions, 0/13 module documented

From __init__.py:

Class ConnectionName Enumerate the built-in database connection names supported by Orionis.
Class Connections Represent all database connections used by the application.
Class Database Represent the general database configuration.
Class MySQL Data class to represent the MySQL database configuration.
Class MySQLCharset Enumerate MySQL character sets usable by the configured connection drivers.
Class MySQLCollation Enumerate common MySQL collations.
Class MySQLEngine Enumerate supported MySQL storage engines.
Class Oracle Represent Oracle database configuration for oracledb.
Class OracleEncoding Enumerate Oracle database character encodings.
Class OracleNencoding Represent Oracle national character sets supported by Oracle Database.
Class PGSQL Represent a PostgreSQL database configuration entity.
Class PGSQLCharset Enumerate PostgreSQL encodings supported for database storage.
Class PGSQLCollation Enumerate common PostgreSQL collations.
Class PGSQLSSLMode Define SSL modes for PostgreSQL connections.
Class SQLite Represent the SQLite database configuration.
Class SQLiteForeignKey Represent the state of foreign key constraints in SQLite.
Class SQLiteJournalMode Enumerate SQLite journal modes.
Class SQLiteSynchronous Represent SQLite synchronous settings for transaction durability.
Class SQLServer Represent the Microsoft SQL Server database configuration.
Class SQLServerCharset Enumerate SQLCHAR encodings documented for SQL Server ODBC on Linux and macOS.
Function __dir__ List loaded attributes and declared database configuration exports.
Function __getattr__ Resolve and cache a public database configuration export.
Constant _EXPORTS Undocumented
def __dir__() -> list[str]: (source)

List loaded attributes and declared database configuration exports.

Returns
list[str]Sorted names without importing the declared entities or enums.
def __getattr__(name: str) -> object: (source)

Resolve and cache a public database configuration export.

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

Undocumented

Value
{'ConnectionName': ('orionis.foundation.config.database.enums.connection_name',
                    'ConnectionName'),
 'Connections': ('orionis.foundation.config.database.entities.connections',
                 'Connections'),
 'Database': ('orionis.foundation.config.database.entities.database',
              'Database'),
 'MySQL': ('orionis.foundation.config.database.entities.mysql', 'MySQL'),
...