Class: QgsAbstractDatabaseProviderConnection

The QgsAbstractDatabaseProviderConnection class provides common functionality for DB based connections.

This class performs low level DB operations without asking the user for confirmation or handling currently opened layers and the registry entries, it is responsibility of the client code to keep layers in sync. The class methods will throw exceptions in case the requested operation is not supported or cannot be performed without errors.

Added in version 3.10.

Class Hierarchy

Base classes

QgsAbstractProviderConnection

The QgsAbstractProviderConnection provides an interface for data provider connections.

Enums

TableFlag

Flags for table properties.

Methods

addField	Adds a field.
addFieldDomain	Adds a new field domain to the database.
addRelationship	Adds a new field relationship to the database.
capabilities	Returns connection capabilities.
capabilities2	Returns extended connection capabilities.
checkCapability	Checks if capability is supported.
createSchema	Creates a new schema with the specified name.
createSpatialIndex	Creates a spatial index for the database table with given schema and name (schema is ignored if not supported by the backend).
createSqlVectorLayer	Creates and returns a (possibly invalid) vector layer based on the sql statement and optional options.
createVectorTable	Creates an empty table with name in the given schema (schema is ignored if not supported by the backend).
deleteField	Deletes the field with the specified name.
deleteRelationship	Deletes an existing relationship in the database.
deleteSpatialIndex	Deletes the existing spatial index for the database table with given schema, name and geometryColumn (schema and geometryColumn are ignored if not supported by the backend).
dropRasterTable	Drops a raster table with given schema (schema is ignored if not supported by the backend) and name.
dropSchema	Drops an entire schema with the specified name.
dropVectorTable	Drops a vector (or aspatial) table with given schema (schema is ignored if not supported by the backend) and name.
execSql	Executes raw sql and returns the (possibly empty) query results, optionally feedback can be provided.
executeSql	Executes raw sql and returns the (possibly empty) list of results in a multi-dimensional array, optionally feedback can be provided.
fieldDomain	Returns the field domain with the specified name from the provider.
fieldDomainNames	Returns a list of field domain names present on the provider.
fields	Returns the fields of a table and schema.
geometryColumnCapabilities	Returns connection geometry column capabilities (Z, M, SinglePart, Curves).
illegalFieldNames	Returns a list of field names which are considered illegal by the connection and should not be used when creating or altering fields.
nativeTypes	Returns a list of native types supported by the connection.
providerKey	Returns the provider key.
queryBuilder	Returns a SQL query builder for the connection, which provides an interface for provider-specific creation of SQL queries.
relatedTableTypes	Returns a list of the related table types supported by the database format.
relationships	Returns a list of relationships detected in the database.
renameField	Renames an existing field.
renameRasterTable	Renames a raster table with given schema (schema is ignored if not supported by the backend) and name.
renameSchema	Renames a schema with the specified name.
renameVectorTable	Renames a vector or aspatial table with given schema (schema is ignored if not supported by the backend) and name.
schemas	Returns information about the existing schemas.
searchLayerMetadata	Search the stored layer metadata in the connection, optionally limiting the search to the metadata identifier, title, abstract, keywords and categories.
setFieldAlias	Sets the alias for the existing field with the specified name.
setFieldComment	Sets the comment for the existing field with the specified name.
setFieldDomainName	Sets the field domain name for the existing field with the specified name.
spatialIndexExists	Determines whether a spatial index exists for the database table with given schema, name and geometryColumn (schema and geometryColumn are ignored if not supported by the backend).
sqlDictionary	Returns a dictionary of SQL keywords supported by the provider.
sqlLayerDefinitionCapabilities	Returns SQL layer definition capabilities (Filters, GeometryColumn, PrimaryKeys).
sqlOptions	Returns the SQL layer options from a layerSource.
supportedFieldDomainTypes	Returns a list of field domain types which are supported by the provider.
supportedRelationshipCapabilities	Returns the relationship capabilities supported by the provider.
supportedRelationshipCardinalities	Returns a list of relationship cardinalities which are supported by the provider.
supportedRelationshipStrengths	Returns a list of relationship strengths which are supported by the provider.
table	Returns information on a table in the given schema.
tableExists	Checks whether a table name exists in the given schema.
tableUri	Returns the URI string for the given table and schema.
tables	Returns information on the tables in the given schema.
updateRelationship	Updates an existing relationship in the database.
vacuum	Vacuum the database table with given schema and name (schema is ignored if not supported by the backend).

