QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Classes | Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
QgsAbstractDatabaseProviderConnection Class Referenceabstract

The QgsAbstractDatabaseProviderConnection class provides common functionality for DB based connections. More...

#include <qgsabstractdatabaseproviderconnection.h>

Inheritance diagram for QgsAbstractDatabaseProviderConnection:
Inheritance graph
[legend]

Classes

struct  QueryResult
 The QueryResult class represents the result of a query executed by execSql() More...
 
struct  SpatialIndexOptions
 The SpatialIndexOptions contains extra options relating to spatial index creation. More...
 
struct  SqlVectorLayerOptions
 The SqlVectorLayerOptions stores all information required to create a SQL (query) layer. More...
 
struct  TableProperty
 The TableProperty class represents a database table or view. More...
 

Public Types

enum  Capability {
  CreateVectorTable = 1 << 1 , DropRasterTable = 1 << 2 , DropVectorTable = 1 << 3 , RenameVectorTable = 1 << 4 ,
  RenameRasterTable = 1 << 5 , CreateSchema = 1 << 6 , DropSchema = 1 << 7 , RenameSchema = 1 << 8 ,
  ExecuteSql = 1 << 9 , Vacuum = 1 << 10 , Tables = 1 << 11 , Schemas = 1 << 12 ,
  SqlLayers = 1 << 13 , TableExists = 1 << 14 , Spatial = 1 << 15 , CreateSpatialIndex = 1 << 16 ,
  SpatialIndexExists = 1 << 17 , DeleteSpatialIndex = 1 << 18 , DeleteField = 1 << 19 , DeleteFieldCascade = 1 << 20 ,
  AddField = 1 << 21 , ListFieldDomains = 1 << 22 , RetrieveFieldDomain = 1 << 23 , SetFieldDomain = 1 << 24 ,
  AddFieldDomain = 1 << 25 , RenameField = 1 << 26 , RetrieveRelationships = 1 << 27
}
 The Capability enum represents the operations supported by the connection. More...
 
enum  GeometryColumnCapability {
  Z = 1 << 1 , M = 1 << 2 , SinglePart = 1 << 3 , Curves = 1 << 4 ,
  SinglePoint = 1 << 5 , SingleLineString = 1 << 6 , SinglePolygon = 1 << 7
}
 The GeometryColumnCapability enum represents the geomery column features supported by the connection. More...
 
enum  TableFlag {
  Aspatial = 1 << 1 , Vector = 1 << 2 , Raster = 1 << 3 , View = 1 << 4 ,
  MaterializedView = 1 << 5 , Foreign = 1 << 6
}
 Flags for table properties. More...
 

Public Member Functions

 QgsAbstractDatabaseProviderConnection (const QString &name)
 Creates a new connection with name by reading its configuration from the settings. More...
 
 QgsAbstractDatabaseProviderConnection (const QString &uri, const QVariantMap &configuration)
 Creates a new connection from the given uri and configuration. More...
 
virtual void addField (const QgsField &field, const QString &schema, const QString &tableName) const SIP_THROW(QgsProviderConnectionException)
 Adds a field. More...
 
virtual void addFieldDomain (const QgsFieldDomain &domain, const QString &schema) const SIP_THROW(QgsProviderConnectionException)
 Adds a new field domain to the database. More...
 
Capabilities capabilities () const
 Returns connection capabilities. More...
 
virtual void createSchema (const QString &name) const SIP_THROW(QgsProviderConnectionException)
 Creates a new schema with the specified name. More...
 
virtual void createSpatialIndex (const QString &schema, const QString &name, const QgsAbstractDatabaseProviderConnection::SpatialIndexOptions &options=QgsAbstractDatabaseProviderConnection::SpatialIndexOptions()) const SIP_THROW(QgsProviderConnectionException)
 Creates a spatial index for the database table with given schema and name (schema is ignored if not supported by the backend). More...
 
