orionis.foundation.config.database.Oracle

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

class documentation

class Oracle(BaseEntity): (source)

View In Hierarchy

Represent Oracle database configuration for oracledb.

Method	`__post_init__`	Validate Oracle database connection configuration after initialization.
Method	`__validateConnectionParameters`	Validate Oracle connection parameters.
Method	`__validateEncoding`	Validate Oracle encoding parameters.
Method	`__validateNencoding`	Validate the Oracle national encoding parameter.
Instance Variable	`driver`	The database driver being used, typically 'oracle'.
Instance Variable	`dsn`	Full DSN string, used if service_name/sid are not specified.
Instance Variable	`encoding`	Character encoding for the connection.
Instance Variable	`host`	Hostname or IP address of the Oracle server.
Instance Variable	`nencoding`	National character encoding for the connection.
Instance Variable	`password`	Password for the database connection.
Instance Variable	`port`	Port number for the Oracle listener (default 1521).
Instance Variable	`service_name`	Service name for connection using the SERVICE_NAME method.
Instance Variable	`sid`	SID for connection using the SID method.
Instance Variable	`tns_name`	TNS alias name defined in tnsnames.ora.
Instance Variable	`username`	Username for the database connection.

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): (source) ¶

overrides orionis.support.entities.BaseEntity.__post_init__

Validate Oracle database connection configuration after initialization.

This method performs strict validation on the configuration fields required to establish an Oracle database connection. It ensures that all necessary parameters are present and correctly formatted, raising an appropriate exception if any validation fails.

Parameters
self:`Oracle`	The Oracle configuration instance.

Returns
`None`	This method does not return a value.

Raises
`ValueError`	If any configuration parameter is invalid.
`TypeError`	If any configuration parameter has an incorrect type.

def __validateConnectionParameters(self): (source) ¶

Validate Oracle connection parameters.

Validates host, port, service_name, and sid fields when DSN and TNS are not provided. Ensures all required fields are present and correctly formatted.

Parameters
self:`Oracle`	The Oracle configuration instance.

Returns
`None`	This method does not return a value.

Raises
`ValueError`	If any configuration parameter is invalid.

def __validateEncoding(self): (source) ¶

Validate Oracle encoding parameters.

Validates the encoding and nencoding fields to ensure they are valid OracleEncoding and OracleNencoding values.

Parameters
self:`Oracle`	The Oracle configuration instance.

Returns
`None`	This method does not return a value.

Raises
`ValueError`	If any encoding parameter is invalid.
`TypeError`	If any encoding parameter has an incorrect type.

def __validateNencoding(self): (source) ¶

Validate the Oracle national encoding parameter.

Validates the nencoding field to ensure it is a valid OracleNencoding value.

Parameters
self:`Oracle`	The Oracle configuration instance.

Returns
`None`	This method does not return a value.

Raises
`ValueError`	If the nencoding parameter is invalid.
`TypeError`	If the nencoding parameter has an incorrect type.

driver: str = (source) ¶

The database driver being used, typically 'oracle'.

dsn: str | None = (source) ¶

Full DSN string, used if service_name/sid are not specified.

encoding: str | OracleEncoding = (source) ¶

Character encoding for the connection.

host: str = (source) ¶

Hostname or IP address of the Oracle server.

nencoding: str | OracleNencoding = (source) ¶

National character encoding for the connection.

password: str = (source) ¶

Password for the database connection.

port: int = (source) ¶

Port number for the Oracle listener (default 1521).

service_name: str | None = (source) ¶

Service name for connection using the SERVICE_NAME method.

sid: str | None = (source) ¶

SID for connection using the SID method.

tns_name: str | None = (source) ¶

TNS alias name defined in tnsnames.ora.

username: str = (source) ¶

Username for the database connection.