Attributes

AddField
AddFieldDomain
AddRelationship
CreateSchema
CreateSpatialIndex
CreateVectorTable
Curves
DeleteField
DeleteFieldCascade
DeleteRelationship
DeleteSpatialIndex
DropRasterTable
DropSchema
DropVectorTable
ExecuteSql
ListFieldDomains
M
PolyhedralSurfaces
RenameField
RenameRasterTable
RenameSchema
RenameVectorTable
RetrieveFieldDomain
RetrieveRelationships
Schemas
SetFieldDomain
SingleLineString
SinglePart
SinglePoint
SinglePolygon
Spatial
SpatialIndexExists
SqlLayers
TableExists
Tables
UpdateRelationship
Vacuum
Z

class qgis.core.QgsAbstractDatabaseProviderConnection

Bases: QgsAbstractProviderConnection

__init__(name: str | None)

Creates a new connection with name by reading its configuration from the settings.

If a connection with this name cannot be found, an empty connection will be returned.

Parameters:

name (Optional[str])

__init__(uri: str | None, configuration: Dict[str, Any])

Creates a new connection from the given uri and configuration.

The connection is not automatically stored in the settings.

See also

store()

Parameters:

• uri (Optional[str])

• configuration (Dict[str, Any])

__init__(a0: QgsAbstractDatabaseProviderConnection)

Parameters:

a0 (QgsAbstractDatabaseProviderConnection)

AddField = 2097152

AddFieldDomain = 33554432

AddRelationship = 268435456

class Capabilities

class Capabilities(f: QgsAbstractDatabaseProviderConnection.Capabilities | QgsAbstractDatabaseProviderConnection.Capability)

class Capabilities(a0: QgsAbstractDatabaseProviderConnection.Capabilities)

Bases: object

class Capability

Bases: int

CreateSchema = 64

CreateSpatialIndex = 65536

CreateVectorTable = 2

Curves = 16

DeleteField = 524288

DeleteFieldCascade = 1048576

DeleteRelationship = 1073741824

DeleteSpatialIndex = 262144

DropRasterTable = 4

DropSchema = 128

DropVectorTable = 8

ExecuteSql = 512

class GeometryColumnCapabilities

class GeometryColumnCapabilities(f: QgsAbstractDatabaseProviderConnection.GeometryColumnCapabilities | QgsAbstractDatabaseProviderConnection.GeometryColumnCapability)

class GeometryColumnCapabilities(a0: QgsAbstractDatabaseProviderConnection.GeometryColumnCapabilities)

Bases: object

class GeometryColumnCapability

Bases: int

ListFieldDomains = 4194304

M = 4

PolyhedralSurfaces = 256

class QueryResult

Bases: object

The QueryResult class represents the result of a query executed by execSql()

It encapsulates an iterator over the result rows and a list of the column names.

Rows can be retrieved by iterating over the result with hasNextRow() and nextRow() or by calling rows() that will internally iterate over the results and return the whole result list.

Added in version 3.18.

columns(self) → List[str]

Returns the column names.

Return type:

List[str]

fetchedRowCount(self) → int

Returns the number of fetched rows.

See also

rowCount()

Return type:

int

hasNextRow(self) → bool

Returns True if there are more rows to fetch.

See also

nextRow()

See also

rewind()

Return type:

bool

nextRow(self) → List[Any]

Returns the next result row or an empty row if there are no rows left.

See also

hasNextRow()

See also

rewind()

Return type:

List[Any]

queryExecutionTime(self) → float

Returns the query execution time in milliseconds.

Return type:

float

rowCount(self) → int

Returns the number of rows returned by a SELECT query or Qgis.FeatureCountState.UnknownCount if unknown.

See also

fetchedRowCount()

Return type:

int

rows(self, feedback: QgsFeedback | None = None) → Any

Returns the result rows by calling the iterator internally and fetching all the rows, an optional feedback can be used to interrupt the fetching loop.

Note

calling this function more than one time is not supported: the second call will always return an empty list.

