orionis.foundation.config.database.SQLServer

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

View In Hierarchy

Represent the Microsoft SQL Server database configuration.

Method	`__post_init__`	Validate the SQL Server configuration after initialization.
Method	`__validateCredentials`	Validate the username and password fields.
Method	`__validateDriver`	Require the SQL Server driver discriminator.
Method	`__validateEndpoint`	Validate the host, port, and database fields.
Method	`__validateOptions`	Validate the prefix, charset, and ODBC connection options.
Instance Variable	`charset`	The charset used for the connection.
Instance Variable	`database`	The name of the SQL Server database.
Instance Variable	`driver`	The database driver being used, e.g., 'sqlserver'.
Instance Variable	`encrypt`	Whether the connection must be encrypted ('yes'/'no' or bool).
Instance Variable	`host`	The host address for the SQL Server instance.
Instance Variable	`odbc_driver`	Name of the ODBC driver used by the connection.
Instance Variable	`password`	The password for the database.
Instance Variable	`port`	The port for connecting to SQL Server (default 1433).
Instance Variable	`prefix`	Prefix for table names.
Instance Variable	`prefix_indexes`	Whether to prefix index names.
Instance Variable	`trust_server_certificate`	Whether to trust the server certificate without validation.
Instance Variable	`username`	The username for connecting to the database.

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 the SQL Server configuration after initialization.

Returns
`None`	This method validates the entity without returning a value.

Raises
`ValueError`	If a configuration value is invalid.
`TypeError`	If a configuration field has an incorrect type.

def __validateCredentials(self): (source) ¶

Validate the username and password fields.

Returns
`None`	This method validates credentials without returning a value.

Raises
`TypeError`	If the username or password has an incorrect type.
`ValueError`	If the username is empty.

def __validateDriver(self): (source) ¶

Require the SQL Server driver discriminator.

Returns
`None`	This method validates the driver without returning a value.

Raises
`ValueError`	If the driver is not `sqlserver`.

def __validateEndpoint(self): (source) ¶

Validate the host, port, and database fields.

Returns
`None`	This method validates the endpoint without returning a value.

Raises
`ValueError`	If the host, port, or database value is invalid.
`TypeError`	If the port is not an integer.

def __validateOptions(self): (source) ¶

Validate the prefix, charset, and ODBC connection options.

Returns
`None`	This method validates options without returning a value.

Raises
`ValueError`	If an option value is invalid.
`TypeError`	If an option has an incorrect type.

charset: str = (source) ¶

The charset used for the connection.

database: str = (source) ¶

The name of the SQL Server database.

driver: str = (source) ¶

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

encrypt: bool | str = (source) ¶

Whether the connection must be encrypted ('yes'/'no' or bool).

host: str = (source) ¶

The host address for the SQL Server instance.

odbc_driver: str = (source) ¶

Name of the ODBC driver used by the connection.

password: str = (source) ¶

The password for the database.

port: int = (source) ¶

The port for connecting to SQL Server (default 1433).

prefix: str = (source) ¶

Prefix for table names.

prefix_indexes: bool = (source) ¶

Whether to prefix index names.

trust_server_certificate: bool = (source) ¶

Whether to trust the server certificate without validation.

username: str = (source) ¶

The username for connecting to the database.