virtual QgsVectorLayercreateSqlVectorLayer (const SqlVectorLayerOptions &options) const SIP_THROW(QgsProviderConnectionException)
 Creates and returns a (possibly invalid) vector layer based on the sql statement and optional options. More...
 
virtual void createVectorTable (const QString &schema, const QString &name, const QgsFields &fields, QgsWkbTypes::Type wkbType, const QgsCoordinateReferenceSystem &srs, bool overwrite, const QMap< QString, QVariant > *options) const SIP_THROW(QgsProviderConnectionException)
 Creates an empty table with name in the given schema (schema is ignored if not supported by the backend). More...
 
virtual void deleteField (const QString &fieldName, const QString &schema, const QString &tableName, bool force=false) const SIP_THROW(QgsProviderConnectionException)
 Deletes the field with the specified name. More...
 
virtual void deleteSpatialIndex (const QString &schema, const QString &name, const QString &geometryColumn) const SIP_THROW(QgsProviderConnectionException)
 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). More...
 
virtual void dropRasterTable (const QString &schema, const QString &name) const SIP_THROW(QgsProviderConnectionException)
 Drops a raster table with given schema (schema is ignored if not supported by the backend) and name. More...
 
virtual void dropSchema (const QString &name, bool force=false) const SIP_THROW(QgsProviderConnectionException)
 Drops an entire schema with the specified name. More...
 
virtual void dropVectorTable (const QString &schema, const QString &name) const SIP_THROW(QgsProviderConnectionException)
 Drops a vector (or aspatial) table with given schema (schema is ignored if not supported by the backend) and name. More...
 
virtual QueryResult execSql (const QString &sql, QgsFeedback *feedback=nullptr) const SIP_THROW(QgsProviderConnectionException)
 Executes raw sql and returns the (possibly empty) query results, optionally feedback can be provided. More...
 
virtual QList< QList< QVariant > > executeSql (const QString &sql, QgsFeedback *feedback=nullptr) const SIP_THROW(QgsProviderConnectionException)
 Executes raw sql and returns the (possibly empty) list of results in a multi-dimensional array, optionally feedback can be provided. More...
 
virtual QgsFieldDomainfieldDomain (const QString &name) const SIP_THROW(QgsProviderConnectionException)
 Returns the field domain with the specified name from the provider. More...
 
virtual QStringList fieldDomainNames () const SIP_THROW(QgsProviderConnectionException)
 Returns a list of field domain names present on the provider. More...
 
virtual QgsFields fields (const QString &schema, const QString &table) const SIP_THROW(QgsProviderConnectionException)
 Returns the fields of a table and schema. More...
 
virtual GeometryColumnCapabilities geometryColumnCapabilities ()
 Returns connection geometry column capabilities (Z, M, SinglePart, Curves). More...
 
virtual QList< QgsVectorDataProvider::NativeTypenativeTypes () const SIP_THROW(QgsProviderConnectionException)=0
 Returns a list of native types supported by the connection. More...
 
QString providerKey () const
 Returns the provider key. More...
 
virtual QgsProviderSqlQueryBuilderqueryBuilder () const
 Returns a SQL query builder for the connection, which provides an interface for provider-specific creation of SQL queries. More...
 
virtual QList< QgsWeakRelationrelationships (const QString &schema=QString(), const QString &tableName=QString()) const SIP_THROW(QgsProviderConnectionException)
 Returns a list of relationships detected in the database. More...
 
virtual void renameField (const QString &schema, const QString &tableName, const QString &name, const QString &newName) const SIP_THROW(QgsProviderConnectionException)
 Renames an existing field. More...
 
virtual void renameRasterTable (const QString &schema, const QString &name, const QString &newName) const SIP_THROW(QgsProviderConnectionException)
 Renames a raster table with given schema (schema is ignored if not supported by the backend) and name. More...
 
virtual void renameSchema (const QString &name, const QString &newName) const SIP_THROW(QgsProviderConnectionException)
 Renames a schema with the specified name. More...
 