Parameters:

feedback (Optional[QgsFeedback] = None)

Return type:

Any

setQueryExecutionTime(self, queryExecutionTime: float)

Sets the query execution time to queryExecutionTime milliseconds.

Parameters:

queryExecutionTime (float)

RenameField = 67108864

RenameRasterTable = 32

RenameSchema = 256

RenameVectorTable = 16

RetrieveFieldDomain = 8388608

RetrieveRelationships = 134217728

Schemas = 4096

SetFieldDomain = 16777216

SingleLineString = 64

SinglePart = 8

SinglePoint = 32

SinglePolygon = 128

Spatial = 32768

SpatialIndexExists = 131072

class SpatialIndexOptions

Bases: object

The SpatialIndexOptions contains extra options relating to spatial index creation.

Added in version 3.14.

geometryColumnName

Specifies the name of the geometry column to create the index for

SqlLayers = 8192

class SqlVectorLayerOptions

Bases: object

The SqlVectorLayerOptions stores all information required to create a SQL (query) layer.

See also

createSqlVectorLayer()

Added in version 3.22.

disableSelectAtId

If SelectAtId is disabled (default is false), not all data providers support this feature: check support with SqlLayerDefinitionCapability.SelectAtId capability

filter

Additional subset string (provider-side filter), not all data providers support this feature: check support with SqlLayerDefinitionCapability.Filters capability

geometryColumn

Name of the geometry column

layerName

Optional name for the new layer

primaryKeyColumns

List of primary key column names

sql

The SQL expression that defines the SQL (query) layer

TableExists = 16384

class TableFlag(*values)

Bases: IntEnum

Flags for table properties.

Flags can be useful for filtering the tables returned from tables().

• Aspatial: Aspatial table (it does not contain any geometry column)

• Vector: Vector table (it does contain one geometry column)

• Raster: Raster table

• View: View table

• MaterializedView: Materialized view table

• Foreign: Foreign data wrapper

• IncludeSystemTables: Include system tables

  Added in version 3.30.

class TableFlags

class TableFlags(f: QgsAbstractDatabaseProviderConnection.TableFlags | QgsAbstractDatabaseProviderConnection.TableFlag)

class TableFlags(a0: QgsAbstractDatabaseProviderConnection.TableFlags)

Bases: object

class TableProperty

Bases: object

The TableProperty class represents a database table or view.

In case the table is a vector spatial table and it has multiple geometry columns, separate entries for each geometry column must be created.

In case the table is a vector spatial table and the geometry column can contain multiple geometry types and/or CRSs, a clone of the property for the individual geometry type/CRS can be retrieved with at(i)

class GeometryColumnType

Bases: object

The GeometryColumnType struct represents the combination of geometry type and CRS for the table geometry column.

crs

wkbType

addGeometryColumnType(self, type: Qgis.WkbType, crs: QgsCoordinateReferenceSystem)

Appends the geometry column type with the given srid to the geometry column types list.

Parameters:

• type (Qgis.WkbType)

• crs (QgsCoordinateReferenceSystem)

at(self, index: int) → QgsAbstractDatabaseProviderConnection.TableProperty

Returns the table property corresponding to the geometry type at the given index.

Parameters:

index (int)

Return type:

QgsAbstractDatabaseProviderConnection.TableProperty

comment(self) → str

Returns the table comment.

Return type:

str

crsList(self) → List[QgsCoordinateReferenceSystem]

Returns the list of CRSs supported by the geometry column.

Return type:

List[QgsCoordinateReferenceSystem]

defaultName(self) → str

Returns the default name for the table entry.

This is usually the table name but in case there are multiple geometry columns, the geometry column name is appended to the table name.

See also

geometryColumnCount()

Return type:

str

flags(self) → QgsAbstractDatabaseProviderConnection.TableFlags

Returns the table flags.

Return type:

QgsAbstractDatabaseProviderConnection.TableFlags

geometryColumn(self) → str

Returns the geometry column name.

Return type:

str

geometryColumnCount(self) → int

Returns the number of geometry columns in the original table this entry refers to.

This information is used internally to build the defaultName().

Return type:

int

geometryColumnTypes(self) → List[QgsAbstractDatabaseProviderConnection.TableProperty.GeometryColumnType]

