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

#include <qgsabstractdatabaseproviderconnection.h>

Inheritance diagram for QgsAbstractDatabaseProviderConnection:

Classes
struct	SpatialIndexOptions
	Contains extra options relating to spatial index creation. 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 }
	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 }
	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 Raises a QgsProviderConnectionException if any errors are encountered. 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 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 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 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 geomerty column capabilities (Z, M, SinglePart, Curves) More...

virtual QList< QgsVectorDataProvider::NativeType >	nativeTypes () 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 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 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 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::TableProperty >	tables (const QString &schema=QString(), const QgsAbstractDatabaseProviderConnection::TableFlags &flags=QgsAbstractDatabaseProviderConnection::TableFlags()) const
	Returns information on the tables in the given schema. More...

QList< QgsAbstractDatabaseProviderConnection::TableProperty >	tablesInt (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...

Protected Attributes
Capabilities	mCapabilities = Capabilities()

GeometryColumnCapabilities	mGeometryColumnCapabilities = GeometryColumnCapabilities()

QString	mProviderKey

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 43 of file qgsabstractdatabaseproviderconnection.h.

Member Enumeration Documentation

◆ Capability

enum QgsAbstractDatabaseProviderConnection::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.

Definition at line 279 of file qgsabstractdatabaseproviderconnection.h.

◆ GeometryColumnCapability

enum QgsAbstractDatabaseProviderConnection::GeometryColumnCapability

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

Since: QGIS 3.16

Enumerator
Z
M	Supports Z dimension.
SinglePart	Supports M dimension.
Curves	Multi and single part types are distinct types.

Definition at line 311 of file qgsabstractdatabaseproviderconnection.h.

◆ TableFlag

enum QgsAbstractDatabaseProviderConnection::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 56 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 23 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 29 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 Raises a QgsProviderConnectionException if any errors are encountered.

Parameters

field	specification of the new field
schema	name of the schema (schema is ignored if not supported by the backend).
tableName	name of the table

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

Exceptions

fieldName	name of the field to be deleted
schema	name of the schema (schema is ignored if not supported by the backend).
tableName	name of the table
force	if `true`, a DROP CASCADE will drop all related objects

name	name of the schema to be dropped
force	if `true`, a DROP CASCADE will drop all related objects

schema	name of the schema (ignored if not supported by the backend)
flags	filter tables by flags, this option completely overrides search options stored in the connection

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

Classes

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Capability

◆ GeometryColumnCapability

◆ TableFlag

Constructor & Destructor Documentation

◆ QgsAbstractDatabaseProviderConnection() [1/2]

◆ QgsAbstractDatabaseProviderConnection() [2/2]

Member Function Documentation

◆ addField()

◆ capabilities()

◆ createSchema()

◆ createSpatialIndex()

◆ createVectorTable()

◆ deleteField()

◆ deleteSpatialIndex()

◆ dropRasterTable()

◆ dropSchema()

◆ dropVectorTable()

◆ executeSql()

◆ fields()

◆ geometryColumnCapabilities()

◆ nativeTypes()

◆ providerKey()

◆ renameRasterTable()

◆ renameSchema()

◆ renameVectorTable()

◆ schemas()

◆ spatialIndexExists()

◆ table()

◆ tableExists()

◆ tables()

◆ tablesInt()

◆ tableUri()

◆ vacuum()

Member Data Documentation

◆ mCapabilities

◆ mGeometryColumnCapabilities

◆ mProviderKey