mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-31 00:06:02 -04:00
147 lines
6.2 KiB
Python
147 lines
6.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
ExecuteSQL.py -- use virtual layers to execute SQL on any sources
|
|
---------------------
|
|
Date : Jan 2016
|
|
Copyright : (C) 2016 by Hugo Mercier
|
|
Email : hugo dot mercier at oslandia dot com
|
|
***************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
***************************************************************************
|
|
"""
|
|
|
|
__author__ = 'Hugo Mercier'
|
|
__date__ = 'January 2016'
|
|
__copyright__ = '(C) 2016, Hugo Mercier'
|
|
|
|
# This will get replaced with a git SHA1 when you do a git archive323
|
|
|
|
__revision__ = '$Format:%H$'
|
|
|
|
from qgis.core import (QgsVirtualLayerDefinition,
|
|
QgsVectorLayer,
|
|
QgsWkbTypes,
|
|
QgsProcessingParameterMultipleLayers,
|
|
QgsProcessingParameterString,
|
|
QgsProcessingParameterEnum,
|
|
QgsProcessingParameterCrs,
|
|
QgsProcessingParameterFeatureSink,
|
|
QgsFeatureSink,
|
|
QgsProcessingException)
|
|
|
|
from processing.algs.qgis.QgisAlgorithm import QgisAlgorithm
|
|
|
|
|
|
class ExecuteSQL(QgisAlgorithm):
|
|
|
|
""" This algorithm allows executing an SQL query on a set of input
|
|
vector layers thanks to the virtual layer provider
|
|
"""
|
|
|
|
INPUT_DATASOURCES = 'INPUT_DATASOURCES'
|
|
INPUT_QUERY = 'INPUT_QUERY'
|
|
INPUT_UID_FIELD = 'INPUT_UID_FIELD'
|
|
INPUT_GEOMETRY_FIELD = 'INPUT_GEOMETRY_FIELD'
|
|
INPUT_GEOMETRY_TYPE = 'INPUT_GEOMETRY_TYPE'
|
|
INPUT_GEOMETRY_CRS = 'INPUT_GEOMETRY_CRS'
|
|
OUTPUT = 'OUTPUT'
|
|
|
|
def group(self):
|
|
return self.tr('Vector general')
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
def initAlgorithm(self, config=None):
|
|
self.addParameter(QgsProcessingParameterMultipleLayers(name=self.INPUT_DATASOURCES,
|
|
description=self.tr('Additional input datasources (called input1, .., inputN in the query)'),
|
|
optional=True))
|
|
|
|
self.addParameter(QgsProcessingParameterString(name=self.INPUT_QUERY,
|
|
description=self.tr('SQL query'),
|
|
multiLine=True))
|
|
|
|
self.addParameter(QgsProcessingParameterString(name=self.INPUT_UID_FIELD,
|
|
description=self.tr('Unique identifier field'), optional=True))
|
|
|
|
self.addParameter(QgsProcessingParameterString(name=self.INPUT_GEOMETRY_FIELD,
|
|
description=self.tr('Geometry field'), optional=True))
|
|
|
|
self.geometryTypes = [
|
|
self.tr('Autodetect'),
|
|
self.tr('No geometry'),
|
|
'Point',
|
|
'LineString',
|
|
'Polygon',
|
|
'MultiPoint',
|
|
'MultiLineString',
|
|
'MultiPolygon']
|
|
self.addParameter(QgsProcessingParameterEnum(self.INPUT_GEOMETRY_TYPE,
|
|
self.tr('Geometry type'), options=self.geometryTypes, optional=True))
|
|
|
|
self.addParameter(QgsProcessingParameterCrs(self.INPUT_GEOMETRY_CRS,
|
|
self.tr('CRS'), optional=True))
|
|
|
|
self.addParameter(QgsProcessingParameterFeatureSink(self.OUTPUT, self.tr('SQL Output')))
|
|
|
|
def name(self):
|
|
return 'executesql'
|
|
|
|
def displayName(self):
|
|
return self.tr('Execute SQL')
|
|
|
|
def processAlgorithm(self, parameters, context, feedback):
|
|
layers = self.parameterAsLayerList(parameters, self.INPUT_DATASOURCES, context)
|
|
query = self.parameterAsString(parameters, self.INPUT_QUERY, context)
|
|
uid_field = self.parameterAsString(parameters, self.INPUT_UID_FIELD, context)
|
|
geometry_field = self.parameterAsString(parameters, self.INPUT_GEOMETRY_FIELD, context)
|
|
geometry_type = self.parameterAsEnum(parameters, self.INPUT_GEOMETRY_TYPE, context)
|
|
geometry_crs = self.parameterAsCrs(parameters, self.INPUT_GEOMETRY_CRS, context)
|
|
|
|
df = QgsVirtualLayerDefinition()
|
|
for layerIdx, layer in enumerate(layers):
|
|
df.addSource('input{}'.format(layerIdx + 1), layer.id())
|
|
|
|
if query == '':
|
|
raise QgsProcessingException(
|
|
self.tr('Empty SQL. Please enter valid SQL expression and try again.'))
|
|
else:
|
|
df.setQuery(query)
|
|
|
|
if uid_field:
|
|
df.setUid(uid_field)
|
|
|
|
if geometry_type == 1: # no geometry
|
|
df.setGeometryWkbType(QgsWkbTypes.NullGeometry)
|
|
else:
|
|
if geometry_field:
|
|
df.setGeometryField(geometry_field)
|
|
if geometry_type > 1:
|
|
df.setGeometryWkbType(geometry_type - 1)
|
|
if geometry_crs.isValid():
|
|
df.setGeometrySrid(geometry_crs.postgisSrid())
|
|
|
|
vLayer = QgsVectorLayer(df.toString(), "temp_vlayer", "virtual")
|
|
if not vLayer.isValid():
|
|
raise QgsProcessingException(vLayer.dataProvider().error().message())
|
|
|
|
(sink, dest_id) = self.parameterAsSink(parameters, self.OUTPUT, context,
|
|
vLayer.fields(), vLayer.wkbType() if geometry_type != 1 else 1, vLayer.crs())
|
|
|
|
features = vLayer.getFeatures()
|
|
total = 100.0 / vLayer.featureCount() if vLayer.featureCount() else 0
|
|
for current, inFeat in enumerate(features):
|
|
if feedback.isCanceled():
|
|
break
|
|
|
|
sink.addFeature(inFeat, QgsFeatureSink.FastInsert)
|
|
feedback.setProgress(int(current * total))
|
|
return {self.OUTPUT: dest_id}
|