Returns the list of geometry column types and CRSs.

The method returns a list of GeometryColumnType.

Return type:

List[QgsAbstractDatabaseProviderConnection.TableProperty.GeometryColumnType]

info(self) → Dict[str, Any]

Returns additional information about the table.

Provider classes may use this property to store custom bits of information.

Return type:

Dict[str, Any]

maxCoordinateDimensions(self) → int

Returns the maximum coordinate dimensions of the geometries of a vector table.

This information is calculated from the geometry columns types.

See also

geometryColumnTypes()

Return type:

int

primaryKeyColumns(self) → List[str]

Returns the list of primary key column names.

Return type:

List[str]

schema(self) → str

Returns the schema or an empty string for backends that do not support a schema.

Return type:

str

setComment(self, comment: str | None)

Sets the table comment.

Parameters:

comment (Optional[str])

setFlag(self, flag: QgsAbstractDatabaseProviderConnection.TableFlag)

Sets a flag.

Parameters:

flag (QgsAbstractDatabaseProviderConnection.TableFlag)

setFlags(self, flags: QgsAbstractDatabaseProviderConnection.TableFlags | QgsAbstractDatabaseProviderConnection.TableFlag)

Sets the table flags.

Parameters:

flags (Union[QgsAbstractDatabaseProviderConnection.TableFlags, QgsAbstractDatabaseProviderConnection.TableFlag])

setGeometryColumn(self, geometryColumn: str | None)

Sets the geometry column name to geometryColumn.

Parameters:

geometryColumn (Optional[str])

setGeometryColumnCount(self, geometryColumnCount: int)

Sets the geometryColumnCount.

Parameters:

geometryColumnCount (int)

setGeometryColumnTypes(self, geometryColumnTypes: Iterable[QgsAbstractDatabaseProviderConnection.TableProperty.GeometryColumnType])

Sets the geometry column types to geometryColumnTypes.

Parameters:

geometryColumnTypes (Iterable[QgsAbstractDatabaseProviderConnection.TableProperty.GeometryColumnType])

setInfo(self, info: Dict[str, Any])

Sets additional information about the table to info.

Provider classes may use this property to store custom bits of information.

Parameters:

info (Dict[str, Any])

setPrimaryKeyColumns(self, primaryKeyColumns: Iterable[str | None])

Sets the primary key column names to primaryKeyColumns.

Parameters:

primaryKeyColumns (Iterable[Optional[str]])

setSchema(self, schema: str | None)

Sets the schema.

Parameters:

schema (Optional[str])

setTableName(self, name: str | None)

Sets the table name to name.

See also

defaultName()

Parameters:

name (Optional[str])

tableName(self) → str

Returns the table name.

See also

defaultName()

Return type:

str

Tables = 2048

UpdateRelationship = 536870912

Vacuum = 1024

Z = 2

addField(self, field: QgsField, schema: str | None, tableName: str | None)

Adds a field.

Parameters:

• field (QgsField) – specification of the new field

• schema (Optional[str]) – name of the schema (schema is ignored if not supported by the backend).

• tableName (Optional[str]) – name of the table

Note

it is responsibility of the caller to handle open layers and registry entries.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.16.

addFieldDomain(self, domain: QgsFieldDomain, schema: str | None)

Adds a new field domain to the database.

Parameters:

• domain (QgsFieldDomain) – field domain to add

• schema (Optional[str]) – name of the schema (schema is ignored if not supported by the backend).

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.26.

addRelationship(self, relationship: QgsWeakRelation)

Adds a new field relationship to the database.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.30.

Parameters:

relationship (QgsWeakRelation)

capabilities(self) → QgsAbstractDatabaseProviderConnection.Capabilities

Returns connection capabilities.

See also

capabilities2()

Return type:

QgsAbstractDatabaseProviderConnection.Capabilities

capabilities2(self) → Qgis.DatabaseProviderConnectionCapabilities2

Returns extended connection capabilities.

See also

capabilities()

Added in version 3.32.

Return type:

Qgis.DatabaseProviderConnectionCapabilities2

checkCapability(self, capability: QgsAbstractDatabaseProviderConnection.Capability)

Checks if capability is supported.

