Class to manipulate the definition of a virtual layer. More...

#include <qgsvirtuallayerdefinition.h>

Classes
class	SourceLayer
	A SourceLayer is either a reference to a live layer in the registry or all the parameters needed to load it (provider key, source, etc.) More...

Public Types
typedef QList< SourceLayer >	SourceLayers
	List of source layers. More...

Public Member Functions
	QgsVirtualLayerDefinition (const QString &filePath="")
	Constructor with an optional file path. More...

void	addSource (const QString &name, const QString &ref)
	Add a live layer source layer. More...

void	addSource (const QString &name, const QString &source, const QString &provider, const QString &encoding="")
	Add a layer with a source, a provider and an encoding. More...

const QgsFields &	fields () const
	Get field definitions. More...

QString	filePath () const
	Get the file path. May be empty. More...

QString	geometryField () const
	Get the name of the geometry field. Empty if no geometry field. More...

long	geometrySrid () const
	Get the SRID of the geometry. More...

QgsWKBTypes::Type	geometryWkbType () const
	Get the type of the geometry QgsWKBTypes::NoGeometry to hide any geometry QgsWKBTypes::Unknown for unknown types. More...

bool	hasDefinedGeometry () const
	Convenient method to test if the geometry is defined (not NoGeometry and not Unknown) More...

bool	hasReferencedLayers () const
	Convenience method to test whether the definition has referenced (live) layers. More...

bool	hasSourceLayer (const QString &name) const
	Convenience method to test if a given source layer is part of the definition. More...

QString	query () const
	Get the SQL query. More...

void	setFields (const QgsFields &fields)
	Set field definitions. More...

void	setFilePath (const QString &filePath)
	Set the file path. More...

void	setGeometryField (const QString &geometryField)
	Set the name of the geometry field. More...

void	setGeometrySrid (long srid)
	Set the SRID of the geometry. More...

void	setGeometryWkbType (QgsWKBTypes::Type t)
	Set the type of the geometry. More...

void	setQuery (const QString &query)
	Set the SQL query. More...

void	setUid (const QString &uid)
	Set the name of the field with unique identifiers. More...

const SourceLayers &	sourceLayers () const
	Get access to the source layers. More...

QString	toString () const
	Convert into a QString that can be read by the virtual layer provider. More...

QUrl	toUrl () const
	Convert the definition into a QUrl. More...

QString	uid () const
	Get the name of the field with unique identifiers. More...

Static Public Member Functions
static QgsVirtualLayerDefinition	fromUrl (const QUrl &url)
	Constructor to build a definition from a QUrl The path part of the URL is extracted as well as the following optional keys: layer_ref=layer_id[:name] represents a live layer referenced by its ID. More...

Detailed Description

Class to manipulate the definition of a virtual layer.

It is used to extract parameters from an initial virtual layer definition as well as to store the complete, expanded definition once types have been detected.

Definition at line 29 of file qgsvirtuallayerdefinition.h.

Member Typedef Documentation

◆ SourceLayers

typedef QList<SourceLayer> QgsVirtualLayerDefinition::SourceLayers

List of source layers.

Definition at line 108 of file qgsvirtuallayerdefinition.h.

Constructor & Destructor Documentation

◆ QgsVirtualLayerDefinition()

QgsVirtualLayerDefinition::QgsVirtualLayerDefinition ( const QString & filePath = "" )

Constructor with an optional file path.

Definition at line 25 of file qgsvirtuallayerdefinition.cpp.

Member Function Documentation

◆ addSource() [1/2]

void QgsVirtualLayerDefinition::addSource	(	const QString &	name,
		const QString &	ref
	)

Add a live layer source layer.

Definition at line 222 of file qgsvirtuallayerdefinition.cpp.

◆ addSource() [2/2]

void QgsVirtualLayerDefinition::addSource	(	const QString &	name,
		const QString &	source,
		const QString &	provider,
		const QString &	encoding = `""`
	)

Add a layer with a source, a provider and an encoding.

Definition at line 227 of file qgsvirtuallayerdefinition.cpp.

◆ fields()

const QgsFields& QgsVirtualLayerDefinition::fields ( ) const

inline

Get field definitions.

Definition at line 146 of file qgsvirtuallayerdefinition.h.

◆ filePath()

QString QgsVirtualLayerDefinition::filePath ( ) const

inline

Get the file path. May be empty.

Definition at line 119 of file qgsvirtuallayerdefinition.h.

◆ fromUrl()

QgsVirtualLayerDefinition QgsVirtualLayerDefinition::fromUrl ( const QUrl & url )

static

Constructor to build a definition from a QUrl The path part of the URL is extracted as well as the following optional keys: layer_ref=layer_id[:name] represents a live layer referenced by its ID.

An optional name can be given layer=provider:source[:name[:encoding]] represents a layer given by its provider key, its source url (URL-encoded). An optional name and encoding can be given geometry=column_name[:type:srid] gives the definition of the geometry column. Type can be either a WKB type code or a string (point, linestring, etc.) srid is an integer uid=column_name is the name of a column with unique integer values. nogeometry is a flag to force the layer to be a non-geometry layer query=sql represents the SQL query. Must be URL-encoded field=column_name:[int|real|text] represents a field with its name and its type

Definition at line 32 of file qgsvirtuallayerdefinition.cpp.