28#include "moc_qgsvectorlayerexporter.cpp"
36#include <QProgressDialog>
45 QMap<int, int> *oldToNewAttrIdx,
46 QString *errorMessage,
47 const QMap<QString, QVariant> *options
57 mTransformContext = context;
62 return mTransformContext;
67 mDestinationCrs =
crs;
72 return mDestinationCrs;
87 mFilterExpression = expression;
92 return mFilterExpression;
97 mExpressionContext = context;
102 return mExpressionContext;
107 return mOutputFields;
112 mOutputFields = fields;
121 const QString &providerKey,
126 const QMap<QString, QVariant> &options,
129 , mAttributeCount( -1 )
134 QMap<QString, QVariant> modifiedOptions( options );
136 if ( providerKey == QLatin1String(
"ogr" ) &&
137 options.contains( QStringLiteral(
"driverName" ) ) &&
138 ( options[ QStringLiteral(
"driverName" ) ].toString().compare( QLatin1String(
"GPKG" ), Qt::CaseInsensitive ) == 0 ||
139 options[ QStringLiteral(
"driverName" ) ].toString().compare( QLatin1String(
"SQLite" ), Qt::CaseInsensitive ) == 0 ) )
146 QStringList modifiedLayerOptions;
147 if ( options.contains( QStringLiteral(
"layerOptions" ) ) )
149 const QStringList layerOptions = options.value( QStringLiteral(
"layerOptions" ) ).toStringList();
150 for (
const QString &layerOption : layerOptions )
152 if ( layerOption.compare( QLatin1String(
"SPATIAL_INDEX=YES" ), Qt::CaseInsensitive ) == 0 ||
153 layerOption.compare( QLatin1String(
"SPATIAL_INDEX=ON" ), Qt::CaseInsensitive ) == 0 ||
154 layerOption.compare( QLatin1String(
"SPATIAL_INDEX=TRUE" ), Qt::CaseInsensitive ) == 0 ||
155 layerOption.compare( QLatin1String(
"SPATIAL_INDEX=1" ), Qt::CaseInsensitive ) == 0 )
159 else if ( layerOption.compare( QLatin1String(
"SPATIAL_INDEX=NO" ), Qt::CaseInsensitive ) == 0 ||
160 layerOption.compare( QLatin1String(
"SPATIAL_INDEX=OFF" ), Qt::CaseInsensitive ) == 0 ||
161 layerOption.compare( QLatin1String(
"SPATIAL_INDEX=FALSE" ), Qt::CaseInsensitive ) == 0 ||
162 layerOption.compare( QLatin1String(
"SPATIAL_INDEX=0" ), Qt::CaseInsensitive ) == 0 )
164 mCreateSpatialIndex =
false;
168 modifiedLayerOptions << layerOption;
172 modifiedLayerOptions << QStringLiteral(
"SPATIAL_INDEX=FALSE" );
173 modifiedOptions[ QStringLiteral(
"layerOptions" ) ] = modifiedLayerOptions;
181 mError = pReg->
createEmptyLayer( providerKey, uri, fields, geometryType,
crs, overwrite, mOldToNewAttrIdx,
182 errMsg, !modifiedOptions.isEmpty() ? &modifiedOptions :
nullptr, uriUpdated );
186 mErrorMessage = errMsg;
190 const auto constMOldToNewAttrIdx = mOldToNewAttrIdx;
191 for (
const int idx : constMOldToNewAttrIdx )
193 if ( idx > mAttributeCount )
194 mAttributeCount = idx;
203 if ( providerKey == QLatin1String(
"oracle" ) )
213 mErrorMessage = QObject::tr(
"Loading of layer failed" );
215 delete vectorProvider;
227 const QString fidName = options.value( QStringLiteral(
"FID" ), QStringLiteral(
"FID" ) ).toString();
231 mOldToNewAttrIdx.remove( fidIdx );
235 mProvider = vectorProvider;
243 if ( mCreateSpatialIndex )
245 createSpatialIndex();
258 return mErrorMessage;
268 QgsFeatureList::iterator fIt = features.begin();
270 for ( ; fIt != features.end(); ++fIt )
287 for (
int i = 0; i < attrs.count(); ++i )
291 const int dstIdx = mOldToNewAttrIdx.value( i, -1 );
295 QgsDebugMsgLevel( QStringLiteral(
"moving field from pos %1 to %2" ).arg( i ).arg( dstIdx ), 3 );
299 mFeatureBuffer.append( newFeat );
302 if ( mFeatureBufferMemoryUsage >= 100 * 1000 * 1000 )
312 return mErrorMessage;
317 mFeatureBufferMemoryUsage = 0;
318 if ( mFeatureBuffer.count() <= 0 )
323 const QStringList errors = mProvider->
errors();
326 mErrorMessage = QObject::tr(
"Creation error for features from #%1 to #%2. Provider errors were: \n%3" )
327 .arg( mFeatureBuffer.first().id() )
328 .arg( mFeatureBuffer.last().id() )
329 .arg( errors.join( QLatin1Char(
'\n' ) ) );
332 mErrorCount += mFeatureBuffer.count();
334 mFeatureBuffer.clear();
339 mFeatureBuffer.clear();
343bool QgsVectorLayerExporter::createSpatialIndex()
345 mCreateSpatialIndex =
false;
358 const QString &providerKey,
361 QString *errorMessage,
362 const QMap<QString, QVariant> &options,
378 bool shallTransform =
false;
387 shallTransform =
true;
392 outputCRS = layer->
crs();
395 QMap<QString, QVariant> providerOptions = _providerOptions;
396 const bool overwrite = providerOptions.take( QStringLiteral(
"overwrite" ) ).toBool();
397 const bool forceSinglePartGeom = providerOptions.take( QStringLiteral(
"forceSinglePartGeometryType" ) ).toBool();
400 bool useFieldMapping =
false;
401 QList<QgsExpression> expressions;
404 outputFields = layer->
fields();
408 useFieldMapping =
true;
409 const QList<QgsVectorLayerExporter::OutputField> exportFieldDefinitions = exportOptions.
outputFields();
412 outputFields.
append( field.field );
414 expressions.last().prepare( &expressionContext );
415 if ( expressions.last().hasParserError() )
418 *
errorMessage = QObject::tr(
"Parser error for field \"%1\" with expression \"%2\": %3" )
422 expressions.last().parserErrorString()
431 bool convertGeometryToSinglePart =
false;
435 convertGeometryToSinglePart =
true;
438 auto writer = std::make_unique< QgsVectorLayerExporter >(
439 uri, providerKey, outputFields, wkbType, outputCRS, overwrite, providerOptions );
463 shallTransform =
false;
481 QgsDebugError( QStringLiteral(
"Could not transform filter extent: %1" ).arg( e.
what() ) );
505 bool canceled =
false;
516 *
errorMessage +=
'\n' + QObject::tr(
"Import was canceled at %1 of %2" ).arg( n ).arg( approxTotal );
521 if ( writer->errorCount() > 1000 )
525 *
errorMessage +=
'\n' + QObject::tr(
"Stopping after %n error(s)",
nullptr, writer->errorCount() );
531 outputFeature.
setId( sourceFeature.
id() );
534 if ( shallTransform )
547 const QString msg = QObject::tr(
"Failed to transform feature with ID '%1'. Writing stopped. (Exception: %2)" )
548 .arg( sourceFeature.
id() ).arg( e.
what() );
563 const QgsGeometryCollection *
c = qgsgeometry_cast<const QgsGeometryCollection *>( singlePartGeometry.constGet() );
564 if ( (
c &&
c->partCount() > 1 ) || ! singlePartGeometry.convertToSingleType() )
566 const QString msg = QObject::tr(
"Failed to transform a feature with ID '%1' to single part. Writing stopped." )
567 .arg( sourceFeature.
id() );
577 if ( useFieldMapping )
580 attributes.reserve( expressions.size() );
581 for (
auto it = expressions.begin(); it != expressions.end(); ++it )
585 expressionContext.
setFeature( sourceFeature );
586 const QVariant value = it->evaluate( &expressionContext );
587 if ( it->hasEvalError() )
589 const QString msg = QObject::tr(
"Evaluation error in expression \"%1\": %2" ).arg( it->expression(), it->evalErrorString() );
595 attributes.append( value );
599 attributes.append( QVariant() );
609 if ( !writer->addFeature( outputFeature ) )
620 feedback->
setProgress( 100.0 *
static_cast< double >( n ) /
static_cast< double >( approxTotal ) );
626 if ( !writer->flushBuffer() )
633 const int errors = writer->errorCount();
635 if ( writer->mCreateSpatialIndex && !writer->createSpatialIndex() )
649 *
errorMessage +=
'\n' + QObject::tr(
"Only %1 of %2 features written." ).arg( n - errors ).arg( n );
659 else if ( errors > 0 )
670 :
QgsTask( tr(
"Exporting %1" ).arg( layer->name() ),
QgsTask::CanCancel )
672 , mOwnsLayer( ownsLayer )
674 , mDestProviderKey( providerKey )
675 , mOptions( options )
686 :
QgsTask( tr(
"Exporting %1" ).arg( layer->name() ),
QgsTask::CanCancel )
688 , mOwnsLayer( ownsLayer )
690 , mDestProviderKey( providerKey )
691 , mExportOptions( exportOptions )
692 , mOptions( providerOptions )
697 if ( mLayer && mOwnsLayer )
698 mLayer->moveToThread(
nullptr );
703 auto newTask = std::make_unique<QgsVectorLayerExporterTask>( layer, uri, providerKey, destinationCrs, options,
true );
704 return newTask.release();
709 mOwnedFeedback->cancel();
719 mLayer->moveToThread( QThread::currentThread() );
725 mLayer.data(), mDestUri, mDestProviderKey, mExportOptions, &mErrorMessage,
726 mOptions, mOwnedFeedback.get() );
729 mLayer->moveToThread(
nullptr );
736 if ( mOwnsLayer && mLayer )
737 mLayer->moveToThread( QThread::currentThread() );
@ AddFeatures
Allows adding features.
@ CreateSpatialIndex
Allows creation of spatial index.
VectorExportResult
Vector layer export result codes.
@ Success
No errors were encountered.
@ ErrorInvalidLayer
Could not access newly created destination layer.
@ ErrorFeatureWriteFailed
An error occurred while writing a feature to the destination.
@ ErrorAttributeCreationFailed
Destination provider was unable to create an attribute.
@ UserCanceled
User canceled the export.
@ ErrorProjectingFeatures
An error occurred while reprojecting features to destination CRS.
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
QFlags< VectorDataProviderAttributeEditCapability > VectorDataProviderAttributeEditCapabilities
Attribute editing capabilities which may be supported by vector data providers.
WkbType
The WKB type describes the number of dimensions a geometry has.
Represents a coordinate reference system (CRS).
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
Contains information about the context in which a coordinate transform is executed.
Custom exception class for Coordinate Reference System related exceptions.
virtual bool isValid() const =0
Returns true if this is a valid layer.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
Handles parsing and evaluation of expressions (formerly called "search strings").
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
Wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFlags(Qgis::FeatureRequestFlags flags)
Sets flags that affect how features will be fetched.
QgsFeatureRequest & setFilterFids(const QgsFeatureIds &fids)
Sets the feature IDs that should be fetched.
QgsFeatureRequest & setFilterExpression(const QString &expression)
Set the filter expression.
QgsFeatureRequest & setExpressionContext(const QgsExpressionContext &context)
Sets the expression context used to evaluate filter expressions.
QgsFeatureRequest & setFilterRect(const QgsRectangle &rectangle)
Sets the rectangle from which features will be taken.
QFlags< SinkFlag > SinkFlags
@ FastInsert
Use faster inserts, at the cost of updating the passed features to reflect changes made at the provid...
@ RegeneratePrimaryKey
This flag indicates, that a primary key field cannot be guaranteed to be unique and the sink should i...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Q_INVOKABLE bool setAttribute(int field, const QVariant &attr)
Sets an attribute's value by field index.
void initAttributes(int fieldCount)
Initialize this feature with the given number of fields.
int approximateMemoryUsage() const
Returns the approximate RAM usage of the feature, in bytes.
void setAttributes(const QgsAttributes &attrs)
Sets the feature's attributes.
void setId(QgsFeatureId id)
Sets the feature id for this feature.
bool hasGeometry() const
Returns true if the feature has an associated geometry.
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
bool isCanceled() const
Tells whether the operation has been canceled already.
void progressChanged(double progress)
Emitted when the feedback object reports a progress change.
void setProgress(double progress)
Sets the current progress for the feedback object.
Container of fields for a vector layer.
bool append(const QgsField &field, Qgis::FieldOrigin origin=Qgis::FieldOrigin::Provider, int originIndex=-1)
Appends a field.
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
A geometry is the spatial representation of a feature.
Qgis::GeometryOperationResult transform(const QgsCoordinateTransform &ct, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward, bool transformZ=false)
Transforms this geometry as described by the coordinate transform ct.
bool isMultipart() const
Returns true if WKB of the geometry is of WKBMulti* type.
QgsCoordinateReferenceSystem crs
QgsCoordinateTransformContext transformContext() const
Returns the layer data provider coordinate transform context or a default transform context if the la...
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true, const char *file=__builtin_FILE(), const char *function=__builtin_FUNCTION(), int line=__builtin_LINE())
Adds a message to the log instance (and creates it if necessary).
A registry / canonical manager of data providers.
QVariantMap decodeUri(const QString &providerKey, const QString &uri)
Breaks a provider data source URI into its component paths (e.g.
Qgis::VectorExportResult createEmptyLayer(const QString &providerKey, const QString &uri, const QgsFields &fields, Qgis::WkbType wkbType, const QgsCoordinateReferenceSystem &srs, bool overwrite, QMap< int, int > &oldToNewAttrIdxMap, QString &errorMessage, const QMap< QString, QVariant > *options, QString &createdLayerName)
Creates new empty vector layer.
static QgsProviderRegistry * instance(const QString &pluginPath=QString())
Means of accessing canonical single instance.
QgsDataProvider * createProvider(const QString &providerKey, const QString &dataSource, const QgsDataProvider::ProviderOptions &options=QgsDataProvider::ProviderOptions(), Qgis::DataProviderReadFlags flags=Qgis::DataProviderReadFlags())
Creates a new instance of a provider.
A rectangle specified with double values.
QgsCoordinateReferenceSystem crs() const
Returns the associated coordinate reference system, or an invalid CRS if no reference system is set.
A QgsRectangle with associated coordinate reference system.
Abstract base class for long running background tasks.
virtual void cancel()
Notifies the task that it should terminate.
void setDependentLayers(const QList< QgsMapLayer * > &dependentLayers)
Sets a list of layers on which the task depends.
void setProgress(double progress)
Sets the task's current progress.
Base class for vector data providers.
virtual bool createSpatialIndex()
Creates a spatial index on the datasource (if supported by the provider type).
void clearErrors()
Clear recorded errors.
QStringList errors() const
Gets recorded errors.
virtual Q_INVOKABLE Qgis::VectorProviderCapabilities capabilities() const
Returns flags containing the supported capabilities.
bool addFeatures(QgsFeatureList &flist, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a list of features to the sink.
virtual Qgis::VectorDataProviderAttributeEditCapabilities attributeEditCapabilities() const
Returns the provider's supported attribute editing capabilities.
QgsTask task which performs a QgsVectorLayerExporter layer export operation as a background task.
void finished(bool result) override
If the task is managed by a QgsTaskManager, this will be called after the task has finished (whether ...
QgsVectorLayerExporterTask(QgsVectorLayer *layer, const QString &uri, const QString &providerKey, const QgsCoordinateReferenceSystem &destinationCrs, const QMap< QString, QVariant > &options=QMap< QString, QVariant >(), bool ownsLayer=false)
Constructor for QgsVectorLayerExporterTask.
void exportComplete()
Emitted when exporting the layer is successfully completed.
void errorOccurred(Qgis::VectorExportResult error, const QString &errorMessage)
Emitted when an error occurs which prevented the layer being exported (or if the task is canceled).
void cancel() override
Notifies the task that it should terminate.
static QgsVectorLayerExporterTask * withLayerOwnership(QgsVectorLayer *layer, const QString &uri, const QString &providerKey, const QgsCoordinateReferenceSystem &destinationCrs, const QMap< QString, QVariant > &options=QMap< QString, QVariant >())
Creates a new QgsVectorLayerExporterTask which has ownership over a source layer.
bool run() override
Performs the task's operation.
Encapsulates options for use with QgsVectorLayerExporter.
QgsReferencedRectangle extent() const
Returns the extent filter for the features to export.
void setExtent(const QgsReferencedRectangle &extent)
Sets an extent filter for the features to export.
void setOutputFields(const QList< QgsVectorLayerExporter::OutputField > &fields)
Sets the output field definitions for the destination table.
void setSelectedOnly(bool selected)
Sets whether the export should only include selected features.
QString filterExpression() const
Returns the filter expression for features to export.
void setDestinationCrs(const QgsCoordinateReferenceSystem &crs)
Sets the destination coordinate reference system to use for exported features.
const QgsExpressionContext & expressionContext() const
Returns the expression context used when a filterExpression() is set.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context used when transforming exported features.
void setFilterExpression(const QString &expression)
Set the filter expression for the features to export.
bool selectedOnly() const
Returns whether the export will only include selected features.
void setExpressionContext(const QgsExpressionContext &context)
Sets the expression context to use when a filterExpression() is set.
void setTransformContext(const QgsCoordinateTransformContext &context)
Sets the coordinate transform context to use when transforming exported features.
QgsCoordinateReferenceSystem destinationCrs() const
Returns the destination coordinate reference system used for exported features.
QList< QgsVectorLayerExporter::OutputField > outputFields() const
Returns the output field definitions for the destination table.
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a list of features to the sink.
static Qgis::VectorExportResult exportLayer(QgsVectorLayer *layer, const QString &uri, const QString &providerKey, const QgsCoordinateReferenceSystem &destCRS, bool onlySelected=false, QString *errorMessage=nullptr, const QMap< QString, QVariant > &options=QMap< QString, QVariant >(), QgsFeedback *feedback=nullptr)
Writes the contents of vector layer to a different datasource.
QString errorMessage() const
Returns any error message encountered during the export.
Qgis::VectorDataProviderAttributeEditCapabilities attributeEditCapabilities() const
Returns the attribute capabilities of the exporter.
~QgsVectorLayerExporter() override
Finalizes the export and closes the new created layer.
QString lastError() const override
Returns the most recent error encountered by the sink, e.g.
bool flushBuffer() override
Flushes any internal buffer which may exist in the sink, causing any buffered features to be added to...
Qgis::VectorExportResult errorCode() const
Returns any encountered error code, or false if no error was encountered.
QgsVectorLayerExporter(const QString &uri, const QString &provider, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &crs, bool overwrite=false, const QMap< QString, QVariant > &options=QMap< QString, QVariant >(), QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags())
Constructor for QgsVectorLayerExporter.
bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a single feature to the sink.
Represents a vector layer which manages a vector based dataset.
long long featureCount(const QString &legendKey) const
Number of features rendered with specified legend key.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
int selectedFeatureCount() const
Returns the number of features that are selected in this layer.
Q_INVOKABLE const QgsFeatureIds & selectedFeatureIds() const
Returns a list of the selected features IDs in this layer.
Q_INVOKABLE Qgis::WkbType wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
static bool isMultiType(Qgis::WkbType type)
Returns true if the WKB type is a multi type.
static QString displayString(Qgis::WkbType type)
Returns a non-translated display string type for a WKB type, e.g., the geometry name used in WKT geom...
static Qgis::WkbType singleType(Qgis::WkbType type)
Returns the single type for a WKB type.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
QList< QgsFeature > QgsFeatureList
#define QgsDebugMsgLevel(str, level)
#define QgsDebugError(str)
Qgis::VectorExportResult createEmptyLayer_t(const QString &uri, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &destCRS, bool overwrite, QMap< int, int > *oldToNewAttrIdx, QString *errorMessage, const QMap< QString, QVariant > *options)
const QgsCoordinateReferenceSystem & crs
Setting options for creating vector data providers.
Encapsulates output field definition.