Raises:

QgsProviderConnectionException – if the capability is not supported

Parameters:

capability (QgsAbstractDatabaseProviderConnection.Capability)

checkCapability(self, capability: Qgis.DatabaseProviderConnectionCapability2)

Checks if capability is supported.

Raises:

QgsProviderConnectionException – if the capability is not supported

Parameters:

capability (Qgis.DatabaseProviderConnectionCapability2)

createSchema(self, name: str | None)

Creates a new schema with the specified name.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Parameters:

name (Optional[str])

createSpatialIndex(self, schema: str | None, name: str | None, options: QgsAbstractDatabaseProviderConnection.SpatialIndexOptions = QgsAbstractDatabaseProviderConnection.SpatialIndexOptions())

Creates a spatial index for the database table with given schema and name (schema is ignored if not supported by the backend).

The options argument can be used to provide extra options controlling the spatial index creation.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.14.

Parameters:

• schema (Optional[str])

• name (Optional[str])

• options (QgsAbstractDatabaseProviderConnection.SpatialIndexOptions = QgsAbstractDatabaseProviderConnection.SpatialIndexOptions())

createSqlVectorLayer(self, options: QgsAbstractDatabaseProviderConnection.SqlVectorLayerOptions) → QgsVectorLayer | None

Creates and returns a (possibly invalid) vector layer based on the sql statement and optional options.

Raises:

QgsProviderConnectionException – if any errors are encountered or if SQL layer creation is not supported.

Added in version 3.22.

Parameters:

options (QgsAbstractDatabaseProviderConnection.SqlVectorLayerOptions)

Return type:

Optional[QgsVectorLayer]

createVectorTable(self, schema: str | None, name: str | None, fields: QgsFields, wkbType: Qgis.WkbType, srs: QgsCoordinateReferenceSystem, overwrite: bool, options: Dict[str | None, Any] | None)

Creates an empty table with name in the given schema (schema is ignored if not supported by the backend).

Raises:

QgsProviderConnectionException – if any errors are encountered.

Parameters:

• schema (Optional[str])

• name (Optional[str])

• fields (QgsFields)

• wkbType (Qgis.WkbType)

• srs (QgsCoordinateReferenceSystem)

• overwrite (bool)

• options (Optional[Dict[Optional[str], Any]])

deleteField(self, fieldName: str | None, schema: str | None, tableName: str | None, force: bool = False)

Deletes the field with the specified name.

Parameters:

• fieldName (Optional[str]) – name of the field to be deleted

• schema (Optional[str]) – name of the schema (schema is ignored if not supported by the backend).

• tableName (Optional[str]) – name of the table

• force (bool = False) – if True, a DROP CASCADE will drop all related objects

Note

it is responsibility of the caller to handle open layers and registry entries.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.16.

deleteRelationship(self, relationship: QgsWeakRelation)

Deletes an existing relationship in the database.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.30.

Parameters:

relationship (QgsWeakRelation)

deleteSpatialIndex(self, schema: str | None, name: str | None, geometryColumn: str | None)

Deletes the existing spatial index for the database table with given schema, name and geometryColumn (schema and geometryColumn are ignored if not supported by the backend).

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.14.

Parameters:

• schema (Optional[str])

• name (Optional[str])

• geometryColumn (Optional[str])

dropRasterTable(self, schema: str | None, name: str | None)

Drops a raster table with given schema (schema is ignored if not supported by the backend) and name.

Note

It is responsibility of the caller to handle open layers and registry entries.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Parameters:

• schema (Optional[str])

• name (Optional[str])

dropSchema(self, name: str | None, force: bool = False)

Drops an entire schema with the specified name.

Parameters:

• name (Optional[str]) – name of the schema to be dropped

• force (bool = False) – if True, a DROP CASCADE will drop all related objects

Note

It is responsibility of the caller to handle open layers and registry entries.

Raises:

QgsProviderConnectionException – if any errors are encountered.

dropVectorTable(self, schema: str | None, name: str | None)

Drops a vector (or aspatial) table with given schema (schema is ignored if not supported by the backend) and name.

Note

It is responsibility of the caller to handle open layers and registry entries.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Parameters:

• schema (Optional[str])

• name (Optional[str])

