QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Attributes | List of all members
QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions Struct Reference

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

#include <qgsabstractdatabaseproviderconnection.h>

Public Attributes

bool disableSelectAtId = false
 If SelectAtId is disabled (default is false), not all data providers support this feature: check support with SqlLayerDefinitionCapability::SelectAtId capability.
 
QString filter
 Additional subset string (provider-side filter), not all data providers support this feature: check support with SqlLayerDefinitionCapability::Filters capability.
 
QString geometryColumn
 Name of the geometry column.
 
QString layerName
 Optional name for the new layer.
 
QStringList primaryKeyColumns
 List of primary key column names.
 
QString sql
 The SQL expression that defines the SQL (query) layer.
 

Detailed Description

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

See also
createSqlVectorLayer()
Since
QGIS 3.22

Definition at line 241 of file qgsabstractdatabaseproviderconnection.h.

Member Data Documentation

◆ disableSelectAtId

bool QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions::disableSelectAtId = false

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

Definition at line 254 of file qgsabstractdatabaseproviderconnection.h.

◆ filter

QString QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions::filter

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

Definition at line 246 of file qgsabstractdatabaseproviderconnection.h.

◆ geometryColumn

QString QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions::geometryColumn

Name of the geometry column.

Definition at line 252 of file qgsabstractdatabaseproviderconnection.h.

◆ layerName

QString QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions::layerName

Optional name for the new layer.

Definition at line 248 of file qgsabstractdatabaseproviderconnection.h.

◆ primaryKeyColumns

QStringList QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions::primaryKeyColumns

List of primary key column names.

Definition at line 250 of file qgsabstractdatabaseproviderconnection.h.

◆ sql

QString QgsAbstractDatabaseProviderConnection::SqlVectorLayerOptions::sql

The SQL expression that defines the SQL (query) layer.

Definition at line 244 of file qgsabstractdatabaseproviderconnection.h.


The documentation for this struct was generated from the following file: