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.SQLite

class documentation

class SQLite(BaseEntity): (source)

View In Hierarchy

Represent the SQLite database configuration.

Method __normalizeForeignKeyConstraints Normalize foreign-key settings to SQLite enum values.
Method __normalizeJournalMode Normalize the SQLite journal mode option.
Method __normalizeSynchronous Normalize the SQLite synchronous option.
Method __post_init__ Validate SQLite options and derive the informational URL when absent.
Instance Variable busy_timeout The timeout period (in milliseconds) before retrying a locked database.
Instance Variable database The path to the SQLite database file.
Instance Variable driver The database driver being used, e.g., 'sqlite'.
Instance Variable foreign_key_constraints Whether foreign key constraints are enabled.
Instance Variable journal_mode The journal mode used for transactions.
Instance Variable prefix Prefix for table names.
Instance Variable synchronous The synchronization level for the database.
Instance Variable url Informational URL, derived from database when omitted.

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method getFields Describe field names, normalized types, defaults, and metadata.
Method toDict Convert the dataclass instance to a recursively copied dictionary.
Class Variable __slots__ Undocumented
def __normalizeForeignKeyConstraints(self): (source)

Normalize foreign-key settings to SQLite enum values.

Returns
NoneThis method updates the frozen entity in place and returns no value.
def __normalizeJournalMode(self): (source)

Normalize the SQLite journal mode option.

Returns
NoneThis method updates the frozen entity in place and returns no value.
def __normalizeSynchronous(self): (source)

Normalize the SQLite synchronous option.

Returns
NoneThis method updates the frozen entity in place and returns no value.
def __post_init__(self): (source)
overrides orionis.support.entities.BaseEntity.__post_init__

Validate SQLite options and derive the informational URL when absent.

Returns
NoneThis method validates and normalizes the entity without returning a value.
Raises
TypeErrorIf a configured option has an invalid type.
ValueErrorIf a configured option has an invalid value.
busy_timeout: int | None = (source)

The timeout period (in milliseconds) before retrying a locked database.

database: str = (source)

The path to the SQLite database file.

driver: str = (source)

The database driver being used, e.g., 'sqlite'.

foreign_key_constraints: bool | str | SQLiteForeignKey = (source)

Whether foreign key constraints are enabled.

journal_mode: str = (source)

The journal mode used for transactions.

prefix: str = (source)

Prefix for table names.

synchronous: str = (source)

The synchronization level for the database.

url: str | None = (source)

Informational URL, derived from database when omitted.