execSql(self, sql: str | None, feedback: QgsFeedback | None = None) → QgsAbstractDatabaseProviderConnection.QueryResult

Executes raw sql and returns the (possibly empty) query results, optionally feedback can be provided.

See also

executeSql()

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.18.

Parameters:

• sql (Optional[str])

• feedback (Optional[QgsFeedback] = None)

Return type:

QgsAbstractDatabaseProviderConnection.QueryResult

executeSql(self, sql: str | None, feedback: QgsFeedback | None = None) → Any

Executes raw sql and returns the (possibly empty) list of results in a multi-dimensional array, optionally feedback can be provided.

See also

execSql()

Raises:

QgsProviderConnectionException – if any errors are encountered.

Parameters:

• sql (Optional[str])

• feedback (Optional[QgsFeedback] = None)

Return type:

Any

fieldDomain(self, name: str | None) → QgsFieldDomain | None

Returns the field domain with the specified name from the provider.

The caller takes ownership of the return object. Will return None if no matching field domain is found.

This is supported on providers with the Capability.RetrieveFieldDomain capability only.

Raises:

QgsProviderConnectionException – if any errors are encountered.

See also

fieldDomainNames()

Added in version 3.26.

Parameters:

name (Optional[str])

Return type:

Optional[QgsFieldDomain]

fieldDomainNames(self) → List[str]

Returns a list of field domain names present on the provider.

This is supported on providers with the Capability.ListFieldDomains capability only.

Raises:

QgsProviderConnectionException – if any errors are encountered.

See also

fieldDomain()

Added in version 3.26.

Return type:

List[str]

fields(self, schema: str | None, table: str | None, feedback: QgsFeedback | None = None) → QgsFields

Returns the fields of a table and schema.

Since QGIS 3.32 the optional feedback argument can be used to cancel the request.

Note

the default implementation creates a temporary vector layer, providers may choose to override this method for a greater efficiency of to overcome provider’s behavior when the layer does not expose all fields (GPKG for example hides geometry and primary key column).

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.16.

Parameters:

• schema (Optional[str])

• table (Optional[str])

• feedback (Optional[QgsFeedback] = None)

Return type:

QgsFields

geometryColumnCapabilities(self) → QgsAbstractDatabaseProviderConnection.GeometryColumnCapabilities

Returns connection geometry column capabilities (Z, M, SinglePart, Curves).

Added in version 3.16.

Return type:

QgsAbstractDatabaseProviderConnection.GeometryColumnCapabilities

illegalFieldNames(self) → Set[str]

Returns a list of field names which are considered illegal by the connection and should not be used when creating or altering fields.

Added in version 3.30.

Return type:

Set[str]

nativeTypes(self) → List[QgsVectorDataProvider.NativeType]

Returns a list of native types supported by the connection.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.16.

Return type:

List[QgsVectorDataProvider.NativeType]

providerKey(self) → str

Returns the provider key.

Added in version 3.16.

Return type:

str

queryBuilder(self) → QgsProviderSqlQueryBuilder | None

Returns a SQL query builder for the connection, which provides an interface for provider-specific creation of SQL queries.

The caller takes ownership of the returned object.

Added in version 3.28.

Return type:

Optional[QgsProviderSqlQueryBuilder]

relatedTableTypes(self) → List[str]

Returns a list of the related table types supported by the database format.

The related table type is a free-form string representing the type of related features, where the exact interpretation is format dependent. For instance, table types from GeoPackage relationships will directly reflect the categories from the GeoPackage related tables extension (i.e. “media”, “simple attributes”, “features”, “attributes” and “tiles”).

Added in version 3.30.

Return type:

List[str]

relationships(self, schema: str | None = '', tableName: str | None = '') → List[QgsWeakRelation]

Returns a list of relationships detected in the database.

This is supported on providers with the Capability.RetrieveRelationships capability only.

If a schema and/or tableName are specified, then only relationships where the specified table forms the left (or “parent” / “referenced”) side of the relationship are retrieved.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.28.

Parameters:

• schema (Optional[str] = '')

• tableName (Optional[str] = '')

Return type:

List[QgsWeakRelation]

renameField(self, schema: str | None, tableName: str | None, name: str | None, newName: str | None)

