Skip to content

Commit 338ee36

Browse files
nyalldawsonnyalldawson
committed
Port Execute SQL to new API, add test
1 parent 99fd727 commit 338ee36

File tree

5 files changed

+118
-58
lines changed

5 files changed

+118
-58
lines changed

‎python/plugins/processing/algs/qgis/ExecuteSQL.py

+44-56
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,18 @@
2525

2626
__revision__ = '$Format:%H$'
2727

28-
from qgis.core import (QgsFeature,
29-
QgsVirtualLayerDefinition,
28+
from qgis.core import (QgsVirtualLayerDefinition,
3029
QgsVectorLayer,
31-
QgsCoordinateReferenceSystem,
3230
QgsWkbTypes,
33-
QgsApplication,
34-
QgsProcessingUtils)
31+
QgsProcessingParameterMultipleLayers,
32+
QgsProcessingParameterString,
33+
QgsProcessingParameterEnum,
34+
QgsProcessingParameterCrs,
35+
QgsProcessingParameterFeatureSink,
36+
QgsFeatureSink,
37+
QgsProcessingException)
3538

3639
from processing.algs.qgis.QgisAlgorithm import QgisAlgorithm
37-
from processing.core.GeoAlgorithmExecutionException import GeoAlgorithmExecutionException
38-
from processing.core.parameters import ParameterString
39-
from processing.core.parameters import ParameterMultipleInput
40-
from processing.core.parameters import ParameterCrs
41-
from processing.core.parameters import ParameterSelection
42-
from processing.core.outputs import OutputVector
4340

4441

4542
class ExecuteSQL(QgisAlgorithm):
@@ -54,7 +51,7 @@ class ExecuteSQL(QgisAlgorithm):
5451
INPUT_GEOMETRY_FIELD = 'INPUT_GEOMETRY_FIELD'
5552
INPUT_GEOMETRY_TYPE = 'INPUT_GEOMETRY_TYPE'
5653
INPUT_GEOMETRY_CRS = 'INPUT_GEOMETRY_CRS'
57-
OUTPUT_LAYER = 'OUTPUT_LAYER'
54+
OUTPUT = 'OUTPUT'
5855

5956
def group(self):
6057
return self.tr('Vector general tools')
@@ -63,19 +60,19 @@ def __init__(self):
6360
super().__init__()
6461

6562
def initAlgorithm(self, config=None):
66-
self.addParameter(ParameterMultipleInput(name=self.INPUT_DATASOURCES,
67-
description=self.tr('Additional input datasources (called input1, .., inputN in the query)'),
68-
optional=True))
63+
self.addParameter(QgsProcessingParameterMultipleLayers(name=self.INPUT_DATASOURCES,
64+
description=self.tr('Additional input datasources (called input1, .., inputN in the query)'),
65+
optional=True))
6966

70-
self.addParameter(ParameterString(name=self.INPUT_QUERY,
71-
description=self.tr('SQL query'),
72-
multiline=True))
67+
self.addParameter(QgsProcessingParameterString(name=self.INPUT_QUERY,
68+
description=self.tr('SQL query'),
69+
multiLine=True))
7370

74-
self.addParameter(ParameterString(name=self.INPUT_UID_FIELD,
75-
description=self.tr('Unique identifier field'), optional=True))
71+
self.addParameter(QgsProcessingParameterString(name=self.INPUT_UID_FIELD,
72+
description=self.tr('Unique identifier field'), optional=True))
7673

77-
self.addParameter(ParameterString(name=self.INPUT_GEOMETRY_FIELD,
78-
description=self.tr('Geometry field'), optional=True))
74+
self.addParameter(QgsProcessingParameterString(name=self.INPUT_GEOMETRY_FIELD,
75+
description=self.tr('Geometry field'), optional=True))
7976

8077
self.geometryTypes = [
8178
self.tr('Autodetect'),
@@ -86,13 +83,13 @@ def initAlgorithm(self, config=None):
8683
'MultiPoint',
8784
'MultiLineString',
8885
'MultiPolygon']
89-
self.addParameter(ParameterSelection(self.INPUT_GEOMETRY_TYPE,
90-
self.tr('Geometry type'), self.geometryTypes, optional=True))
86+
self.addParameter(QgsProcessingParameterEnum(self.INPUT_GEOMETRY_TYPE,
87+
self.tr('Geometry type'), options=self.geometryTypes, optional=True))
9188

92-
self.addParameter(ParameterCrs(self.INPUT_GEOMETRY_CRS,
93-
self.tr('CRS'), optional=True))
89+
self.addParameter(QgsProcessingParameterCrs(self.INPUT_GEOMETRY_CRS,
90+
self.tr('CRS'), optional=True))
9491

