Class: QgsAuthConfigurationStorageDb

QSqlDatabase based implementation of QgsAuthConfigurationStorage.

Added in version 3.40.

List of all members, including inherited members

Class Hierarchy

Base classes

QgsAuthConfigurationStorage	Abstract class that defines the interface for all authentication configuration storage implementations.
QObject

Constructor

__init__

Methods

authDatabaseConnection	Returns the database connection used by this storage.
authDbOpen	Opens the connection to the database.
authDbQuery	Runs the specified query on the database.
authDbTransactionQuery	Executes the specified query on the database using a transaction.
createCertTables	Creates the certificate tables in the database.
createConfigTables	Creates the configuration tables in the database.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsAuthConfigurationStorageDb. See the FAQ for more details.

authSettingsTableName	Returns the name of the table used to store the auth settings.
certAuthorityTableName	Returns the name of the table used to store the certificate authorities.
certIdentityTableName	Returns the name of the table used to store the certificate identities.
certTrustPolicyTableName	Returns the name of the table used to store the certificate trust policies.
checkCapabilities	Checks the capabilities of the storage.
masterPasswordTableName	Returns the name of the table used to store the master passwords.
methodConfigTableName	Returns the name of the table used to store the method configurations.
quotedQualifiedIdentifier	Returns the quoted identifier, prefixed with the schema (if not null), ready for the insertion into a SQL query.
sslCertCustomConfigTableName	Returns the name of the table used to store the SSL custom configurations.
tableExists	Returns True if the specified table exists in the database, False otherwise.

class qgis.core.QgsAuthConfigurationStorageDb

Bases: QgsAuthConfigurationStorage

__init__(settings: dict[str | None, Any])

Creates a new QgsAuthConfigurationStorageDb instance from the specified settings. Settings can contain the following keys:

Mandatory settings:

• driver: the database driver to use (default is “QSQLITE”, see: https://doc.qt.io/qt-6/sql-driver.html)

• database: the database name (or path in case of QSQLITE)

Optional settings:

• host: the database host

• user: the database user

• password: the database password

• port: the database port

• schema: the database schema for all the tables (ignored if not supported)

• options: the database connection options (see: https://doc.qt.io/qt-6/qsqldatabase.html#setConnectOptions)

Note

Even if this generic storage also works with a pre-existing SQLite DB, a convenience subclass QgsAuthConfigurationStorageSqlite is provided for SQLite DBs.

Parameters:

settings (dict[Optional[str], Any])

__init__(uri: str | None)

Creates a new QgsAuthConfigurationStorageDb instance from the specified uri. The URI should be in the format: verbatim<DRIVER>://<USER>:<PASSWORD>@<HOST>:<PORT>/<DATABASE>[?OPTIONS]endverbatim

Note

It is not possible to set the schema in the URI, pass SCHEMA=verbatim<SCHEMA>endverbatim in the options instead.

Parameters:

uri (Optional[str])

authDatabaseConnection(self) → QSqlDatabase

Returns the database connection used by this storage.

Return type:

QSqlDatabase

authDbOpen(self) → bool

Opens the connection to the database.

Return type:

bool

Returns:

True if the connection was opened successfully, False otherwise.

authDbQuery(self, query: QSqlQuery | None, sql: str | None = '') → bool

Runs the specified query on the database. Optional sql can be provided.

Return type:

bool

Returns:

True if the query was executed successfully, False otherwise.

Parameters:

• query (Optional[QSqlQuery])

• sql (Optional[str] = '')

authDbTransactionQuery(self, query: QSqlQuery | None) → bool

Executes the specified query on the database using a transaction. Optional sql can be provided.

Return type:

bool

Returns:

True if the query was executed successfully, False otherwise.

Parameters:

query (Optional[QSqlQuery])

virtual authSettingsTableName(self) → str

Returns the name of the table used to store the auth settings.

Return type:

str

virtual certAuthorityTableName(self) → str

Returns the name of the table used to store the certificate authorities.

Return type:

str

virtual certIdentityTableName(self) → str

Returns the name of the table used to store the certificate identities.

Return type:

str

virtual certTrustPolicyTableName(self) → str

Returns the name of the table used to store the certificate trust policies.

Return type:

str

virtual checkCapabilities(self)

Checks the capabilities of the storage.

createCertTables(self) → bool

Creates the certificate tables in the database.

Return type:

bool

Returns:

True if the tables were created successfully, False otherwise.

createConfigTables(self) → bool

Creates the configuration tables in the database.

Return type:

bool

Returns:

True if the tables were created successfully, False otherwise.

virtual masterPasswordTableName(self) → str

Returns the name of the table used to store the master passwords.

Return type:

str

virtual methodConfigTableName(self) → str

Returns the name of the table used to store the method configurations.

Return type:

str

virtual quotedQualifiedIdentifier(self, identifier: str | None, isIndex: bool = False) → str

Returns the quoted identifier, prefixed with the schema (if not null), ready for the insertion into a SQL query.

Parameters:

• identifier (Optional[str]) – the identifier to quote.

• isIndex (bool = False) – if True, the identifier is treated as an index name.

Return type:

str

virtual sslCertCustomConfigTableName(self) → str

Returns the name of the table used to store the SSL custom configurations.

Return type:

str

virtual tableExists(self, table: str | None) → bool

Returns True if the specified table exists in the database, False otherwise.

Note

The schema is automatically prepended to the table name.

Parameters:

table (Optional[str])

Return type:

bool