firebird.driver.config¶
This module contains firebird-driver configuration. Uses configuration classes from firebird-base package.
Classes¶
- class firebird.driver.config.DriverConfig(name: str)[source]¶
Bases:
Config
Firebird driver configuration.
- Parameters
name (str) –
- get_database(name: str) DatabaseConfig [source]¶
Returns database configuration.
- Parameters
name (str) –
- Return type
- get_server(name: str) ServerConfig [source]¶
Returns server configuration.
- Parameters
name (str) –
- Return type
- read(filenames: Union[str, Iterable], encoding: Optional[str] = None)[source]¶
Read configuration from a filename or an iterable of filenames.
Files that cannot be opened are silently ignored; this is designed so that you can specify an iterable of potential configuration file locations (e.g. current directory, user’s home directory, systemwide directory), and all existing configuration files in the iterable will be read. A single filename may also be given.
Return list of successfully read files.
- read_dict(dictionary: Dict) None [source]¶
Read configuration from a dictionary.
Keys are section names, values are dictionaries with keys and values that should be present in the section. If the used dictionary type preserves order, sections and their keys will be added in order.
All types held in the dictionary are converted to strings during reading, including section names, option names and keys.
- Parameters
dictionary (Dict) –
- Return type
None
- read_file(f)[source]¶
Read configuration from a file-like object.
The
f
argument must be iterable, returning one line at a time.
- read_string(string: str) None [source]¶
Read configuration from a given string.
- Parameters
string (str) –
- Return type
None
- register_database(name: str, config: Optional[str] = None) DatabaseConfig [source]¶
Register database.
- Parameters
- Returns
For newly registered database
- Return type
- Raises
ValueError – If database is already registered.
- register_server(name: str, config: Optional[str] = None) ServerConfig [source]¶
Register server.
- Parameters
- Returns
For newly registered server
- Return type
- Raises
ValueError – If server is already registered.
- databases: ConfigListOption¶
Registered databases
- db_defaults: DatabaseConfig¶
Default database configuration (‘firebird.db.defaults’)
- server_defaults: ServerConfig¶
Default server configuration (‘firebird.server.defaults’)
- servers: ConfigListOption¶
Registered servers
- class firebird.driver.config.ServerConfig(name: str, *, optional: bool = False, description: Optional[str] = None)[source]¶
Bases:
Config
Server configuration.
- encoding_errors: StrOption¶
Handler used for encoding errors. See
codecs error handlers
for details.
- trusted_auth: BoolOption¶
False
- Type
Use trusted authentication, default
- class firebird.driver.config.DatabaseConfig(name: str, *, optional: bool = False, description: Optional[str] = None)[source]¶
Bases:
Config
Database configuration.
- decfloat_round: EnumOption¶
Set DECFLOAT ROUND [Firebird 4], value is
DecfloatRound
- decfloat_traps: ListOption¶
Set DECFLOAT TRAPS [Firebird 4], values are
DecfloatTraps
- forced_writes: BoolOption¶
Database create option. Write mode (True = sync/False = async).
- no_linger: BoolOption¶
Do not use linger for database connection
- protocol: EnumOption¶
Protocol to be used for databasem value is
NetProtocol
- reserve_space: BoolOption¶
Database create option. Data page space usage (True = reserve space, False = Use all space).
- trusted_auth: BoolOption¶
False
- Type
Use trusted authentication, default
- utf8filename: BoolOption¶
Database filename should be passed in UTF8
Globals¶
- firebird.driver.config.driver_config: DriverConfig¶
Firebird driver configuration.