virtual void renameVectorTable (const QString &schema, const QString &name, const QString &newName) const SIP_THROW(QgsProviderConnectionException)
 Renames a vector or aspatial table with given schema (schema is ignored if not supported by the backend) and name. More...
 
virtual QStringList schemas () const SIP_THROW(QgsProviderConnectionException)
 Returns information about the existing schemas. More...
 
virtual QList< QgsLayerMetadataProviderResultsearchLayerMetadata (const QgsMetadataSearchContext &searchContext, const QString &searchString=QString(), const QgsRectangle &geographicExtent=QgsRectangle(), QgsFeedback *feedback=nullptr) const SIP_THROW(QgsProviderConnectionException
 Search the stored layer metadata in the connection, optionally limiting the search to the metadata identifier, title, abstract, keywords and categories. More...
 
virtual void setFieldDomainName (const QString &fieldName, const QString &schema, const QString &tableName, const QString &domainName) const SIP_THROW(QgsProviderConnectionException)
 Sets the field domain name for the existing field with the specified name. More...
 
virtual bool spatialIndexExists (const QString &schema, const QString &name, const QString &geometryColumn) const SIP_THROW(QgsProviderConnectionException)
 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). More...
 
virtual QMultiMap< Qgis::SqlKeywordCategory, QStringList > sqlDictionary ()
 Returns a dictionary of SQL keywords supported by the provider. More...
 
virtual Qgis::SqlLayerDefinitionCapabilities sqlLayerDefinitionCapabilities ()
 Returns SQL layer definition capabilities (Filters, GeometryColumn, PrimaryKeys). More...
 
virtual SqlVectorLayerOptions sqlOptions (const QString &layerSource) SIP_THROW(QgsProviderConnectionException)
 Returns the SQL layer options from a layerSource. More...
 
virtual QList< Qgis::FieldDomainTypesupportedFieldDomainTypes () const
 Returns a list of field domain types which are supported by the provider. More...
 
virtual QgsAbstractDatabaseProviderConnection::TableProperty table (const QString &schema, const QString &table) const SIP_THROW(QgsProviderConnectionException)
 Returns information on a table in the given schema. More...
 
virtual bool tableExists (const QString &schema, const QString &name) const SIP_THROW(QgsProviderConnectionException)
 Checks whether a table name exists in the given schema. More...
 
virtual QList< QgsAbstractDatabaseProviderConnection::TablePropertytables (const QString &schema=QString(), const QgsAbstractDatabaseProviderConnection::TableFlags &flags=QgsAbstractDatabaseProviderConnection::TableFlags()) const
 Returns information on the tables in the given schema. More...
 
QList< QgsAbstractDatabaseProviderConnection::TablePropertytablesInt (const QString &schema=QString(), const int flags=0) const SIP_THROW(QgsProviderConnectionException)
 Returns information on the tables in the given schema. More...
 
virtual QString tableUri (const QString &schema, const QString &name) const SIP_THROW(QgsProviderConnectionException)
 Returns the URI string for the given table and schema. More...
 
virtual void vacuum (const QString &schema, const QString &name) const SIP_THROW(QgsProviderConnectionException)
 Vacuum the database table with given schema and name (schema is ignored if not supported by the backend). More...
 
- Public Member Functions inherited from QgsAbstractProviderConnection
 QgsAbstractProviderConnection (const QString &name)
 Creates a new connection with name by reading its configuration from the settings. More...
 
 QgsAbstractProviderConnection (const QString &uri, const QVariantMap &configuration)
 Creates a new connection from the given uri and configuration. More...
 
virtual ~QgsAbstractProviderConnection ()=default
 
QVariantMap configuration () const
 Returns the connection configuration parameters. More...
 
virtual QIcon icon () const
 Returns an icon representing the connection. More...
 
virtual void remove (const QString &name) const =0
 Deletes the connection from the settings. More...
 
void setConfiguration (const QVariantMap &configuration)
 Sets the connection configuration. More...
 
void setUri (const QString &uri)
 Sets the connection data source URI to uri. More...
 
