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

class documentation

class PGSQL(BaseEntity): (source)

View In Hierarchy

Represent a PostgreSQL database configuration entity.

Method __post_init__ Validate and initialize the PostgreSQL configuration attributes.
Method __validateCharset Normalize the PostgreSQL charset option.
Method __validateSSLMode Normalize the PostgreSQL SSL mode option.
Instance Variable charset Database charset.
Instance Variable database Database name.
Instance Variable driver Database driver type.
Instance Variable host Database host.
Instance Variable password Database password.
Instance Variable port Database port.
Instance Variable prefix Table prefix.
Instance Variable prefix_indexes Whether to prefix indexes.
Instance Variable search_path PostgreSQL schema search_path.
Instance Variable sslmode Connection SSL mode.
Instance Variable username Database user.

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 __post_init__(self: PGSQL): (source)
overrides orionis.support.entities.BaseEntity.__post_init__

Validate and initialize the PostgreSQL configuration attributes.

Validate scalar settings, normalize enum values, and preserve the configured port representation after range validation.

Parameters
self:PGSQLConfiguration entity to validate and initialize.
Returns
NoneThis method validates and normalizes the entity in place.
Raises
ValueErrorIf a required attribute is missing or has an invalid value.
TypeErrorIf an attribute has an invalid type.
def __validateCharset(self: PGSQL): (source)

Normalize the PostgreSQL charset option.

Parameters
self:PGSQLConfiguration entity containing the charset to normalize.
Returns
NoneThis method stores the canonical charset value in the entity.
def __validateSSLMode(self: PGSQL): (source)

Normalize the PostgreSQL SSL mode option.

Parameters
self:PGSQLConfiguration entity containing the SSL mode to normalize.
Returns
NoneThis method stores the canonical SSL mode value in the entity.
charset: str | PGSQLCharset = (source)

Database charset.

database: str = (source)

Database name.

driver: str = (source)

Database driver type.

host: str = (source)

Database host.

password: str = (source)

Database password.

port: str | int = (source)

Database port.

prefix: str = (source)

Table prefix.

prefix_indexes: bool = (source)

Whether to prefix indexes.

search_path: str = (source)

PostgreSQL schema search_path.

sslmode: str | PGSQLSSLMode = (source)

Connection SSL mode.

username: str = (source)

Database user.