95-
self.addOutput(OutputVector(self.OUTPUT_LAYER, self.tr('SQL Output')))
92+
self.addParameter(QgsProcessingParameterFeatureSink(self.OUTPUT, self.tr('SQL Output')))
9693

9794
def name(self):
9895
return 'executesql'
@@ -101,24 +98,19 @@ def displayName(self):
10198
return self.tr('Execute SQL')
10299

103100
def processAlgorithm(self, parameters, context, feedback):
104-
layers = self.getParameterValue(self.INPUT_DATASOURCES)
105-
query = self.getParameterValue(self.INPUT_QUERY)
106-
uid_field = self.getParameterValue(self.INPUT_UID_FIELD)
107-
geometry_field = self.getParameterValue(self.INPUT_GEOMETRY_FIELD)
108-
geometry_type = self.getParameterValue(self.INPUT_GEOMETRY_TYPE)
109-
geometry_crs = self.getParameterValue(self.INPUT_GEOMETRY_CRS)
101+
layers = self.parameterAsLayerList(parameters, self.INPUT_DATASOURCES, context)
102+
query = self.parameterAsString(parameters, self.INPUT_QUERY, context)
103+
uid_field = self.parameterAsString(parameters, self.INPUT_UID_FIELD, context)
104+
geometry_field = self.parameterAsString(parameters, self.INPUT_GEOMETRY_FIELD, context)
105+
geometry_type = self.parameterAsEnum(parameters, self.INPUT_GEOMETRY_TYPE, context)
106+
geometry_crs = self.parameterAsCrs(parameters, self.INPUT_GEOMETRY_CRS, context)
110107

111108
df = QgsVirtualLayerDefinition()
112-
layerIdx = 1
113-
if layers:
114-
for layerSource in layers.split(';'):
115-
layer = QgsProcessingUtils.mapLayerFromString(layerSource, context)
116-
if layer:
117-
df.addSource('input{}'.format(layerIdx), layer.id())
118-
layerIdx += 1
109+
for layerIdx, layer in enumerate(layers):
110+
df.addSource('input{}'.format(layerIdx + 1), layer.id())
119111