virtual void store (const QString &name) const =0
 Stores the connection in the settings. More...
 
QString uri () const
 Returns the connection data source URI string representation. More...
 

Public Attributes

virtual QList< QgsLayerMetadataProviderResultQgsNotSupportedException
 

Protected Attributes

Capabilities mCapabilities = Capabilities()
 
GeometryColumnCapabilities mGeometryColumnCapabilities = GeometryColumnCapabilities()
 
QString mProviderKey
 
Qgis::SqlLayerDefinitionCapabilities mSqlLayerDefinitionCapabilities = Qgis::SqlLayerDefinitionCapabilities()
 

Detailed Description

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.

Since
QGIS 3.10

Definition at line 47 of file qgsabstractdatabaseproviderconnection.h.

Member Enumeration Documentation

◆ Capability

The Capability enum represents the operations supported by the connection.

Enumerator
CreateVectorTable 

Can CREATE a vector (or aspatial) table/layer.

DropRasterTable 

Can DROP a raster table/layer.

DropVectorTable 

Can DROP a vector (or aspatial) table/layer.

RenameVectorTable 

Can RENAME a vector (or aspatial) table/layer.

RenameRasterTable 

Can RENAME a raster table/layer.

CreateSchema 

Can CREATE a schema.

DropSchema 

Can DROP a schema.

RenameSchema 

Can RENAME a schema.

ExecuteSql 

Can execute raw SQL queries (without returning results)

Vacuum 

Can run vacuum.

Tables 

Can list tables.

Schemas 

Can list schemas (if not set, the connection does not support schemas)

SqlLayers 

Can create vector layers from SQL SELECT queries.

TableExists 

Can check if table exists.

Spatial 

The connection supports spatial tables.

CreateSpatialIndex 

The connection can create spatial indices.

SpatialIndexExists 

The connection can determine if a spatial index exists.

DeleteSpatialIndex 

The connection can delete spatial indices for tables.

DeleteField 

Can delete an existing field/column.

DeleteFieldCascade 

Can delete an existing field/column with cascade.

AddField 

Can add a new field/column.

ListFieldDomains 

Can return a list of field domain names via fieldDomainNames() (since QGIS 3.26)

RetrieveFieldDomain 

Can retrieve field domain details from provider via fieldDomain() (since QGIS 3.26)

SetFieldDomain 

Can set the domain for an existing field via setFieldDomainName() (since QGIS 3.26)

AddFieldDomain 

Can add new field domains to the database via addFieldDomain() (since QGIS 3.26)

RenameField 

Can rename existing fields via renameField() (since QGIS 3.28)

RetrieveRelationships 

Can retrieve relationships from the database (since QGIS 3.28)

Definition at line 482 of file qgsabstractdatabaseproviderconnection.h.

◆ GeometryColumnCapability

The GeometryColumnCapability enum represents the geomery column features supported by the connection.

Since
QGIS 3.16
Enumerator

Supports Z dimension.

Supports M dimension.

SinglePart 

Multi and single part types are distinct types. Deprecated since QGIS 3.28 – use the granular SinglePoint/SingleLineString/SinglePolygon capabilities instead.

Curves 

Supports curves.

SinglePoint 

Supports single point types (as distinct from multi point types) (since QGIS 3.28)

SingleLineString 

Supports single linestring types (as distinct from multi line types) (since QGIS 3.28)

SinglePolygon 

Supports single polygon types (as distinct from multi polygon types) (since QGIS 3.28)

Definition at line 521 of file qgsabstractdatabaseproviderconnection.h.

◆ TableFlag

Flags for table properties.

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

Enumerator
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.

Definition at line 60 of file qgsabstractdatabaseproviderconnection.h.

Constructor & Destructor Documentation

◆ QgsAbstractDatabaseProviderConnection() [1/2]

QgsAbstractDatabaseProviderConnection::QgsAbstractDatabaseProviderConnection ( const QString &  name)

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.

Definition at line 26 of file qgsabstractdatabaseproviderconnection.cpp.