Renames an existing field.

Parameters:

• schema (Optional[str]) – name of the schema (schema is ignored if not supported by the backend).

• tableName (Optional[str]) – name of the table

• name (Optional[str]) – current name of field

• newName (Optional[str]) – new name for field

Note

it is responsibility of the caller to handle open layers and registry entries.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.28.

renameRasterTable(self, schema: str | None, name: str | None, newName: str | None)

Renames a raster table with given schema (schema is ignored if not supported by the backend) and name.

Note

It is responsibility of the caller to handle open layers and registry entries.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Parameters:

• schema (Optional[str])

• name (Optional[str])

• newName (Optional[str])

renameSchema(self, name: str | None, newName: str | None)

Renames a schema with the specified name. Raises a QgsProviderConnectionException if any errors are encountered.

Note

it is responsibility of the caller to handle open layers and registry entries.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Parameters:

• name (Optional[str])

• newName (Optional[str])

renameVectorTable(self, schema: str | None, name: str | None, newName: str | None)

Renames a vector or aspatial table with given schema (schema is ignored if not supported by the backend) and name.

Note

It is responsibility of the caller to handle open layers and registry entries.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Parameters:

• schema (Optional[str])

• name (Optional[str])

• newName (Optional[str])

schemas(self) → List[str]

Returns information about the existing schemas.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Return type:

List[str]

searchLayerMetadata(self, searchContext: QgsMetadataSearchContext, searchString: str | None = '', geographicExtent: QgsRectangle = QgsRectangle(), feedback: QgsFeedback | None = None) → List[QgsLayerMetadataProviderResult]

Search the stored layer metadata in the connection, optionally limiting the search to the metadata identifier, title, abstract, keywords and categories. searchContext context for the search searchString limit the search to metadata having an extent intersecting geographicExtent, an optional feedback can be used to monitor and control the search process.

The default implementation raises a QgsNotSupportedException, data providers may implement the search functionality.

A QgsProviderConnectionException is raised in case of errors happening during the search for providers that implement the search functionality.

Return type:

List[QgsLayerMetadataProviderResult]

Returns:

a (possibly empty) list of QgsLayerMetadataProviderResult, throws a QgsProviderConnectionException if any error occurred during the search.

Raises:

• QgsProviderConnectionException –

• QgsNotSupportedException –

Added in version 3.28.

Parameters:

• searchContext (QgsMetadataSearchContext)

• searchString (Optional[str] = '')

• geographicExtent (QgsRectangle = QgsRectangle())

• feedback (Optional[QgsFeedback] = None)

setFieldAlias(self, fieldName: str | None, schema: str | None, tableName: str | None, alias: str | None)

Sets the alias for the existing field with the specified name.

Parameters:

• fieldName (Optional[str]) – name of the field to be modified

• schema (Optional[str]) – name of the schema (schema is ignored if not supported by the backend).

• tableName (Optional[str]) – name of the table

• alias (Optional[str]) – alias to set for the field. Set to an empty string to remove a previously set alias.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.32.

setFieldComment(self, fieldName: str | None, schema: str | None, tableName: str | None, comment: str | None)

Sets the comment for the existing field with the specified name.

Parameters:

• fieldName (Optional[str]) – name of the field to be modified

• schema (Optional[str]) – name of the schema (schema is ignored if not supported by the backend).

• tableName (Optional[str]) – name of the table

• comment (Optional[str]) – comment to set for the field. Set to an empty string to remove a previously set comment.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.32.

setFieldDomainName(self, fieldName: str | None, schema: str | None, tableName: str | None, domainName: str | None)

Sets the field domain name for the existing field with the specified name.

Parameters:

• fieldName (Optional[str]) – name of the field to be modified

• schema (Optional[str]) – name of the schema (schema is ignored if not supported by the backend).

• tableName (Optional[str]) – name of the table

• domainName (Optional[str]) – name of the domain to set for the field. Must be an existing field domain (see fieldDomainNames()). Set to an empty string to remove a previously set domain.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.26.

spatialIndexExists(self, schema: str | None, name: str | None, geometryColumn: str | None) → bool

Determines whether a spatial index exists for the database table with given schema, name and geometryColumn (schema and geometryColumn are ignored if not supported by the backend).

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.14.

