28QString QgsPackageAlgorithm::name()
const
30 return QStringLiteral(
"package" );
33QString QgsPackageAlgorithm::displayName()
const
35 return QObject::tr(
"Package layers" );
38QStringList QgsPackageAlgorithm::tags()
const
40 return QObject::tr(
"geopackage,collect,merge,combine,styles" ).split(
',' );
43QString QgsPackageAlgorithm::group()
const
45 return QObject::tr(
"Database" );
48QString QgsPackageAlgorithm::groupId()
const
50 return QStringLiteral(
"database" );
53void QgsPackageAlgorithm::initAlgorithm(
const QVariantMap & )
57 outputParameter->
setMetadata( QVariantMap( { { QStringLiteral(
"widget_wrapper" ), QVariantMap( { { QStringLiteral(
"dontconfirmoverwrite" ),
true } } ) } } ) );
58 addParameter( outputParameter );
60 addParameter(
new QgsProcessingParameterBoolean( QStringLiteral(
"SAVE_STYLES" ), QObject::tr(
"Save layer styles into GeoPackage" ),
true ) );
61 addParameter(
new QgsProcessingParameterBoolean( QStringLiteral(
"SAVE_METADATA" ), QObject::tr(
"Save layer metadata into GeoPackage" ),
true ) );
62 addParameter(
new QgsProcessingParameterBoolean( QStringLiteral(
"SELECTED_FEATURES_ONLY" ), QObject::tr(
"Save only selected features" ),
false ) );
63 addParameter(
new QgsProcessingParameterBoolean( QStringLiteral(
"EXPORT_RELATED_LAYERS" ), QObject::tr(
"Export related layers following relations defined in the project" ),
false ) );
64 auto extentParam = std::make_unique<QgsProcessingParameterExtent>( QStringLiteral(
"EXTENT" ), QObject::tr(
"Extent" ), QVariant(),
true );
65 extentParam->setHelp( QObject::tr(
"Limit exported features to those with geometries intersecting the provided extent" ) );
66 addParameter( extentParam.release() );
68 auto crsParam = std::make_unique< QgsProcessingParameterCrs >( QStringLiteral(
"CRS" ), QObject::tr(
"Destination CRS" ), QVariant(),
true );
70 crsParam->setHelp( QObject::tr(
"If set, all layers will be transformed to the destination CRS during packaging." ) );
71 addParameter( std::move( crsParam ) );
76QString QgsPackageAlgorithm::shortHelpString()
const
78 return QObject::tr(
"This algorithm collects a number of existing layers and packages them together into a single GeoPackage database." );
81QString QgsPackageAlgorithm::shortDescription()
const
83 return QObject::tr(
"Packages a number of existing layers together into a single GeoPackage database." );
86QgsPackageAlgorithm *QgsPackageAlgorithm::createInstance()
const
88 return new QgsPackageAlgorithm();
93 const QList<QgsMapLayer *> layers = parameterAsLayerList( parameters, QStringLiteral(
"LAYERS" ), context );
95 for (
const QgsMapLayer *layer : std::as_const( layers ) )
98 mClonedLayerIds.insert( clonedLayer->id(), layer->id() );
99 mLayers.emplace_back( clonedLayer );
102 if ( mLayers.empty() )
104 feedback->
reportError( QObject::tr(
"No layers selected, geopackage will be empty" ),
false );
107 mDestinationCrs = parameterAsCrs( parameters, QStringLiteral(
"CRS" ), context );
114 const bool overwrite = parameterAsBoolean( parameters, QStringLiteral(
"OVERWRITE" ), context );
115 const bool saveStyles = parameterAsBoolean( parameters, QStringLiteral(
"SAVE_STYLES" ), context );
116 const bool saveMetadata = parameterAsBoolean( parameters, QStringLiteral(
"SAVE_METADATA" ), context );
117 const bool selectedFeaturesOnly = parameterAsBoolean( parameters, QStringLiteral(
"SELECTED_FEATURES_ONLY" ), context );
118 const bool exportRelatedLayers = parameterAsBoolean( parameters, QStringLiteral(
"EXPORT_RELATED_LAYERS" ), context );
119 const QString packagePath = parameterAsString( parameters, QStringLiteral(
"OUTPUT" ), context );
120 const QList<QgsMapLayer *> layers = parameterAsLayerList( parameters, QStringLiteral(
"LAYERS" ), context );
122 if ( packagePath.isEmpty() )
126 if ( overwrite && QFile::exists( packagePath ) )
128 feedback->
pushInfo( QObject::tr(
"Removing existing file '%1'" ).arg( packagePath ) );
129 if ( !QFile( packagePath ).remove() )
135 OGRSFDriverH hGpkgDriver = OGRGetDriverByName(
"GPKG" );
143 if ( exportRelatedLayers )
146 if ( project && !project->relationManager()->relations().isEmpty() )
149 const int maxRecursion { 10 };
150 int recursionGuard { 0 };
153 const auto findReferenced = [
this, &project, &feedback, &recursionGuard, &layers](
const QgsVectorLayer *vLayer,
bool onlySaveSelected,
auto &&findReferenced ) ->
void {
154 const QgsVectorLayer *originalLayer { qobject_cast<QgsVectorLayer *>( project->mapLayer( mClonedLayerIds.value( vLayer->id(), vLayer->id() ) ) ) };
155 Q_ASSERT( originalLayer );
156 const QList<QgsRelation> relations { project->relationManager()->referencingRelations( originalLayer ) };
157 for (
const QgsRelation &relation : std::as_const( relations ) )
163 bool alreadyAdded {
false };
164 for (
const auto &layerToExport : std::as_const( mLayers ) )
166 const QString originalId { mClonedLayerIds.value( layerToExport->id() ) };
167 if ( originalId == referencedLayer->id() )
169 relatedLayer = qobject_cast<QgsVectorLayer *>( layerToExport.get() );
177 feedback->pushInfo( QObject::tr(
"Adding referenced layer '%1'" ).arg( referencedLayer->name() ) );
178 relatedLayer = referencedLayer->clone();
179 mLayers.emplace_back( relatedLayer );
180 mClonedLayerIds.insert( relatedLayer->id(), referencedLayer->id() );
185 if ( onlySaveSelected )
187 if ( !layers.contains( qobject_cast<QgsMapLayer *>( referencedLayer ) ) || referencedLayer->selectedFeatureCount() > 0 )
189 Q_ASSERT( relatedLayer );
193 while ( it.nextFeature( selectedFeature ) )
195 QgsFeature referencedFeature { relation.getReferencedFeature( selectedFeature ) };
196 if ( referencedFeature.isValid() )
198 selected.insert( referencedFeature.id() );
206 if ( recursionGuard > maxRecursion )
208 feedback->pushWarning( QObject::tr(
"Max recursion (%1) adding referenced layer '%2', layer was not added" ).arg( QLocale().toString( recursionGuard ), referencedLayer->name() ) );
213 findReferenced( relatedLayer, onlySaveSelected, findReferenced );
219 const auto findReferencing = [
this, &project, &feedback, &recursionGuard, &layers](
const QgsVectorLayer *vLayer,
bool onlySaveSelected,
auto &&findReferencing ) ->
void {
220 const QgsVectorLayer *originalLayer { qobject_cast<QgsVectorLayer *>( project->mapLayer( mClonedLayerIds.value( vLayer->id(), vLayer->id() ) ) ) };
221 Q_ASSERT( originalLayer );
222 const QList<QgsRelation> relations { project->relationManager()->referencedRelations( originalLayer ) };
223 for (
const QgsRelation &relation : std::as_const( relations ) )
227 const bool layerWasExplicitlyAdded { layers.contains( qobject_cast<QgsMapLayer *>( referencingLayer ) ) };
230 bool alreadyAdded {
false };
231 for (
const auto &layerToExport : std::as_const( mLayers ) )
233 const QString originalId { mClonedLayerIds.value( layerToExport->id() ) };
234 if ( originalId == referencingLayer->id() )
236 relatedLayer = qobject_cast<QgsVectorLayer *>( layerToExport.get() );
246 if ( onlySaveSelected && ( !layerWasExplicitlyAdded || referencingLayer->selectedFeatureCount() > 0 ) )
248 if ( !layers.contains( qobject_cast<QgsMapLayer *>( referencingLayer ) ) || referencingLayer->selectedFeatureCount() > 0 )
252 while ( it.nextFeature( selectedFeature ) )
254 QgsFeatureIterator referencingFeaturesIterator { relation.getRelatedFeatures( selectedFeature ) };
256 while ( referencingFeaturesIterator.nextFeature( referencingFeature ) )
258 if ( referencingFeature.
isValid() )
260 selected.insert( referencingFeature.
id() );
267 if ( !alreadyAdded && ( !onlySaveSelected || !selected.isEmpty() ) )
269 feedback->pushInfo( QObject::tr(
"Adding referencing layer '%1'" ).arg( referencingLayer->name() ) );
270 relatedLayer = referencingLayer->clone();
271 mLayers.emplace_back( relatedLayer );
272 mClonedLayerIds.insert( relatedLayer->id(), referencingLayer->id() );
275 if ( relatedLayer && !selected.isEmpty() )
281 if ( recursionGuard > maxRecursion )
283 feedback->pushWarning( QObject::tr(
"Max recursion (%1) adding referencing layer '%2', layer was not added" ).arg( QLocale().toString( recursionGuard ), referencingLayer->name() ) );
285 else if ( relatedLayer )
288 findReferencing( relatedLayer, onlySaveSelected, findReferencing );
293 for (
const QgsMapLayer *layer : std::as_const( layers ) )
295 const QgsVectorLayer *vLayer { qobject_cast<const QgsVectorLayer *>( layer ) };
300 findReferenced( vLayer, onlySaveSelected, findReferenced );
302 findReferencing( vLayer, onlySaveSelected, findReferencing );
310 if ( !QFile::exists( packagePath ) )
314 throw QgsProcessingException( QObject::tr(
"Creation of database %1 failed (OGR error: %2)" ).arg( packagePath, QString::fromUtf8( CPLGetLastErrorMsg() ) ) );
320 throw QgsProcessingException( QObject::tr(
"Opening database %1 failed (OGR error: %2)" ).arg( packagePath, QString::fromUtf8( CPLGetLastErrorMsg() ) ) );
323 const bool validExtent = parameters.value( QStringLiteral(
"EXTENT" ) ).isValid();
325 bool errored =
false;
329 QStringList outputLayers;
332 for (
const auto &layer : mLayers )
334 if ( feedback->isCanceled() )
337 multiStepFeedback.setCurrentStep( i );
343 feedback->pushDebugInfo( QObject::tr(
"Error retrieving map layer." ) );
348 feedback->pushInfo( QObject::tr(
"Packaging layer %1/%2: %3" ).arg( i ).arg( mLayers.size() ).arg( layer ? layer->name() : QString() ) );
352 switch ( layer->type() )
356 QgsVectorLayer *vectorLayer = qobject_cast<QgsVectorLayer *>( layer.get() );
362 feedback->pushWarning( QObject::tr(
"No spatial index exists for layer %1, performance will be severely degraded" ).arg( vectorLayer->
name() ) );
365 extent = parameterAsExtent( parameters, QStringLiteral(
"EXTENT" ), context, mDestinationCrs.isValid() ? mDestinationCrs : layer->
crs() );
368 if ( !packageVectorLayer( vectorLayer, packagePath, context, &multiStepFeedback, saveStyles, saveMetadata, selectedFeaturesOnly, extent ) )
371 outputLayers.append( QStringLiteral(
"%1|layername=%2" ).arg( packagePath, layer->name() ) );
378 feedback->pushDebugInfo( QObject::tr(
"Packaging raster layers is not supported." ) );
385 feedback->pushDebugInfo( QObject::tr(
"Packaging plugin layers is not supported." ) );
391 feedback->pushDebugInfo( QObject::tr(
"Packaging mesh layers is not supported." ) );
397 feedback->pushDebugInfo( QObject::tr(
"Packaging point cloud layers is not supported." ) );
403 feedback->pushDebugInfo( QObject::tr(
"Packaging vector tile layers is not supported." ) );
409 feedback->pushDebugInfo( QObject::tr(
"Packaging annotation layers is not supported." ) );
415 feedback->pushDebugInfo( QObject::tr(
"Packaging group layers is not supported." ) );
421 feedback->pushDebugInfo( QObject::tr(
"Packaging tiled scene layers is not supported." ) );
431 outputs.insert( QStringLiteral(
"OUTPUT" ), packagePath );
432 outputs.insert( QStringLiteral(
"OUTPUT_LAYERS" ), outputLayers );
439 options.
driverName = QStringLiteral(
"GPKG" );
451 if ( mDestinationCrs.isValid() )
460 const int fidIndex = fields.
lookupField( QStringLiteral(
"fid" ) );
465 const QMetaType::Type fidType { layer->
fields().
field( fidIndex ).
type() };
468 && fidType != QMetaType::Type::Int
469 && fidType != QMetaType::Type::UInt
470 && fidType != QMetaType::Type::LongLong
471 && fidType != QMetaType::Type::ULongLong )
493 feedback->
reportError( QObject::tr(
"Packaging layer failed: %1" ).arg( error ) );
500 auto res = std::make_unique<QgsVectorLayer>( QStringLiteral(
"%1|layername=%2" ).arg( newFilename, newLayer ) );
504 QDomDocument doc( QStringLiteral(
"qgis" ) );
507 if ( !errorMsg.isEmpty() )
509 feedback->
reportError( QObject::tr(
"Could not retrieve existing layer style: %1 " ).arg( errorMsg ) );
513 if ( !res->importNamedStyle( doc, errorMsg ) )
515 feedback->
reportError( QObject::tr(
"Could not set existing layer style: %1 " ).arg( errorMsg ) );
521 const QVariant prevOverwriteStyle = settings.
value( QStringLiteral(
"qgis/overwriteStyle" ) );
522 settings.
setValue( QStringLiteral(
"qgis/overwriteStyle" ),
true );
524 settings.
setValue( QStringLiteral(
"qgis/overwriteStyle" ), prevOverwriteStyle );
528 feedback->
reportError( QObject::tr(
"Could not save layer style: %1 " ).arg( errorMsg ) );
535 feedback->
reportError( QObject::tr(
"Could not save layer style -- error loading: %1 %2" ).arg( newFilename, newLayer ) );
@ Vector
Tables (i.e. vector layers with or without geometry). When used for a sink this indicates the sink ha...
@ NotPresent
No spatial index exists for the source.
@ Group
Composite group layer. Added in QGIS 3.24.
@ Plugin
Plugin based layer.
@ TiledScene
Tiled scene layer. Added in QGIS 3.34.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ VectorTile
Vector tile layer. Added in QGIS 3.14.
@ Mesh
Mesh layer. Added in QGIS 3.2.
@ PointCloud
Point cloud layer. Added in QGIS 3.18.
@ Advanced
Parameter is an advanced parameter which should be hidden from users by default.
@ AddToSelection
Add selection to current selection.
Wrapper for iterator of features from vector data provider or vector layer.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
bool isValid() const
Returns the validity of this feature.
@ ConstraintNotNull
Field may not be null.
@ ConstraintUnique
Field must have a unique value.
Container of fields for a vector layer.
QgsAttributeList allAttributesList() const
Utility function to get list of attribute indexes.
QgsField field(int fieldIdx) const
Returns the field at particular index (must be in range 0..N-1).
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
Base class for all map layer types.
virtual void exportNamedStyle(QDomDocument &doc, QString &errorMsg, const QgsReadWriteContext &context=QgsReadWriteContext(), QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const
Export the properties of this layer as named style in a QDomDocument.
@ DatabaseWriteFailed
An error occurred when attempting to write to the database.
@ QmlGenerationFailed
Generation of the QML failed, and was not written to the database.
QgsCoordinateReferenceSystem crs
QgsLayerMetadata metadata
virtual QgsMapLayer * clone() const =0
Returns a new instance equivalent to this one except for the id which is still unique.
QFlags< SaveStyleResult > SaveStyleResults
Results of saving styles to database.
Contains information about the context in which a processing algorithm is executed.
QString defaultEncoding() const
Returns the default encoding to use for newly created files.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context.
QgsProject * project() const
Returns the project in which the algorithm is being executed.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
virtual void pushInfo(const QString &info)
Pushes a general informational message from the algorithm.
virtual void reportError(const QString &error, bool fatalError=false)
Reports that the algorithm encountered an error while executing.
Processing feedback object for multi-step operations.
A multi-layer output for processing algorithms which create map layers, when the number and nature of...
A boolean parameter for processing algorithms.
void setMetadata(const QVariantMap &metadata)
Sets the parameter's freeform metadata.
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
A parameter for processing algorithms which accepts multiple map layers.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
A container for the context for various read/write operations on objects.
A rectangle specified with double values.
Represents a relationship between two vector layers.
Stores settings for use within QGIS.
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
void setValue(const QString &key, const QVariant &value, QgsSettings::Section section=QgsSettings::NoSection)
Sets the value of setting key to value.
Options to pass to QgsVectorFileWriter::writeAsVectorFormat().
QString fileEncoding
Encoding to use.
QString driverName
OGR driver to use.
QgsCoordinateTransform ct
Transform to reproject exported geometries with, or invalid transform for no transformation.
QgsLayerMetadata layerMetadata
Layer metadata to save for the exported vector file.
QString layerName
Layer name. If let empty, it will be derived from the filename.
QgsRectangle filterExtent
If not empty, only features intersecting the extent will be saved.
bool saveMetadata
Set to true to save layer metadata for the exported vector file.
QgsVectorFileWriter::ActionOnExistingFile actionOnExistingFile
Action on existing file.
QgsAttributeList attributes
Attributes to export (empty means all unless skipAttributeCreation is set)
bool onlySelectedFeatures
Write only selected features of layer.
bool skipAttributeCreation
Only write geometries.
QgsFeedback * feedback
Optional feedback object allowing cancellation of layer save.
static QgsVectorFileWriter::WriterError writeAsVectorFormatV3(QgsVectorLayer *layer, const QString &fileName, const QgsCoordinateTransformContext &transformContext, const QgsVectorFileWriter::SaveVectorOptions &options, QString *errorMessage=nullptr, QString *newFilename=nullptr, QString *newLayer=nullptr)
Writes a layer out to a vector file.
@ CreateOrOverwriteLayer
Create or overwrite layer.
Represents a vector layer which manages a vector based dataset.
QgsFieldConstraints::Constraints fieldConstraints(int fieldIndex) const
Returns any constraints which are present for a specified field index.
int selectedFeatureCount() const
Returns the number of features that are selected in this layer.
Qgis::SpatialIndexPresence hasSpatialIndex() const override
std::unique_ptr< std::remove_pointer< OGRDataSourceH >::type, OGRDataSourceDeleter > ogr_datasource_unique_ptr
Scoped OGR data source.
QSet< QgsFeatureId > QgsFeatureIds
const QgsCoordinateReferenceSystem & crs