◆ QgsAbstractDatabaseProviderConnection() [2/2]

QgsAbstractDatabaseProviderConnection::QgsAbstractDatabaseProviderConnection ( const QString &  uri,
const QVariantMap &  configuration 
)

Creates a new connection from the given uri and configuration.

The connection is not automatically stored in the settings.

See also
store()

Definition at line 32 of file qgsabstractdatabaseproviderconnection.cpp.

Member Function Documentation

◆ addField()

void QgsAbstractDatabaseProviderConnection::addField ( const QgsField field,
const QString &  schema,
const QString &  tableName 
) const
virtual

Adds a field.

Parameters
fieldspecification of the new field
schemaname of the schema (schema is ignored if not supported by the backend).
tableNamename of the table
Note
it is responsibility of the caller to handle open layers and registry entries.
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.16

Definition at line 1178 of file qgsabstractdatabaseproviderconnection.cpp.

◆ addFieldDomain()

void QgsAbstractDatabaseProviderConnection::addFieldDomain ( const QgsFieldDomain domain,
const QString &  schema 
) const
virtual

Adds a new field domain to the database.

Parameters
domainfield domain to add
schemaname of the schema (schema is ignored if not supported by the backend).
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.26

Definition at line 1332 of file qgsabstractdatabaseproviderconnection.cpp.

◆ capabilities()

QgsAbstractDatabaseProviderConnection::Capabilities QgsAbstractDatabaseProviderConnection::capabilities ( ) const

Returns connection capabilities.

Definition at line 37 of file qgsabstractdatabaseproviderconnection.cpp.

◆ createSchema()

void QgsAbstractDatabaseProviderConnection::createSchema ( const QString &  name) const
virtual

Creates a new schema with the specified name.

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1098 of file qgsabstractdatabaseproviderconnection.cpp.

◆ createSpatialIndex()

void QgsAbstractDatabaseProviderConnection::createSpatialIndex ( const QString &  schema,
const QString &  name,
const QgsAbstractDatabaseProviderConnection::SpatialIndexOptions options = QgsAbstractDatabaseProviderConnection::SpatialIndexOptions() 
) const
virtual

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.

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.14

Definition at line 1131 of file qgsabstractdatabaseproviderconnection.cpp.

◆ createSqlVectorLayer()

QgsVectorLayer * QgsAbstractDatabaseProviderConnection::createSqlVectorLayer ( const SqlVectorLayerOptions options) const
virtual

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

Exceptions
QgsProviderConnectionExceptionif any errors are encountered or if SQL layer creation is not supported.
Since
QGIS 3.22

Definition at line 1136 of file qgsabstractdatabaseproviderconnection.cpp.

◆ createVectorTable()

void QgsAbstractDatabaseProviderConnection::createVectorTable ( const QString &  schema,
const QString &  name,
const QgsFields fields,
QgsWkbTypes::Type  wkbType,
const QgsCoordinateReferenceSystem srs,
bool  overwrite,
const QMap< QString, QVariant > *  options 
) const
virtual

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

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1028 of file qgsabstractdatabaseproviderconnection.cpp.

◆ deleteField()

void QgsAbstractDatabaseProviderConnection::deleteField ( const QString &  fieldName,
const QString &  schema,
const QString &  tableName,
bool  force = false 
) const
virtual

Deletes the field with the specified name.

Parameters
fieldNamename of the field to be deleted
schemaname of the schema (schema is ignored if not supported by the backend).
tableNamename of the table
forceif true, a DROP CASCADE will drop all related objects
Note
it is responsibility of the caller to handle open layers and registry entries.
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.16

Definition at line 1153 of file qgsabstractdatabaseproviderconnection.cpp.

◆ deleteSpatialIndex()

void QgsAbstractDatabaseProviderConnection::deleteSpatialIndex ( const QString &  schema,
const QString &  name,
const QString &  geometryColumn 
) const
virtual

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).

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.14

Definition at line 1142 of file qgsabstractdatabaseproviderconnection.cpp.