Parameters:

• schema (Optional[str])

• name (Optional[str])

• geometryColumn (Optional[str])

Return type:

bool

sqlDictionary(self) → Dict[Qgis.SqlKeywordCategory, List[List[str]]]

Returns a dictionary of SQL keywords supported by the provider. The default implementation returns an list of common reserved words under the “Keyword” and “Constant” categories.

Subclasses should add provider- and/or connection- specific words.

Added in version 3.22.

Return type:

Dict[Qgis.SqlKeywordCategory, List[List[str]]]

sqlLayerDefinitionCapabilities(self) → Qgis.SqlLayerDefinitionCapabilities

Returns SQL layer definition capabilities (Filters, GeometryColumn, PrimaryKeys).

Added in version 3.22.

Return type:

Qgis.SqlLayerDefinitionCapabilities

sqlOptions(self, layerSource: str | None) → QgsAbstractDatabaseProviderConnection.SqlVectorLayerOptions

Returns the SQL layer options from a layerSource.

Note

the default implementation returns a default constructed option object.

Raises:

QgsProviderConnectionException – if any errors are encountered or if SQL layer creation is not supported.

Added in version 3.22.

Parameters:

layerSource (Optional[str])

Return type:

QgsAbstractDatabaseProviderConnection.SqlVectorLayerOptions

supportedFieldDomainTypes(self) → List[Qgis.FieldDomainType]

Returns a list of field domain types which are supported by the provider.

Added in version 3.28.

Return type:

List[Qgis.FieldDomainType]

supportedRelationshipCapabilities(self) → Qgis.RelationshipCapabilities

Returns the relationship capabilities supported by the provider.

Added in version 3.30.

Return type:

Qgis.RelationshipCapabilities

supportedRelationshipCardinalities(self) → List[Qgis.RelationshipCardinality]

Returns a list of relationship cardinalities which are supported by the provider.

Added in version 3.30.

Return type:

List[Qgis.RelationshipCardinality]

supportedRelationshipStrengths(self) → List[Qgis.RelationshipStrength]

Returns a list of relationship strengths which are supported by the provider.

Added in version 3.30.

Return type:

List[Qgis.RelationshipStrength]

table(self, schema: str | None, table: str | None, feedback: QgsFeedback | None = None) → QgsAbstractDatabaseProviderConnection.TableProperty

Returns information on a table in the given schema.

Since QGIS 3.32 the optional feedback argument can be used to cancel the request.

Raises:

QgsProviderConnectionException – if any errors are encountered or if the table does not exist.

Note

Not available in Python bindings

Added in version 3.12.

Parameters:

• schema (Optional[str])

• table (Optional[str])

• feedback (Optional[QgsFeedback] = None)

Return type:

QgsAbstractDatabaseProviderConnection.TableProperty

tableExists(self, schema: str | None, name: str | None) → bool

Checks whether a table name exists in the given schema.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Parameters:

• schema (Optional[str])

• name (Optional[str])

Return type:

bool

tableUri(self, schema: str | None, name: str | None) → str

Returns the URI string for the given table and schema.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.12.

Parameters:

• schema (Optional[str])

• name (Optional[str])

Return type:

str

tables(self, schema: str | None = '', flags: int = 0) → List[QgsAbstractDatabaseProviderConnection.TableProperty]

Returns information on the tables in the given schema.

Parameters:

• schema (Optional[str] = '') – name of the schema (ignored if not supported by the backend)

• flags (int = 0) – filter tables by flags, this option completely overrides search options stored in the connection

Raises:

QgsProviderConnectionException – if any errors are encountered.

Return type:

List[QgsAbstractDatabaseProviderConnection.TableProperty]

updateRelationship(self, relationship: QgsWeakRelation)

Updates an existing relationship in the database.

Raises:

QgsProviderConnectionException – if any errors are encountered.

Added in version 3.30.

Parameters:

relationship (QgsWeakRelation)

vacuum(self, schema: str | None, name: str | None)

Vacuum the database table with given schema and name (schema is ignored if not supported by the backend).

Raises:

QgsProviderConnectionException – if any errors are encountered.

Parameters:

• schema (Optional[str])

• name (Optional[str])