120112
if query == '':
121-
raise GeoAlgorithmExecutionException(
113+
raise QgsProcessingException(
122114
self.tr('Empty SQL. Please enter valid SQL expression and try again.'))
123115
else:
124116
df.setQuery(query)
@@ -133,26 +125,22 @@ def processAlgorithm(self, parameters, context, feedback):
133125
df.setGeometryField(geometry_field)
134126
if geometry_type > 1:
135127
df.setGeometryWkbType(geometry_type - 1)
136-
if geometry_crs:
137-
crs = QgsCoordinateReferenceSystem(geometry_crs)
138-
if crs.isValid():
139-
df.setGeometrySrid(crs.postgisSrid())
128+
if geometry_crs.isValid():
129+
df.setGeometrySrid(geometry_crs.postgisSrid())
140130

141131
vLayer = QgsVectorLayer(df.toString(), "temp_vlayer", "virtual")
142132
if not vLayer.isValid():
143-
raise GeoAlgorithmExecutionException(vLayer.dataProvider().error().message())
133+
raise QgsProcessingException(vLayer.dataProvider().error().message())
144134

145-
writer = self.getOutputFromName(self.OUTPUT_LAYER).getVectorWriter(vLayer.fields(),
146-
vLayer.wkbType() if geometry_type != 1 else 1,
147-
vLayer.crs(), context)
135+
(sink, dest_id) = self.parameterAsSink(parameters, self.OUTPUT, context,
136+
vLayer.fields(), vLayer.wkbType() if geometry_type != 1 else 1, vLayer.crs())
148137

149-
features = QgsProcessingUtils.getFeatures(vLayer, context)
138+
features = vLayer.getFeatures()
150139
total = 100.0 / vLayer.featureCount() if vLayer.featureCount() else 0
151-
outFeat = QgsFeature()
152140
for current, inFeat in enumerate(features):
153-
outFeat.setAttributes(inFeat.attributes())
154-
if geometry_type != 1:
155-
outFeat.setGeometry(inFeat.geometry())
156-
writer.addFeature(outFeat, QgsFeatureSink.FastInsert)
141+
if feedback.isCanceled():
142+
break
143+
144+
sink.addFeature(inFeat, QgsFeatureSink.FastInsert)
157145
feedback.setProgress(int(current * total))
158-
del writer
146+
return {self.OUTPUT: dest_id}

‎python/plugins/processing/algs/qgis/QGISAlgorithmProvider.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@
6565
from .DropMZValues import DropMZValues
6666
from .EliminateSelection import EliminateSelection
6767
from .EquivalentNumField import EquivalentNumField
68+
from .ExecuteSQL import ExecuteSQL
6869
from .Explode import Explode
6970
from .ExportGeometryInfo import ExportGeometryInfo
7071
from .ExtendLines import ExtendLines
@@ -172,7 +173,6 @@
172173
# from .GeometryConvert import GeometryConvert
173174
# from .SelectByAttributeSum import SelectByAttributeSum
174175
# from .RasterCalculator import RasterCalculator
175-
# from .ExecuteSQL import ExecuteSQL
176176

177177
pluginPath = os.path.normpath(os.path.join(
178178
os.path.split(os.path.dirname(__file__))[0], os.pardir))
@@ -193,7 +193,7 @@ def getAlgs(self):
193193
# GeometryConvert(),
194194
# SelectByAttributeSum()
195195
# RasterCalculator(),
196-
# ExecuteSQL(),
196+
#
197197
# ]
198198
algs = [AddTableField(),
199199
Aggregate(),
@@ -220,6 +220,7 @@ def getAlgs(self):
220220
DropMZValues(),
221221
EliminateSelection(),
222222
EquivalentNumField(),
223+
ExecuteSQL(),
223224
Explode(),
224225
ExportGeometryInfo(),
225226
ExtendLines(),

‎python/plugins/processing/tests/testdata/expected/execute_sql.gfs

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<GMLFeatureClassList>
2+
<GMLFeatureClass>
3+
<Name>execute_sql</Name>
4+
<ElementPath>execute_sql</ElementPath>
5+
<!--POINT-->
6+
<GeometryType>1</GeometryType>
7+
<SRSName>EPSG:4326</SRSName>
8+
<DatasetSpecificInfo>
9+
<FeatureCount>2</FeatureCount>
10+
<ExtentXMin>1.00000</ExtentXMin>
11+
<ExtentXMax>5.00000</ExtentXMax>
12+
<ExtentYMin>1.00000</ExtentYMin>
13+
<ExtentYMax>2.00000</ExtentYMax>
14+
</DatasetSpecificInfo>
15+
<PropertyDefn>
16+
<Name>id</Name>
17+
<ElementPath>id</ElementPath>
18+
<Type>Integer</Type>
19+
</PropertyDefn>
20+
<PropertyDefn>
21+
<Name>id2</Name>
22+
<ElementPath>id2</ElementPath>
23+
<Type>Integer</Type>
24+
</PropertyDefn>
25+
</GMLFeatureClass>
26+
</GMLFeatureClassList>

‎python/plugins/processing/tests/testdata/expected/execute_sql.gml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="utf-8" ?>
2+
<ogr:FeatureCollection
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation=""
5+
xmlns:ogr="http://ogr.maptools.org/"
6+
xmlns:gml="http://www.opengis.net/gml">
7+
<gml:boundedBy>
8+
<gml:Box>
9+
<gml:coord><gml:X>1</gml:X><gml:Y>1</gml:Y></gml:coord>
10+
<gml:coord><gml:X>5</gml:X><gml:Y>2</gml:Y></gml:coord>
11+
</gml:Box>
12+
</gml:boundedBy>
13+
14+
<gml:featureMember>
15+
<ogr:execute_sql fid="points.0">
16+
<ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>1,1</gml:coordinates></gml:Point></ogr:geometryProperty>
17+
<ogr:id>1</ogr:id>
18+
<ogr:id2>2</ogr:id2>
19+
</ogr:execute_sql>
20+
</gml:featureMember>
21+
<gml:featureMember>
22+
<ogr:execute_sql fid="points.3">
23+
<ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>5,2</gml:coordinates></gml:Point></ogr:geometryProperty>
24+
<ogr:id>4</ogr:id>
25+
<ogr:id2>2</ogr:id2>
26+
</ogr:execute_sql>
27+
</gml:featureMember>
28+
</ogr:FeatureCollection>

‎python/plugins/processing/tests/testdata/qgis_algorithm_tests.yaml

+17
Original file line numberDiff line numberDiff line change
@@ -3210,3 +3210,20 @@ tests:
32103210
OUTPUT:
32113211
name: expected/pycalculator_points.gml
32123212
type: vector
3213+
3214+
- algorithm: qgis:executesql
3215+
name: Test execute SQL
3216+
params:
3217+
INPUT_DATASOURCES:
3218+
params:
3219+
- name: points.gml
3220+
type: vector
3221+
type: multi
3222+
INPUT_GEOMETRY_FIELD: ''
3223+
INPUT_GEOMETRY_TYPE: 0
3224+
INPUT_QUERY: select * from input1 where id2=2
3225+
INPUT_UID_FIELD: ''
3226+
results:
3227+
OUTPUT:
3228+
name: expected/execute_sql.gml
3229+
type: vector

0 commit comments

Comments
 (0)