◆ dropRasterTable()

void QgsAbstractDatabaseProviderConnection::dropRasterTable ( const QString &  schema,
const QString &  name 
) const
virtual

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.
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1093 of file qgsabstractdatabaseproviderconnection.cpp.

◆ dropSchema()

void QgsAbstractDatabaseProviderConnection::dropSchema ( const QString &  name,
bool  force = false 
) const
virtual

Drops an entire schema with the specified name.

Parameters
namename of the schema to be dropped
forceif true, a DROP CASCADE will drop all related objects
Note
It is responsibility of the caller to handle open layers and registry entries.
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1103 of file qgsabstractdatabaseproviderconnection.cpp.

◆ dropVectorTable()

void QgsAbstractDatabaseProviderConnection::dropVectorTable ( const QString &  schema,
const QString &  name 
) const
virtual

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.
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1064 of file qgsabstractdatabaseproviderconnection.cpp.

◆ execSql()

QgsAbstractDatabaseProviderConnection::QueryResult QgsAbstractDatabaseProviderConnection::execSql ( const QString &  sql,
QgsFeedback feedback = nullptr 
) const
virtual

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

See also
executeSql()
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.18

Definition at line 1119 of file qgsabstractdatabaseproviderconnection.cpp.

◆ executeSql()

QList< QList< QVariant > > QgsAbstractDatabaseProviderConnection::executeSql ( const QString &  sql,
QgsFeedback feedback = nullptr 
) const
virtual

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

See also
execSql()
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1113 of file qgsabstractdatabaseproviderconnection.cpp.

◆ fieldDomain()

QgsFieldDomain * QgsAbstractDatabaseProviderConnection::fieldDomain ( const QString &  name) const
virtual

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

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

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

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
See also
fieldDomainNames()
Since
QGIS 3.26

Definition at line 1321 of file qgsabstractdatabaseproviderconnection.cpp.

◆ fieldDomainNames()

QStringList QgsAbstractDatabaseProviderConnection::fieldDomainNames ( ) const
virtual

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

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

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
See also
fieldDomain()
Since
QGIS 3.26

Definition at line 1315 of file qgsabstractdatabaseproviderconnection.cpp.

◆ fields()

QgsFields QgsAbstractDatabaseProviderConnection::fields ( const QString &  schema,
const QString &  table 
) const
virtual

Returns the fields of a table and schema.

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).
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.16

Definition at line 1299 of file qgsabstractdatabaseproviderconnection.cpp.

◆ geometryColumnCapabilities()

QgsAbstractDatabaseProviderConnection::GeometryColumnCapabilities QgsAbstractDatabaseProviderConnection::geometryColumnCapabilities ( )
virtual

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

Since
QGIS 3.16

Definition at line 42 of file qgsabstractdatabaseproviderconnection.cpp.

◆ nativeTypes()

virtual QList< QgsVectorDataProvider::NativeType > QgsAbstractDatabaseProviderConnection::nativeTypes ( ) const
pure virtual

Returns a list of native types supported by the connection.

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.16

◆ providerKey()

QString QgsAbstractDatabaseProviderConnection::providerKey ( ) const

Returns the provider key.

Since
QGIS 3.16

◆ queryBuilder()

QgsProviderSqlQueryBuilder * QgsAbstractDatabaseProviderConnection::queryBuilder ( ) const
virtual

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.

Since
QGIS 3.28

Definition at line 1023 of file qgsabstractdatabaseproviderconnection.cpp.

◆ relationships()

QList< QgsWeakRelation > QgsAbstractDatabaseProviderConnection::relationships ( const QString &  schema = QString(),
const QString &  tableName = QString() 
) const
virtual

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.

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.28

Definition at line 1337 of file qgsabstractdatabaseproviderconnection.cpp.

◆ renameField()

void QgsAbstractDatabaseProviderConnection::renameField ( const QString &  schema,
const QString &  tableName,
const QString &  name,
const QString &  newName 
) const
virtual

Renames an existing field.

