Class: QgsVectorLayerExporterTask

class qgis.core.QgsVectorLayerExporterTask(layer: QgsVectorLayer, uri: str, providerKey: str, destinationCrs: QgsCoordinateReferenceSystem, options: Dict[str, Any] = {}, ownsLayer: bool = False)

Bases: QgsTask

Constructor for QgsVectorLayerExporterTask. Takes a source layer, destination uri and providerKey, and various export related parameters such as destination CRS and export options. ownsLayer has to be set to True if the task should take ownership of the layer and delete it after export.

QgsTask task which performs a QgsVectorLayerExporter layer export operation as a background task. This can be used to export a vector layer out to a provider without blocking the QGIS interface.

New in version 3.0.

Parameters
cancel(self)
childEvent()
connectNotify()
customEvent()
disconnectNotify()
errorOccurred

Emitted when an error occurs which prevented the layer being exported (or if the task is canceled). The export error and errorMessage will be reported. [signal]

Parameters
  • error (int) –

  • errorMessage (str) –

exportComplete

Emitted when exporting the layer is successfully completed. [signal]

finished(self, result: bool)
Parameters

result (bool) –

isCanceled()
isSignalConnected()
receivers()
run(self) → bool
Return type

bool

sender()
senderSignalIndex()
setProgress()
timerEvent()
withLayerOwnership(layer: QgsVectorLayer, uri: str, providerKey: str, destinationCrs: QgsCoordinateReferenceSystem, options: Dict[str, Any] = {}) → QgsVectorLayerExporterTask

Creates a new QgsVectorLayerExporterTask which has ownership over a source layer. When the export task has completed (successfully or otherwise) layer will be deleted. The destination uri and providerKey, and various export related parameters such as destination CRS and export options must be specified.

Parameters
Return type

QgsVectorLayerExporterTask