Parameters
schemaname of the schema (schema is ignored if not supported by the backend).
tableNamename of the table
namecurrent name of field
newNamenew name for field
Note
it is responsibility of the caller to handle open layers and registry entries.
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.28

Definition at line 1203 of file qgsabstractdatabaseproviderconnection.cpp.

◆ renameRasterTable()

void QgsAbstractDatabaseProviderConnection::renameRasterTable ( const QString &  schema,
const QString &  name,
const QString &  newName 
) const
virtual

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.
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1059 of file qgsabstractdatabaseproviderconnection.cpp.

◆ renameSchema()

void QgsAbstractDatabaseProviderConnection::renameSchema ( const QString &  name,
const QString &  newName 
) const
virtual

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.
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1108 of file qgsabstractdatabaseproviderconnection.cpp.

◆ renameVectorTable()

void QgsAbstractDatabaseProviderConnection::renameVectorTable ( const QString &  schema,
const QString &  name,
const QString &  newName 
) const
virtual

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.
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1047 of file qgsabstractdatabaseproviderconnection.cpp.

◆ schemas()

QStringList QgsAbstractDatabaseProviderConnection::schemas ( ) const
virtual

Returns information about the existing schemas.

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1263 of file qgsabstractdatabaseproviderconnection.cpp.

◆ searchLayerMetadata()

QList< QgsLayerMetadataProviderResult > QgsAbstractDatabaseProviderConnection::searchLayerMetadata ( const QgsMetadataSearchContext searchContext,
const QString &  searchString = QString(),
const QgsRectangle geographicExtent = QgsRectangle(),
QgsFeedback feedback = nullptr 
) const
virtual

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.

Returns
a (possibly empty) list of QgsLayerMetadataProviderResult, throws a QgsProviderConnectionException if any error occurred during the search.
Exceptions
QgsProviderConnectionException
QgsNotSupportedException
Since
QGIS 3.28

Definition at line 1084 of file qgsabstractdatabaseproviderconnection.cpp.

◆ setFieldDomainName()

void QgsAbstractDatabaseProviderConnection::setFieldDomainName ( const QString &  fieldName,
const QString &  schema,
const QString &  tableName,
const QString &  domainName 
) const
virtual

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

Parameters
fieldNamename of the field to be modified
schemaname of the schema (schema is ignored if not supported by the backend).
tableNamename of the table
domainNamename 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.
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.26

Definition at line 1327 of file qgsabstractdatabaseproviderconnection.cpp.

◆ spatialIndexExists()

bool QgsAbstractDatabaseProviderConnection::spatialIndexExists ( const QString &  schema,
const QString &  name,
const QString &  geometryColumn 
) const
virtual

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).

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.14

Definition at line 1147 of file qgsabstractdatabaseproviderconnection.cpp.

◆ sqlDictionary()

QMultiMap< Qgis::SqlKeywordCategory, QStringList > QgsAbstractDatabaseProviderConnection::sqlDictionary ( )
virtual

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.

Since
QGIS 3.22

Definition at line 80 of file qgsabstractdatabaseproviderconnection.cpp.

◆ sqlLayerDefinitionCapabilities()

Qgis::SqlLayerDefinitionCapabilities QgsAbstractDatabaseProviderConnection::sqlLayerDefinitionCapabilities ( )
virtual

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

Since
QGIS 3.22

Definition at line 47 of file qgsabstractdatabaseproviderconnection.cpp.

◆ sqlOptions()

QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions QgsAbstractDatabaseProviderConnection::sqlOptions ( const QString &  layerSource)
virtual

Returns the SQL layer options from a layerSource.

Note
the default implementation returns a default constructed option object.
Exceptions
QgsProviderConnectionExceptionif any errors are encountered or if SQL layer creation is not supported.
Since
QGIS 3.22

Definition at line 1053 of file qgsabstractdatabaseproviderconnection.cpp.

◆ supportedFieldDomainTypes()

QList< Qgis::FieldDomainType > QgsAbstractDatabaseProviderConnection::supportedFieldDomainTypes ( ) const
virtual

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

Since
QGIS 3.28

Definition at line 1018 of file qgsabstractdatabaseproviderconnection.cpp.

◆ table()

QgsAbstractDatabaseProviderConnection::TableProperty QgsAbstractDatabaseProviderConnection::table ( const QString &  schema,
const QString &  table 
) const
virtual

Returns information on a table in the given schema.

Exceptions
QgsProviderConnectionExceptionif any errors are encountered or if the table does not exist.
Note
Not available in Python bindings
Since
QGIS 3.12

Definition at line 1242 of file qgsabstractdatabaseproviderconnection.cpp.

◆ tableExists()

bool QgsAbstractDatabaseProviderConnection::tableExists ( const QString &  schema,
const QString &  name 
) const
virtual

Checks whether a table name exists in the given schema.

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1069 of file qgsabstractdatabaseproviderconnection.cpp.

◆ tables()

QList< QgsAbstractDatabaseProviderConnection::TableProperty > QgsAbstractDatabaseProviderConnection::tables ( const QString &  schema = QString(),
const QgsAbstractDatabaseProviderConnection::TableFlags &  flags = QgsAbstractDatabaseProviderConnection::TableFlags() 
) const
virtual

Returns information on the tables in the given schema.

Parameters
schemaname of the schema (ignored if not supported by the backend)
flagsfilter tables by flags, this option completely overrides search options stored in the connection
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Note
Not available in Python bindings

Definition at line 1235 of file qgsabstractdatabaseproviderconnection.cpp.

◆ tablesInt()

QList< QgsAbstractDatabaseProviderConnection::TableProperty > QgsAbstractDatabaseProviderConnection::tablesInt ( const QString &  schema = QString(),
const int  flags = 0 
) const

Returns information on the tables in the given schema.

Parameters
schemaname of the schema (ignored if not supported by the backend)
flagsfilter tables by flags, this option completely overrides search options stored in the connection
Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1257 of file qgsabstractdatabaseproviderconnection.cpp.

◆ tableUri()

QString QgsAbstractDatabaseProviderConnection::tableUri ( const QString &  schema,
const QString &  name 
) const
virtual

Returns the URI string for the given table and schema.

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.
Since
QGIS 3.12

Definition at line 53 of file qgsabstractdatabaseproviderconnection.cpp.

◆ vacuum()

void QgsAbstractDatabaseProviderConnection::vacuum ( const QString &  schema,
const QString &  name 
) const
virtual

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

Exceptions
QgsProviderConnectionExceptionif any errors are encountered.

Definition at line 1126 of file qgsabstractdatabaseproviderconnection.cpp.

Member Data Documentation

◆ mCapabilities

Capabilities QgsAbstractDatabaseProviderConnection::mCapabilities = Capabilities()
protected

Definition at line 952 of file qgsabstractdatabaseproviderconnection.h.

◆ mGeometryColumnCapabilities

GeometryColumnCapabilities QgsAbstractDatabaseProviderConnection::mGeometryColumnCapabilities = GeometryColumnCapabilities()
protected

Definition at line 953 of file qgsabstractdatabaseproviderconnection.h.

◆ mProviderKey

QString QgsAbstractDatabaseProviderConnection::mProviderKey
protected

Definition at line 955 of file qgsabstractdatabaseproviderconnection.h.

◆ mSqlLayerDefinitionCapabilities

Qgis::SqlLayerDefinitionCapabilities QgsAbstractDatabaseProviderConnection::mSqlLayerDefinitionCapabilities = Qgis::SqlLayerDefinitionCapabilities()
protected

Definition at line 954 of file qgsabstractdatabaseproviderconnection.h.

◆ QgsNotSupportedException

virtual QList< QgsLayerMetadataProviderResult > QgsAbstractDatabaseProviderConnection::QgsNotSupportedException

Definition at line 938 of file qgsabstractdatabaseproviderconnection.h.


The documentation for this class was generated from the following files: