47#include <QRegularExpression>
48#include <QJsonDocument>
54#include <ogr_srs_api.h>
57#include <cpl_string.h>
76 const QString &fileEncoding,
80 const QString &driverName,
81 const QStringList &datasourceOptions,
82 const QStringList &layerOptions,
94 init( vectorFileName, fileEncoding, fields, geometryType,
95 srs, driverName, datasourceOptions, layerOptions, newFilename,
nullptr,
100 const QString &fileEncoding,
104 const QString &driverName,
105 const QStringList &datasourceOptions,
106 const QStringList &layerOptions,
107 QString *newFilename,
110 const QString &layerName,
116 bool includeConstraints,
117 bool setFieldDomains,
120 , mWkbType( geometryType )
121 , mSymbologyExport( symbologyExport )
122 , mSymbologyScale( 1.0 )
123 , mIncludeConstraints( includeConstraints )
124 , mSetFieldDomains( setFieldDomains )
126 init( vectorFileName, fileEncoding, fields, geometryType, srs, driverName,
127 datasourceOptions, layerOptions, newFilename, fieldValueConverter,
128 layerName, action, newLayer, sinkFlags, transformContext, fieldNameSource, sourceDatabaseProviderConnection );
132 const QString &fileName,
139 QString *newFilename,
153 if ( driverName == QLatin1String(
"MapInfo MIF" ) )
157 GDALDriverH gdalDriver = GDALGetDriverByName( driverName.toLocal8Bit().constData() );
165#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,7,0)
166 return CSLFetchBoolean(
driverMetadata, GDAL_DCAP_FEATURE_STYLES_WRITE,
false );
168 return CSLFetchBoolean(
driverMetadata, GDAL_DCAP_FEATURE_STYLES,
false );
172void QgsVectorFileWriter::init( QString vectorFileName,
173 QString fileEncoding,
177 const QString &driverName,
178 QStringList datasourceOptions,
179 QStringList layerOptions,
180 QString *newFilename,
181 FieldValueConverter *fieldValueConverter,
182 const QString &layerNameIn,
183 ActionOnExistingFile action,
184 QString *newLayer, SinkFlags sinkFlags,
188#if GDAL_VERSION_NUM < GDAL_COMPUTE_VERSION(3,5,0)
189 ( void )sourceDatabaseProviderConnection;
194 if ( vectorFileName.isEmpty() )
201 if ( driverName == QLatin1String(
"MapInfo MIF" ) )
205 else if ( driverName == QLatin1String(
"SpatiaLite" ) )
208 if ( !datasourceOptions.contains( QStringLiteral(
"SPATIALITE=YES" ) ) )
210 datasourceOptions.append( QStringLiteral(
"SPATIALITE=YES" ) );
213 else if ( driverName == QLatin1String(
"DBF file" ) )
216 if ( !layerOptions.contains( QStringLiteral(
"SHPT=NULL" ) ) )
218 layerOptions.append( QStringLiteral(
"SHPT=NULL" ) );
227#if GDAL_VERSION_NUM < GDAL_COMPUTE_VERSION(3,3,1)
228 QString fidFieldName;
231 for (
const QString &layerOption : layerOptions )
233 if ( layerOption.startsWith( QLatin1String(
"FID=" ) ) )
235 fidFieldName = layerOption.mid( 4 );
239 if ( fidFieldName.isEmpty() )
240 fidFieldName = QStringLiteral(
"fid" );
245 OGRSFDriverH poDriver;
248 poDriver = OGRGetDriverByName(
mOgrDriverName.toLocal8Bit().constData() );
252 mErrorMessage = QObject::tr(
"OGR driver for '%1' not found (OGR error: %2)" )
254 QString::fromUtf8( CPLGetLastErrorMsg() ) );
259 mOgrDriverLongName = QString( GDALGetMetadataItem( poDriver, GDAL_DMD_LONGNAME,
nullptr ) );
266 if ( layerOptions.join( QString() ).toUpper().indexOf( QLatin1String(
"ENCODING=" ) ) == -1 )
271 if ( driverName == QLatin1String(
"ESRI Shapefile" ) && !vectorFileName.endsWith( QLatin1String(
".shp" ), Qt::CaseInsensitive ) )
273 vectorFileName += QLatin1String(
".shp" );
275 else if ( driverName == QLatin1String(
"DBF file" ) && !vectorFileName.endsWith( QLatin1String(
".dbf" ), Qt::CaseInsensitive ) )
277 vectorFileName += QLatin1String(
".dbf" );
287 QStringList allExts = metadata.ext.split(
' ', Qt::SkipEmptyParts );
289 const auto constAllExts = allExts;
290 for (
const QString &ext : constAllExts )
292 if ( vectorFileName.endsWith(
'.' + ext, Qt::CaseInsensitive ) )
301 vectorFileName +=
'.' + allExts[0];
307 if ( vectorFileName.endsWith( QLatin1String(
".gdb" ), Qt::CaseInsensitive ) )
309 QDir dir( vectorFileName );
312 QFileInfoList fileList = dir.entryInfoList(
313 QDir::NoDotAndDotDot | QDir::System | QDir::Hidden | QDir::AllDirs | QDir::Files, QDir::DirsFirst );
314 const auto constFileList = fileList;
315 for (
const QFileInfo &info : constFileList )
317 QFile::remove( info.absoluteFilePath() );
320 QDir().rmdir( vectorFileName );
324 QFile::remove( vectorFileName );
329 if ( metadataFound && !metadata.compulsoryEncoding.isEmpty() )
331 if ( fileEncoding.compare( metadata.compulsoryEncoding, Qt::CaseInsensitive ) != 0 )
333 QgsDebugMsgLevel( QStringLiteral(
"forced %1 encoding for %2" ).arg( metadata.compulsoryEncoding, driverName ), 2 );
334 fileEncoding = metadata.compulsoryEncoding;
339 char **options =
nullptr;
340 if ( !datasourceOptions.isEmpty() )
342 options =
new char *[ datasourceOptions.size() + 1 ];
343 for (
int i = 0; i < datasourceOptions.size(); i++ )
345 QgsDebugMsgLevel( QStringLiteral(
"-dsco=%1" ).arg( datasourceOptions[i] ), 2 );
346 options[i] = CPLStrdup( datasourceOptions[i].toUtf8().constData() );
348 options[ datasourceOptions.size()] =
nullptr;
355 mDS.reset( OGR_Dr_CreateDataSource( poDriver, vectorFileName.toUtf8().constData(), options ) );
357 mDS.reset( OGROpen( vectorFileName.toUtf8().constData(), TRUE,
nullptr ) );
361 for (
int i = 0; i < datasourceOptions.size(); i++ )
362 CPLFree( options[i] );
371 mErrorMessage = QObject::tr(
"Creation of data source failed (OGR error: %1)" )
372 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
374 mErrorMessage = QObject::tr(
"Opening of data source in update mode failed (OGR error: %1)" )
375 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
379 QString layerName( layerNameIn );
380 if ( layerName.isEmpty() )
381 layerName = QFileInfo( vectorFileName ).baseName();
385 const int layer_count = OGR_DS_GetLayerCount(
mDS.get() );
386 for (
int i = 0; i < layer_count; i++ )
388 OGRLayerH hLayer = OGR_DS_GetLayer(
mDS.get(), i );
389 if ( EQUAL( OGR_L_GetName( hLayer ), layerName.toUtf8().constData() ) )
391 if ( OGR_DS_DeleteLayer(
mDS.get(), i ) != OGRERR_NONE )
394 mErrorMessage = QObject::tr(
"Overwriting of existing layer failed (OGR error: %1)" )
395 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
409 QgsDebugMsgLevel( QStringLiteral(
"Opened data source in update mode" ), 2 );
413 mCodec = QTextCodec::codecForName( fileEncoding.toLocal8Bit().constData() );
416 QgsDebugError(
"error finding QTextCodec for " + fileEncoding );
419 QString enc = settings.
value( QStringLiteral(
"UI/encoding" ),
"System" ).toString();
420 mCodec = QTextCodec::codecForName( enc.toLocal8Bit().constData() );
424 mCodec = QTextCodec::codecForLocale();
430 if ( driverName == QLatin1String(
"KML" ) || driverName == QLatin1String(
"LIBKML" ) || driverName == QLatin1String(
"GPX" ) )
432 if ( srs.
authid() != QLatin1String(
"EPSG:4326" ) )
447 int optIndex = layerOptions.indexOf( QLatin1String(
"FEATURE_DATASET=" ) );
448 if ( optIndex != -1 )
450 layerOptions.removeAt( optIndex );
453 if ( !layerOptions.isEmpty() )
455 options =
new char *[ layerOptions.size() + 1 ];
456 for (
int i = 0; i < layerOptions.size(); i++ )
459 options[i] = CPLStrdup( layerOptions[i].toUtf8().constData() );
461 options[ layerOptions.size()] =
nullptr;
465 CPLSetConfigOption(
"SHAPE_ENCODING",
"" );
469 mLayer = OGR_DS_CreateLayer(
mDS.get(), layerName.toUtf8().constData(),
mOgrRef, wkbType, options );
472 *newLayer = OGR_L_GetName(
mLayer );
473 if ( driverName == QLatin1String(
"GPX" ) )
480 if ( !EQUAL( layerName.toUtf8().constData(),
"track_points" ) &&
481 !EQUAL( layerName.toUtf8().constData(),
"route_points" ) )
483 *newLayer = QStringLiteral(
"waypoints" );
490 const char *pszForceGPXTrack
491 = CSLFetchNameValue( options,
"FORCE_GPX_TRACK" );
492 if ( pszForceGPXTrack && CPLTestBool( pszForceGPXTrack ) )
493 *newLayer = QStringLiteral(
"tracks" );
495 *newLayer = QStringLiteral(
"routes" );
502 const char *pszForceGPXRoute
503 = CSLFetchNameValue( options,
"FORCE_GPX_ROUTE" );
504 if ( pszForceGPXRoute && CPLTestBool( pszForceGPXRoute ) )
505 *newLayer = QStringLiteral(
"routes" );
507 *newLayer = QStringLiteral(
"tracks" );
517 else if ( driverName == QLatin1String(
"DGN" ) )
519 mLayer = OGR_DS_GetLayerByName(
mDS.get(),
"elements" );
523 mLayer = OGR_DS_GetLayerByName(
mDS.get(), layerName.toUtf8().constData() );
528 for (
int i = 0; i < layerOptions.size(); i++ )
529 CPLFree( options[i] );
538 QString layerName = vectorFileName.left( vectorFileName.indexOf( QLatin1String(
".shp" ), Qt::CaseInsensitive ) );
539 QFile prjFile( layerName +
".qpj" );
540 if ( prjFile.exists() )
548 mErrorMessage = QObject::tr(
"Creation of layer failed (OGR error: %1)" )
549 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
551 mErrorMessage = QObject::tr(
"Opening of layer failed (OGR error: %1)" )
552 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
557 OGRFeatureDefnH defn = OGR_L_GetLayerDefn(
mLayer );
566 QSet<int> existingIdxs;
570#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,7,0)
571 if (
const char *pszCreateFieldDefnFlags = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATION_FIELD_DEFN_FLAGS,
nullptr ) )
573 char **papszTokens = CSLTokenizeString2( pszCreateFieldDefnFlags,
" ", 0 );
574 if ( CSLFindString( papszTokens,
"AlternativeName" ) >= 0 )
578 if ( CSLFindString( papszTokens,
"Comment" ) >= 0 )
582 CSLDestroy( papszTokens );
592#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,5,0)
593 QSet<QString> existingDestDomainNames;
594 if ( sourceDatabaseProviderConnection )
596 char **domainNames = GDALDatasetGetFieldDomainNames(
mDS.get(),
nullptr );
597 for (
const char *
const *iterDomainNames = domainNames; iterDomainNames && *iterDomainNames; ++iterDomainNames )
599 existingDestDomainNames.insert( QString::fromUtf8( *iterDomainNames ) );
601 CSLDestroy( domainNames );
604#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,6,0)
605 QSet< QString > usedAlternativeNames;
607 for (
int fldIdx = 0; fldIdx < fields.
count(); ++fldIdx )
611 if ( fieldValueConverter )
613 attrField = fieldValueConverter->fieldDefinition( fields.
at( fldIdx ) );
618 int ogrIdx = OGR_FD_GetFieldIndex( defn,
mCodec->fromUnicode( attrField.
name() ) );
627 switch ( fieldNameSource )
630 name = attrField.
name();
634 name = !attrField.
alias().isEmpty() ? attrField.
alias() : attrField.
name();
638 OGRFieldType ogrType = OFTString;
639 OGRFieldSubType ogrSubType = OFSTNone;
640 int ogrWidth = attrField.
length();
641 int ogrPrecision = attrField.
precision();
642 if ( ogrPrecision > 0 )
645 switch ( attrField.
type() )
647 case QMetaType::Type::LongLong:
649 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES,
nullptr );
650 if ( pszDataTypes && strstr( pszDataTypes,
"Integer64" ) )
651 ogrType = OFTInteger64;
654 ogrWidth = ogrWidth > 0 && ogrWidth <= 20 ? ogrWidth : 20;
658 case QMetaType::Type::QString:
660 if ( ( ogrWidth <= 0 || ogrWidth > 255 ) &&
mOgrDriverName == QLatin1String(
"ESRI Shapefile" ) )
664 case QMetaType::Type::Int:
665 ogrType = OFTInteger;
666 ogrWidth = ogrWidth > 0 && ogrWidth <= 10 ? ogrWidth : 10;
670 case QMetaType::Type::Bool:
671 ogrType = OFTInteger;
672 ogrSubType = OFSTBoolean;
677 case QMetaType::Type::Double:
678#if GDAL_VERSION_NUM < GDAL_COMPUTE_VERSION(3,3,1)
679 if (
mOgrDriverName == QLatin1String(
"GPKG" ) && attrField.
precision() == 0 && attrField.
name().compare( fidFieldName, Qt::CaseInsensitive ) == 0 )
682 ogrType = OFTInteger64;
689 case QMetaType::Type::QDate:
693 case QMetaType::Type::QTime:
705 case QMetaType::Type::QDateTime:
713 ogrType = OFTDateTime;
717 case QMetaType::Type::QByteArray:
721 case QMetaType::Type::QStringList:
727 ogrSubType = OFSTJSON;
731 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES,
nullptr );
732 if ( pszDataTypes && strstr( pszDataTypes,
"StringList" ) )
734 ogrType = OFTStringList;
735 mSupportedListSubTypes.insert( QMetaType::Type::QString );
745 case QMetaType::Type::QVariantMap:
748 const char *pszDataSubTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATASUBTYPES,
nullptr );
749 if ( pszDataSubTypes && strstr( pszDataSubTypes,
"JSON" ) )
752 ogrSubType = OFSTJSON;
760 case QMetaType::Type::QVariantList:
765 ogrSubType = OFSTJSON;
770 if ( attrField.
subType() == QMetaType::Type::QString )
772 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES,
nullptr );
773 if ( pszDataTypes && strstr( pszDataTypes,
"StringList" ) )
775 ogrType = OFTStringList;
776 mSupportedListSubTypes.insert( QMetaType::Type::QString );
785 else if ( attrField.
subType() == QMetaType::Type::Int )
787 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES,
nullptr );
788 if ( pszDataTypes && strstr( pszDataTypes,
"IntegerList" ) )
790 ogrType = OFTIntegerList;
791 mSupportedListSubTypes.insert( QMetaType::Type::Int );
800 else if ( attrField.
subType() == QMetaType::Type::Double )
802 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES,
nullptr );
803 if ( pszDataTypes && strstr( pszDataTypes,
"RealList" ) )
805 ogrType = OFTRealList;
806 mSupportedListSubTypes.insert( QMetaType::Type::Double );
815 else if ( attrField.
subType() == QMetaType::Type::LongLong )
817 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES,
nullptr );
818 if ( pszDataTypes && strstr( pszDataTypes,
"Integer64List" ) )
820 ogrType = OFTInteger64List;
821 mSupportedListSubTypes.insert( QMetaType::Type::LongLong );
835 mErrorMessage = QObject::tr(
"Unsupported type for field %1" )
836 .arg( attrField.
name() );
841 if (
mOgrDriverName == QLatin1String(
"SQLite" ) && name.compare( QLatin1String(
"ogc_fid" ), Qt::CaseInsensitive ) == 0 )
844 for ( i = 0; i < 10; i++ )
846 name = QStringLiteral(
"ogc_fid%1" ).arg( i );
849 for ( j = 0; j < fields.
size() && name.compare( fields.
at( j ).
name(), Qt::CaseInsensitive ) != 0; j++ )
852 if ( j == fields.
size() )
858 mErrorMessage = QObject::tr(
"No available replacement for internal fieldname ogc_fid found" ).arg( attrField.
name() );
863 QgsMessageLog::logMessage( QObject::tr(
"Reserved attribute name ogc_fid replaced with %1" ).arg( name ), QObject::tr(
"OGR" ) );
870 OGR_Fld_SetWidth( fld.get(), ogrWidth );
873 if ( ogrPrecision >= 0 )
875 OGR_Fld_SetPrecision( fld.get(), ogrPrecision );
878 if ( ogrSubType != OFSTNone )
879 OGR_Fld_SetSubType( fld.get(), ogrSubType );
881#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,6,0)
882 if ( !attrField.
alias().isEmpty() )
884 QString alternativeName = attrField.
alias();
886 while ( usedAlternativeNames.contains( alternativeName ) )
889 alternativeName = attrField.
alias() + QStringLiteral(
" (%1)" ).arg( ++counter );
891 OGR_Fld_SetAlternativeName( fld.get(),
mCodec->fromUnicode( alternativeName ).constData() );
892 usedAlternativeNames.insert( alternativeName );
895#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,7,0)
896 OGR_Fld_SetComment( fld.get(),
mCodec->fromUnicode( attrField.
comment() ).constData() );
903 OGR_Fld_SetNullable( fld.get(),
false );
907 OGR_Fld_SetUnique( fld.get(),
true );
910#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,5,0)
914 if ( !domainName.isEmpty() )
916 bool canSetFieldDomainName =
false;
917 if ( existingDestDomainNames.contains( domainName ) )
921 canSetFieldDomainName =
true;
923 else if ( GDALDatasetTestCapability(
mDS.get(), ODsCAddFieldDomain ) )
933 std::unique_ptr<QgsFieldDomain> domain( sourceDatabaseProviderConnection->
fieldDomain( domainName ) );
939 char *pszFailureReason =
nullptr;
940 if ( GDALDatasetAddFieldDomain(
mDS.get(), hFieldDomain, &pszFailureReason ) )
942 existingDestDomainNames.insert( domainName );
943 canSetFieldDomainName =
true;
947 QgsDebugError( QStringLiteral(
"cannot create field domain: %1" ).arg( pszFailureReason ) );
949 CPLFree( pszFailureReason );
950 OGR_FldDomain_Destroy( hFieldDomain );
956 QgsDebugError( QStringLiteral(
"Cannot retrieve field domain: %1" ).arg( domainName ) );
959 if ( canSetFieldDomainName )
961 OGR_Fld_SetDomainName( fld.get(), domainName.toUtf8().toStdString().c_str() );
969 " type " + QString( QVariant::typeToName( attrField.
type() ) ) +
970 " width " + QString::number( ogrWidth ) +
971 " precision " + QString::number( ogrPrecision ), 2 );
972 if ( OGR_L_CreateField(
mLayer, fld.get(),
true ) != OGRERR_NONE )
975 mErrorMessage = QObject::tr(
"Creation of field %1 failed (OGR error: %2)" )
976 .arg( attrField.
name(),
977 QString::fromUtf8( CPLGetLastErrorMsg() ) );
982 int ogrIdx = OGR_FD_GetFieldIndex( defn,
mCodec->fromUnicode( name ) );
983 QgsDebugMsgLevel( QStringLiteral(
"returned field index for %1: %2" ).arg( name ).arg( ogrIdx ), 2 );
984 if ( ogrIdx < 0 || existingIdxs.contains( ogrIdx ) )
987 ogrIdx = OGR_FD_GetFieldCount( defn ) - 1;
992 mErrorMessage = QObject::tr(
"Created field %1 not found (OGR error: %2)" )
993 .arg( attrField.
name(),
994 QString::fromUtf8( CPLGetLastErrorMsg() ) );
1000 existingIdxs.insert( ogrIdx );
1008 for (
int fldIdx = 0; fldIdx < fields.
count(); ++fldIdx )
1011 QString name( attrField.
name() );
1012 int ogrIdx = OGR_FD_GetFieldIndex( defn,
mCodec->fromUnicode( name ) );
1024 int fidIdx = fields.
lookupField( QStringLiteral(
"FID" ) );
1035 *newFilename = vectorFileName;
1038 mUsingTransaction =
true;
1039 if ( OGRERR_NONE != OGR_L_StartTransaction(
mLayer ) )
1041 mUsingTransaction =
false;
1051class QgsVectorFileWriterMetadataContainer
1055 QgsVectorFileWriterMetadataContainer()
1057 QMap<QString, QgsVectorFileWriter::Option *> datasetOptions;
1058 QMap<QString, QgsVectorFileWriter::Option *> layerOptions;
1061 datasetOptions.clear();
1062 layerOptions.clear();
1065 QObject::tr(
"Compression method." ),
1067 << QStringLiteral(
"UNCOMPRESSED" )
1068 << QStringLiteral(
"ZSTD" )
1069 << QStringLiteral(
"LZ4" ),
1070 QStringLiteral(
"LZ4" ),
1075 QObject::tr(
"Geometry encoding." ),
1077 << QStringLiteral(
"GEOARROW" )
1078 << QStringLiteral(
"WKB" )
1079 << QStringLiteral(
"WKT" ),
1080 QStringLiteral(
"GEOARROW" ),
1085 QObject::tr(
"Maximum number of rows per batch." ),
1090 QObject::tr(
"Name for the feature identifier column" ),
1095 QObject::tr(
"Name for the geometry column" ),
1096 QStringLiteral(
"geometry" )
1099 driverMetadata.insert( QStringLiteral(
"Arrow" ),
1101 QStringLiteral(
"(Geo)Arrow" ),
1102 QObject::tr(
"(Geo)Arrow" ),
1103 QStringLiteral(
"*.arrow *.feather *.arrows *.ipc" ),
1104 QStringLiteral(
"arrow" ),
1107 QStringLiteral(
"UTF-8" )
1112 datasetOptions.clear();
1113 layerOptions.clear();
1115 driverMetadata.insert( QStringLiteral(
"AVCE00" ),
1117 QStringLiteral(
"Arc/Info ASCII Coverage" ),
1118 QObject::tr(
"Arc/Info ASCII Coverage" ),
1119 QStringLiteral(
"*.e00" ),
1120 QStringLiteral(
"e00" ),
1127 datasetOptions.clear();
1128 layerOptions.clear();
1131 QObject::tr(
"By default when creating new .csv files they "
1132 "are created with the line termination conventions "
1133 "of the local platform (CR/LF on Win32 or LF on all other systems). "
1134 "This may be overridden through the use of the LINEFORMAT option." ),
1136 << QStringLiteral(
"CRLF" )
1137 << QStringLiteral(
"LF" ),
1143 QObject::tr(
"By default, the geometry of a feature written to a .csv file is discarded. "
1144 "It is possible to export the geometry in its WKT representation by "
1145 "specifying GEOMETRY=AS_WKT. It is also possible to export point geometries "
1146 "into their X,Y,Z components by specifying GEOMETRY=AS_XYZ, GEOMETRY=AS_XY "
1147 "or GEOMETRY=AS_YX." ),
1149 << QStringLiteral(
"AS_WKT" )
1150 << QStringLiteral(
"AS_XYZ" )
1151 << QStringLiteral(
"AS_XY" )
1152 << QStringLiteral(
"AS_YX" ),
1158 QObject::tr(
"Create the associated .csvt file to describe the type of each "
1159 "column of the layer and its optional width and precision." ),
1164 QObject::tr(
"Field separator character." ),
1166 << QStringLiteral(
"COMMA" )
1167 << QStringLiteral(
"SEMICOLON" )
1168 << QStringLiteral(
"TAB" ),
1169 QStringLiteral(
"COMMA" )
1173 QObject::tr(
"Double-quote strings. IF_AMBIGUOUS means that string values that look like numbers will be quoted." ),
1175 << QStringLiteral(
"IF_NEEDED" )
1176 << QStringLiteral(
"IF_AMBIGUOUS" )
1177 << QStringLiteral(
"ALWAYS" ),
1178 QStringLiteral(
"IF_AMBIGUOUS" )
1182 QObject::tr(
"Write a UTF-8 Byte Order Mark (BOM) at the start of the file." ),
1186 driverMetadata.insert( QStringLiteral(
"CSV" ),
1188 QStringLiteral(
"Comma Separated Value [CSV]" ),
1189 QObject::tr(
"Comma Separated Value [CSV]" ),
1190 QStringLiteral(
"*.csv" ),
1191 QStringLiteral(
"csv" ),
1198 datasetOptions.clear();
1199 layerOptions.clear();
1201 driverMetadata.insert( QStringLiteral(
"FlatGeobuf" ),
1203 QStringLiteral(
"FlatGeobuf" ),
1204 QObject::tr(
"FlatGeobuf" ),
1205 QStringLiteral(
"*.fgb" ),
1206 QStringLiteral(
"fgb" ),
1209 QStringLiteral(
"UTF-8" )
1214 datasetOptions.clear();
1215 layerOptions.clear();
1218 QObject::tr(
"Override the type of shapefile created. "
1219 "Can be one of NULL for a simple .dbf file with no .shp file, POINT, "
1220 "ARC, POLYGON or MULTIPOINT for 2D, or POINTZ, ARCZ, POLYGONZ or "
1221 "MULTIPOINTZ for 3D;" ) +
1222 QObject::tr(
" POINTM, ARCM, POLYGONM or MULTIPOINTM for measured geometries"
1223 " and POINTZM, ARCZM, POLYGONZM or MULTIPOINTZM for 3D measured"
1225 QObject::tr(
" MULTIPATCH files are supported since GDAL 2.2." ) +
1228 << QStringLiteral(
"NULL" )
1229 << QStringLiteral(
"POINT" )
1230 << QStringLiteral(
"ARC" )
1231 << QStringLiteral(
"POLYGON" )
1232 << QStringLiteral(
"MULTIPOINT" )
1233 << QStringLiteral(
"POINTZ" )
1234 << QStringLiteral(
"ARCZ" )
1235 << QStringLiteral(
"POLYGONZ" )
1236 << QStringLiteral(
"MULTIPOINTZ" )
1237 << QStringLiteral(
"POINTM" )
1238 << QStringLiteral(
"ARCM" )
1239 << QStringLiteral(
"POLYGONM" )
1240 << QStringLiteral(
"MULTIPOINTM" )
1241 << QStringLiteral(
"POINTZM" )
1242 << QStringLiteral(
"ARCZM" )
1243 << QStringLiteral(
"POLYGONZM" )
1244 << QStringLiteral(
"MULTIPOINTZM" )
1245 << QStringLiteral(
"MULTIPATCH" )
1255 QObject::tr(
"Set the encoding value in the DBF file. "
1256 "The default value is LDID/87. It is not clear "
1257 "what other values may be appropriate." ),
1265 QObject::tr(
"Set to YES to resize fields to their optimal size." ),
1269 driverMetadata.insert( QStringLiteral(
"ESRI" ),
1271 QStringLiteral(
"ESRI Shapefile" ),
1272 QObject::tr(
"ESRI Shapefile" ),
1273 QStringLiteral(
"*.shp" ),
1274 QStringLiteral(
"shp" ),
1281 datasetOptions.clear();
1282 layerOptions.clear();
1284 driverMetadata.insert( QStringLiteral(
"DBF File" ),
1286 QStringLiteral(
"DBF File" ),
1287 QObject::tr(
"DBF File" ),
1288 QStringLiteral(
"*.dbf" ),
1289 QStringLiteral(
"dbf" ),
1296 datasetOptions.clear();
1297 layerOptions.clear();
1300 QObject::tr(
"Set to YES to write a bbox property with the bounding box "
1301 "of the geometries at the feature and feature collection level." ),
1306 QObject::tr(
"Maximum number of figures after decimal separator to write in coordinates. "
1307 "Defaults to 15. Truncation will occur to remove trailing zeros." ),
1312 QObject::tr(
"Whether to use RFC 7946 standard. "
1313 "If disabled GeoJSON 2008 initial version will be used. "
1314 "Default is NO (thus GeoJSON 2008). See also Documentation (via Help button)" ),
1318 driverMetadata.insert( QStringLiteral(
"GeoJSON" ),
1320 QStringLiteral(
"GeoJSON" ),
1321 QObject::tr(
"GeoJSON" ),
1322 QStringLiteral(
"*.geojson" ),
1323 QStringLiteral(
"geojson" ),
1326 QStringLiteral(
"UTF-8" )
1331 datasetOptions.clear();
1332 layerOptions.clear();
1335 QObject::tr(
"Maximum number of figures after decimal separator to write in coordinates. "
1336 "Defaults to 15. Truncation will occur to remove trailing zeros." ),
1341 QObject::tr(
"Whether to start records with the RS=0x1E character (RFC 8142 standard). "
1342 "Defaults to NO: Newline Delimited JSON (geojsonl). \n"
1343 "If set to YES: RFC 8142 standard: GeoJSON Text Sequences (geojsons)." ),
1347 driverMetadata.insert( QStringLiteral(
"GeoJSONSeq" ),
1349 QStringLiteral(
"GeoJSON - Newline Delimited" ),
1350 QObject::tr(
"GeoJSON - Newline Delimited" ),
1351 QStringLiteral(
"*.geojsonl *.geojsons *.json" ),
1352 QStringLiteral(
"geojsonl geojsons json" ),
1355 QStringLiteral(
"UTF-8" )
1360 datasetOptions.clear();
1361 layerOptions.clear();
1364 QObject::tr(
"whether the document must be in RSS 2.0 or Atom 1.0 format. "
1365 "Default value : RSS" ),
1367 << QStringLiteral(
"RSS" )
1368 << QStringLiteral(
"ATOM" ),
1369 QStringLiteral(
"RSS" )
1373 QObject::tr(
"The encoding of location information. Default value : SIMPLE. "
1374 "W3C_GEO only supports point geometries. "
1375 "SIMPLE or W3C_GEO only support geometries in geographic WGS84 coordinates." ),
1377 << QStringLiteral(
"SIMPLE" )
1378 << QStringLiteral(
"GML" )
1379 << QStringLiteral(
"W3C_GEO" ),
1380 QStringLiteral(
"SIMPLE" )
1384 QObject::tr(
"If defined to YES, extension fields will be written. "
1385 "If the field name not found in the base schema matches "
1386 "the foo_bar pattern, foo will be considered as the namespace "
1387 "of the element, and a <foo:bar> element will be written. "
1388 "Otherwise, elements will be written in the <ogr:> namespace." ),
1393 QObject::tr(
"If defined to NO, only <entry> or <item> elements will be written. "
1394 "The user will have to provide the appropriate header and footer of the document." ),
1399 QObject::tr(
"XML content that will be put between the <channel> element and the "
1400 "first <item> element for a RSS document, or between the xml tag and "
1401 "the first <entry> element for an Atom document." ),
1406 QObject::tr(
"Value put inside the <title> element in the header. "
1407 "If not provided, a dummy value will be used as that element is compulsory." ),
1412 QObject::tr(
"Value put inside the <description> element in the header. "
1413 "If not provided, a dummy value will be used as that element is compulsory." ),
1418 QObject::tr(
"Value put inside the <link> element in the header. "
1419 "If not provided, a dummy value will be used as that element is compulsory." ),
1424 QObject::tr(
"Value put inside the <updated> element in the header. "
1425 "Should be formatted as a XML datetime. "
1426 "If not provided, a dummy value will be used as that element is compulsory." ),
1431 QObject::tr(
"Value put inside the <author><name> element in the header. "
1432 "If not provided, a dummy value will be used as that element is compulsory." ),
1437 QObject::tr(
"Value put inside the <id> element in the header. "
1438 "If not provided, a dummy value will be used as that element is compulsory." ),
1442 driverMetadata.insert( QStringLiteral(
"GeoRSS" ),
1444 QStringLiteral(
"GeoRSS" ),
1445 QObject::tr(
"GeoRSS" ),
1446 QStringLiteral(
"*.xml" ),
1447 QStringLiteral(
"xml" ),
1450 QStringLiteral(
"UTF-8" )
1455 datasetOptions.clear();
1456 layerOptions.clear();
1459 QObject::tr(
"If provided, this URI will be inserted as the schema location. "
1460 "Note that the schema file isn't actually accessed by OGR, so it "
1461 "is up to the user to ensure it will match the schema of the OGR "
1462 "produced GML data file." ),
1467 QObject::tr(
"This writes a GML application schema file to a corresponding "
1468 ".xsd file (with the same basename). If INTERNAL is used the "
1469 "schema is written within the GML file, but this is experimental "
1470 "and almost certainly not valid XML. "
1471 "OFF disables schema generation (and is implicit if XSISCHEMAURI is used)." ),
1473 << QStringLiteral(
"EXTERNAL" )
1474 << QStringLiteral(
"INTERNAL" )
1475 << QStringLiteral(
"OFF" ),
1476 QStringLiteral(
"EXTERNAL" )
1480 QObject::tr(
"This is the prefix for the application target namespace." ),
1481 QStringLiteral(
"ogr" )
1485 QObject::tr(
"Can be set to TRUE to avoid writing the prefix of the "
1486 "application target namespace in the GML file." ),
1491 QObject::tr(
"Defaults to 'http://ogr.maptools.org/'. "
1492 "This is the application target namespace." ),
1493 QStringLiteral(
"http://ogr.maptools.org/" )
1497 QObject::tr(
"GML version to use." ),
1499 << QStringLiteral(
"GML2" )
1500 << QStringLiteral(
"GML3" )
1501 << QStringLiteral(
"GML3Deegree" )
1502 << QStringLiteral(
"GML3.2" ),
1503 QStringLiteral(
"GML3.2" )
1507 QObject::tr(
"Only valid when FORMAT=GML3/GML3Degree/GML3.2. Default to YES. "
1508 "If YES, SRS with EPSG authority will be written with the "
1509 "'urn:ogc:def:crs:EPSG::' prefix. In the case the SRS is a "
1510 "geographic SRS without explicit AXIS order, but that the same "
1511 "SRS authority code imported with ImportFromEPSGA() should be "
1512 "treated as lat/long, then the function will take care of coordinate "
1513 "order swapping. If set to NO, SRS with EPSG authority will be "
1514 "written with the 'EPSG:' prefix, even if they are in lat/long order." ),
1519 QObject::tr(
"only valid when FORMAT=GML3/GML3Degree/GML3.2) Default to YES. "
1520 "If set to NO, the <gml:boundedBy> element will not be written for "
1526 QObject::tr(
"Default to YES. If YES, the output will be indented with spaces "
1527 "for more readability, but at the expense of file size." ),
1532 driverMetadata.insert( QStringLiteral(
"GML" ),
1534 QStringLiteral(
"Geography Markup Language [GML]" ),
1535 QObject::tr(
"Geography Markup Language [GML]" ),
1536 QStringLiteral(
"*.gml" ),
1537 QStringLiteral(
"gml" ),
1540 QStringLiteral(
"UTF-8" )
1545 datasetOptions.clear();
1546 layerOptions.clear();
1549 QObject::tr(
"Human-readable identifier (e.g. short name) for the layer content" ),
1554 QObject::tr(
"Human-readable description for the layer content" ),
1559 QObject::tr(
"Name for the feature identifier column" ),
1560 QStringLiteral(
"fid" )
1564 QObject::tr(
"Name for the geometry column" ),
1565 QStringLiteral(
"geom" )
1569 QObject::tr(
"If a spatial index must be created." ),
1573 driverMetadata.insert( QStringLiteral(
"GPKG" ),
1575 QStringLiteral(
"GeoPackage" ),
1576 QObject::tr(
"GeoPackage" ),
1577 QStringLiteral(
"*.gpkg" ),
1578 QStringLiteral(
"gpkg" ),
1581 QStringLiteral(
"UTF-8" )
1586 datasetOptions.clear();
1587 layerOptions.clear();
1589 driverMetadata.insert( QStringLiteral(
"GMT" ),
1591 QStringLiteral(
"Generic Mapping Tools [GMT]" ),
1592 QObject::tr(
"Generic Mapping Tools [GMT]" ),
1593 QStringLiteral(
"*.gmt" ),
1594 QStringLiteral(
"gmt" ),
1601 datasetOptions.clear();
1602 layerOptions.clear();
1605 QObject::tr(
"By default when writing a layer whose features are of "
1606 "type wkbLineString, the GPX driver chooses to write "
1607 "them as routes. If FORCE_GPX_TRACK=YES is specified, "
1608 "they will be written as tracks." ),
1613 QObject::tr(
"By default when writing a layer whose features are of "
1614 "type wkbMultiLineString, the GPX driver chooses to write "
1615 "them as tracks. If FORCE_GPX_ROUTE=YES is specified, "
1616 "they will be written as routes, provided that the multilines "
1617 "are composed of only one single line." ),
1622 QObject::tr(
"If GPX_USE_EXTENSIONS=YES is specified, "
1623 "extra fields will be written inside the <extensions> tag." ),
1628 QObject::tr(
"Only used if GPX_USE_EXTENSIONS=YES and GPX_EXTENSIONS_NS_URL "
1629 "is set. The namespace value used for extension tags. By default, 'ogr'." ),
1630 QStringLiteral(
"ogr" )
1634 QObject::tr(
"Only used if GPX_USE_EXTENSIONS=YES and GPX_EXTENSIONS_NS "
1635 "is set. The namespace URI. By default, 'http://osgeo.org/gdal'." ),
1636 QStringLiteral(
"http://osgeo.org/gdal" )
1640 QObject::tr(
"By default files are created with the line termination "
1641 "conventions of the local platform (CR/LF on win32 or LF "
1642 "on all other systems). This may be overridden through use "
1643 "of the LINEFORMAT layer creation option which may have a value "
1644 "of CRLF (DOS format) or LF (Unix format)." ),
1646 << QStringLiteral(
"CRLF" )
1647 << QStringLiteral(
"LF" ),
1652 driverMetadata.insert( QStringLiteral(
"GPX" ),
1654 QStringLiteral(
"GPS eXchange Format [GPX]" ),
1655 QObject::tr(
"GPS eXchange Format [GPX]" ),
1656 QStringLiteral(
"*.gpx" ),
1657 QStringLiteral(
"gpx" ),
1660 QStringLiteral(
"UTF-8" )
1665 datasetOptions.clear();
1666 layerOptions.clear();
1668 driverMetadata.insert( QStringLiteral(
"Interlis 1" ),
1670 QStringLiteral(
"INTERLIS 1" ),
1671 QObject::tr(
"INTERLIS 1" ),
1672 QStringLiteral(
"*.itf *.xml *.ili" ),
1673 QStringLiteral(
"ili" ),
1680 datasetOptions.clear();
1681 layerOptions.clear();
1683 driverMetadata.insert( QStringLiteral(
"Interlis 2" ),
1685 QStringLiteral(
"INTERLIS 2" ),
1686 QObject::tr(
"INTERLIS 2" ),
1687 QStringLiteral(
"*.xtf *.xml *.ili" ),
1688 QStringLiteral(
"ili" ),
1695 datasetOptions.clear();
1696 layerOptions.clear();
1699 QObject::tr(
"Allows you to specify the field to use for the KML <name> element." ),
1700 QStringLiteral(
"Name" )
1704 QObject::tr(
"Allows you to specify the field to use for the KML <description> element." ),
1705 QStringLiteral(
"Description" )
1709 QObject::tr(
"Allows you to specify the AltitudeMode to use for KML geometries. "
1710 "This will only affect 3D geometries and must be one of the valid KML options." ),
1712 << QStringLiteral(
"clampToGround" )
1713 << QStringLiteral(
"relativeToGround" )
1714 << QStringLiteral(
"absolute" ),
1715 QStringLiteral(
"relativeToGround" )
1719 QObject::tr(
"The DOCUMENT_ID datasource creation option can be used to specified "
1720 "the id of the root <Document> node. The default value is root_doc." ),
1721 QStringLiteral(
"root_doc" )
1724 driverMetadata.insert( QStringLiteral(
"KML" ),
1726 QStringLiteral(
"Keyhole Markup Language [KML]" ),
1727 QObject::tr(
"Keyhole Markup Language [KML]" ),
1728 QStringLiteral(
"*.kml" ),
1729 QStringLiteral(
"kml" ),
1732 QStringLiteral(
"UTF-8" )
1737 datasetOptions.clear();
1738 layerOptions.clear();
1740 auto insertMapInfoOptions = []( QMap<QString, QgsVectorFileWriter::Option *> &datasetOptions, QMap<QString, QgsVectorFileWriter::Option *> &layerOptions )
1743 QObject::tr(
"Use this to turn on 'quick spatial index mode'. "
1744 "In this mode writing files can be about 5 times faster, "
1745 "but spatial queries can be up to 30 times slower." ),
1747 << QStringLiteral(
"QUICK" )
1748 << QStringLiteral(
"OPTIMIZED" ),
1749 QStringLiteral(
"QUICK" ),
1754 QObject::tr(
"(multiples of 512): Block size for .map files. Defaults "
1755 "to 512. MapInfo 15.2 and above creates .tab files with a "
1756 "blocksize of 16384 bytes. Any MapInfo version should be "
1757 "able to handle block sizes from 512 to 32256." ),
1761 QObject::tr(
"xmin,ymin,xmax,ymax: Define custom layer bounds to increase the "
1762 "accuracy of the coordinates. Note: the geometry of written "
1763 "features must be within the defined box." ),
1767 insertMapInfoOptions( datasetOptions, layerOptions );
1769 driverMetadata.insert( QStringLiteral(
"MapInfo File" ),
1771 QStringLiteral(
"Mapinfo" ),
1772 QObject::tr(
"Mapinfo TAB" ),
1773 QStringLiteral(
"*.tab" ),
1774 QStringLiteral(
"tab" ),
1779 datasetOptions.clear();
1780 layerOptions.clear();
1781 insertMapInfoOptions( datasetOptions, layerOptions );
1784 driverMetadata.insert( QStringLiteral(
"MapInfo MIF" ),
1786 QStringLiteral(
"Mapinfo" ),
1787 QObject::tr(
"Mapinfo MIF" ),
1788 QStringLiteral(
"*.mif" ),
1789 QStringLiteral(
"mif" ),
1796 datasetOptions.clear();
1797 layerOptions.clear();
1800 QObject::tr(
"Determine whether 2D (seed_2d.dgn) or 3D (seed_3d.dgn) "
1801 "seed file should be used. This option is ignored if the SEED option is provided." ),
1806 QObject::tr(
"Override the seed file to use." ),
1811 QObject::tr(
"Indicate whether the whole seed file should be copied. "
1812 "If not, only the first three elements will be copied." ),
1817 QObject::tr(
"Indicates whether the color table should be copied from the seed file." ),
1822 QObject::tr(
"Override the master unit name from the seed file with "
1823 "the provided one or two character unit name." ),
1828 QObject::tr(
"Override the sub unit name from the seed file with the provided "
1829 "one or two character unit name." ),
1834 QObject::tr(
"Override the number of subunits per master unit. "
1835 "By default the seed file value is used." ),
1840 QObject::tr(
"Override the number of UORs (Units of Resolution) "
1841 "per sub unit. By default the seed file value is used." ),
1846 QObject::tr(
"ORIGIN=x,y,z: Override the origin of the design plane. "
1847 "By default the origin from the seed file is used." ),
1851 driverMetadata.insert( QStringLiteral(
"DGN" ),
1853 QStringLiteral(
"Microstation DGN" ),
1854 QObject::tr(
"Microstation DGN" ),
1855 QStringLiteral(
"*.dgn" ),
1856 QStringLiteral(
"dgn" ),
1863 datasetOptions.clear();
1864 layerOptions.clear();
1867 QObject::tr(
"Should update files be incorporated into the base data on the fly." ),
1869 << QStringLiteral(
"APPLY" )
1870 << QStringLiteral(
"IGNORE" ),
1871 QStringLiteral(
"APPLY" )
1875 QObject::tr(
"Should multipoint soundings be split into many single point sounding features. "
1876 "Multipoint geometries are not well handled by many formats, "
1877 "so it can be convenient to split single sounding features with many points "
1878 "into many single point features." ),
1883 QObject::tr(
"Should a DEPTH attribute be added on SOUNDG features and assign the depth "
1884 "of the sounding. This should only be enabled when SPLIT_MULTIPOINT is "
1890 QObject::tr(
"Should all the low level geometry primitives be returned as special "
1891 "IsolatedNode, ConnectedNode, Edge and Face layers." ),
1896 QObject::tr(
"If enabled, numeric attributes assigned an empty string as a value will "
1897 "be preserved as a special numeric value. This option should not generally "
1898 "be needed, but may be useful when translated S-57 to S-57 losslessly." ),
1903 QObject::tr(
"Should LNAM and LNAM_REFS fields be attached to features capturing "
1904 "the feature to feature relationships in the FFPT group of the S-57 file." ),
1909 QObject::tr(
"Should additional attributes relating features to their underlying "
1910 "geometric primitives be attached. These are the values of the FSPT group, "
1911 "and are primarily needed when doing S-57 to S-57 translations." ),
1916 QObject::tr(
"Should attribute values be recoded to UTF-8 from the character encoding "
1917 "specified in the S57 DSSI record." ),
1923 driverMetadata.insert( QStringLiteral(
"S57" ),
1925 QStringLiteral(
"S-57 Base file" ),
1926 QObject::tr(
"S-57 Base file" ),
1927 QStringLiteral(
"*.000" ),
1928 QStringLiteral(
"000" ),
1935 datasetOptions.clear();
1936 layerOptions.clear();
1938 driverMetadata.insert( QStringLiteral(
"SDTS" ),
1940 QStringLiteral(
"Spatial Data Transfer Standard [SDTS]" ),
1941 QObject::tr(
"Spatial Data Transfer Standard [SDTS]" ),
1942 QStringLiteral(
"*catd.ddf" ),
1943 QStringLiteral(
"ddf" ),
1950 datasetOptions.clear();
1951 layerOptions.clear();
1954 QObject::tr(
"Can be used to avoid creating the geometry_columns and spatial_ref_sys "
1955 "tables in a new database. By default these metadata tables are created "
1956 "when a new database is created." ),
1962 QStringLiteral(
"NO" )
1967 QStringLiteral(
"NO" )
1971 QObject::tr(
"Controls the format used for the geometry column. Defaults to WKB. "
1972 "This is generally more space and processing efficient, but harder "
1973 "to inspect or use in simple applications than WKT (Well Known Text)." ),
1975 << QStringLiteral(
"WKB" )
1976 << QStringLiteral(
"WKT" ),
1977 QStringLiteral(
"WKB" )
1981 QObject::tr(
"Controls whether layer and field names will be laundered for easier use "
1982 "in SQLite. Laundered names will be converted to lower case and some special "
1983 "characters(' - #) will be changed to underscores." ),
1988 QStringLiteral(
"NO" )
1992 QStringLiteral(
"NO" )
2000 QObject::tr(
"column_name1[,column_name2, …] A list of (String) columns that "
2001 "must be compressed with ZLib DEFLATE algorithm. This might be beneficial "
2002 "for databases that have big string blobs. However, use with care, since "
2003 "the value of such columns will be seen as compressed binary content with "
2004 "other SQLite utilities (or previous OGR versions). With OGR, when inserting, "
2005 "modifying or querying compressed columns, compression/decompression is "
2006 "done transparently. However, such columns cannot be (easily) queried with "
2007 "an attribute filter or WHERE clause. Note: in table definition, such columns "
2008 "have the 'VARCHAR_deflate' declaration type." ),
2012 driverMetadata.insert( QStringLiteral(
"SQLite" ),
2014 QStringLiteral(
"SQLite" ),
2015 QObject::tr(
"SQLite" ),
2016 QStringLiteral(
"*.sqlite" ),
2017 QStringLiteral(
"sqlite" ),
2020 QStringLiteral(
"UTF-8" )
2025 datasetOptions.clear();
2026 layerOptions.clear();
2029 QObject::tr(
"Can be used to avoid creating the geometry_columns and spatial_ref_sys "
2030 "tables in a new database. By default these metadata tables are created "
2031 "when a new database is created." ),
2036 QStringLiteral(
"YES" )
2040 QObject::tr(
"Insert the content of the EPSG CSV files into the spatial_ref_sys table. "
2041 "Set to NO for regular SQLite databases." ),
2046 QStringLiteral(
"SPATIALITE" )
2050 QObject::tr(
"Controls whether layer and field names will be laundered for easier use "
2051 "in SQLite. Laundered names will be converted to lower case and some special "
2052 "characters(' - #) will be changed to underscores." ),
2057 QObject::tr(
"If the database is of the SpatiaLite flavor, and if OGR is linked "
2058 "against libspatialite, this option can be used to control if a spatial "
2059 "index must be created." ),
2064 QObject::tr(
"If the format of the geometry BLOB is of the SpatiaLite flavor, "
2065 "this option can be used to control if the compressed format for "
2066 "geometries (LINESTRINGs, POLYGONs) must be used." ),
2071 QObject::tr(
"Used to force the SRID number of the SRS associated with the layer. "
2072 "When this option isn't specified and that a SRS is associated with the "
2073 "layer, a search is made in the spatial_ref_sys to find a match for the "
2074 "SRS, and, if there is no match, a new entry is inserted for the SRS in "
2075 "the spatial_ref_sys table. When the SRID option is specified, this "
2076 "search (and the eventual insertion of a new entry) will not be done: "
2077 "the specified SRID is used as such." ),
2082 QObject::tr(
"column_name1[,column_name2, …] A list of (String) columns that "
2083 "must be compressed with ZLib DEFLATE algorithm. This might be beneficial "
2084 "for databases that have big string blobs. However, use with care, since "
2085 "the value of such columns will be seen as compressed binary content with "
2086 "other SQLite utilities (or previous OGR versions). With OGR, when inserting, "
2087 "modifying or queryings compressed columns, compression/decompression is "
2088 "done transparently. However, such columns cannot be (easily) queried with "
2089 "an attribute filter or WHERE clause. Note: in table definition, such columns "
2090 "have the 'VARCHAR_deflate' declaration type." ),
2094 driverMetadata.insert( QStringLiteral(
"SpatiaLite" ),
2096 QStringLiteral(
"SpatiaLite" ),
2097 QObject::tr(
"SpatiaLite" ),
2098 QStringLiteral(
"*.sqlite" ),
2099 QStringLiteral(
"sqlite" ),
2102 QStringLiteral(
"UTF-8" )
2106 datasetOptions.clear();
2107 layerOptions.clear();
2110 QObject::tr(
"Override the header file used - in place of header.dxf." ),
2115 QObject::tr(
"Override the trailer file used - in place of trailer.dxf." ),
2119 driverMetadata.insert( QStringLiteral(
"DXF" ),
2121 QStringLiteral(
"AutoCAD DXF" ),
2122 QObject::tr(
"AutoCAD DXF" ),
2123 QStringLiteral(
"*.dxf" ),
2124 QStringLiteral(
"dxf" ),
2131 datasetOptions.clear();
2132 layerOptions.clear();
2135 QObject::tr(
"Indicates the GeoConcept export file extension. "
2136 "TXT was used by earlier releases of GeoConcept. GXT is currently used." ),
2138 << QStringLiteral(
"GXT" )
2139 << QStringLiteral(
"TXT" ),
2140 QStringLiteral(
"GXT" )
2144 QObject::tr(
"Path to the GCT: the GCT file describes the GeoConcept types definitions: "
2145 "In this file, every line must start with //# followed by a keyword. "
2146 "Lines starting with // are comments." ),
2151 QObject::tr(
"Defines the feature to be created. The TYPE corresponds to one of the Name "
2152 "found in the GCT file for a type section. The SUBTYPE corresponds to one of "
2153 "the Name found in the GCT file for a sub-type section within the previous "
2158 driverMetadata.insert( QStringLiteral(
"Geoconcept" ),
2160 QStringLiteral(
"Geoconcept" ),
2161 QObject::tr(
"Geoconcept" ),
2162 QStringLiteral(
"*.gxt *.txt" ),
2163 QStringLiteral(
"gxt" ),
2170 datasetOptions.clear();
2171 layerOptions.clear();
2173#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,9,0)
2175 QObject::tr(
"Selects which ArcGIS version this dataset should be compatible with. ALL is used by default and means any ArcGIS 10.x or ArcGIS Pro version. Using ARCGIS_PRO_3_2_OR_LATER is required to export 64-bit integer fields as such, otherwise they will be converted as Real fields. ARCGIS_PRO_3_2_OR_LATER also supports proper Date and Time field types." ),
2177 << QStringLiteral(
"ALL" )
2178 << QStringLiteral(
"ARCGIS_PRO_3_2_OR_LATER" ),
2179 QStringLiteral(
"ALL" )
2184 QObject::tr(
"When this option is set, the new layer will be created inside the named "
2185 "FeatureDataset folder. If the folder does not already exist, it will be created." ),
2190 QObject::tr(
"Set layer name alias." ),
2195 QObject::tr(
"Set name of geometry column in new layer. Defaults to 'SHAPE'." ),
2196 QStringLiteral(
"SHAPE" )
2200 QObject::tr(
"Whether the values of the geometry column can be NULL. Can be set to NO so that geometry is required. Default to 'YES'." ),
2205 QObject::tr(
"Name of the OID column to create. Defaults to 'OBJECTID'." ),
2206 QStringLiteral(
"OBJECTID" )
2222 QObject::tr(
"A list of strings of format field_name=fgdb_field_type (separated by comma) to force the FileGDB column type of fields to be created." ),
2227 QObject::tr(
"XML documentation for the layer." ),
2231 QObject::tr(
"Customize how data is stored. By default text in UTF-8 and data up to 1TB." ),
2232 {QStringLiteral(
"DEFAULTS" ), QStringLiteral(
"MAX_FILE_SIZE_4GB" ), QStringLiteral(
"MAX_FILE_SIZE_256TB" )},
2233 QStringLiteral(
"DEFAULTS" ),
2238 QObject::tr(
" Defaults to NO (through CreateLayer() API). When this option is set, a Shape_Area and Shape_Length special fields will be created for polygonal layers (Shape_Length only for linear layers). These fields will automatically be populated with the feature’s area or length whenever a new feature is added to the dataset or an existing feature is amended. When using ogr2ogr with a source layer that has Shape_Area/Shape_Length special fields, and this option is not explicitly specified, it will be automatically set, so that the resulting FileGeodatabase has those fields properly tagged." ),
2242 driverMetadata.insert( QStringLiteral(
"OpenFileGDB" ),
2244 QStringLiteral(
"ESRI File Geodatabase" ),
2245 QObject::tr(
"ESRI File Geodatabase" ),
2246 QStringLiteral(
"*.gdb" ),
2247 QStringLiteral(
"gdb" ),
2250 QStringLiteral(
"UTF-8" )
2255 datasetOptions.clear();
2256 layerOptions.clear();
2259 QObject::tr(
"When this option is set, the new layer will be created inside the named "
2260 "FeatureDataset folder. If the folder does not already exist, it will be created." ),
2265 QObject::tr(
"Set name of geometry column in new layer. Defaults to 'SHAPE'." ),
2266 QStringLiteral(
"SHAPE" )
2270 QObject::tr(
"Name of the OID column to create. Defaults to 'OBJECTID'." ),
2271 QStringLiteral(
"OBJECTID" )
2274 driverMetadata.insert( QStringLiteral(
"FileGDB" ),
2276 QStringLiteral(
"ESRI FileGDB" ),
2277 QObject::tr(
"ESRI FileGDB" ),
2278 QStringLiteral(
"*.gdb" ),
2279 QStringLiteral(
"gdb" ),
2282 QStringLiteral(
"UTF-8" )
2287 datasetOptions.clear();
2288 layerOptions.clear();
2291 QObject::tr(
"By default, the driver will try to detect the data type of fields. If set "
2292 "to STRING, all fields will be of String type." ),
2294 << QStringLiteral(
"AUTO" )
2295 << QStringLiteral(
"STRING" ),
2296 QStringLiteral(
"AUTO" ),
2301 QObject::tr(
"By default, the driver will read the first lines of each sheet to detect "
2302 "if the first line might be the name of columns. If set to FORCE, the driver "
2303 "will consider the first line as the header line. If set to "
2304 "DISABLE, it will be considered as the first feature. Otherwise "
2305 "auto-detection will occur." ),
2307 << QStringLiteral(
"FORCE" )
2308 << QStringLiteral(
"DISABLE" )
2309 << QStringLiteral(
"AUTO" ),
2310 QStringLiteral(
"AUTO" ),
2314 driverMetadata.insert( QStringLiteral(
"XLSX" ),
2316 QStringLiteral(
"MS Office Open XML spreadsheet" ),
2317 QObject::tr(
"MS Office Open XML spreadsheet [XLSX]" ),
2318 QStringLiteral(
"*.xlsx" ),
2319 QStringLiteral(
"xlsx" ),
2322 QStringLiteral(
"UTF-8" )
2327 datasetOptions.clear();
2328 layerOptions.clear();
2331 QObject::tr(
"By default, the driver will try to detect the data type of fields. If set "
2332 "to STRING, all fields will be of String type." ),
2334 << QStringLiteral(
"AUTO" )
2335 << QStringLiteral(
"STRING" ),
2336 QStringLiteral(
"AUTO" ),
2341 QObject::tr(
"By default, the driver will read the first lines of each sheet to detect "
2342 "if the first line might be the name of columns. If set to FORCE, the driver "
2343 "will consider the first line as the header line. If set to "
2344 "DISABLE, it will be considered as the first feature. Otherwise "
2345 "auto-detection will occur." ),
2347 << QStringLiteral(
"FORCE" )
2348 << QStringLiteral(
"DISABLE" )
2349 << QStringLiteral(
"AUTO" ),
2350 QStringLiteral(
"AUTO" ),
2354 driverMetadata.insert( QStringLiteral(
"ODS" ),
2356 QStringLiteral(
"Open Document Spreadsheet" ),
2357 QObject::tr(
"Open Document Spreadsheet [ODS]" ),
2358 QStringLiteral(
"*.ods" ),
2359 QStringLiteral(
"ods" ),
2362 QStringLiteral(
"UTF-8" )
2367 datasetOptions.clear();
2368 layerOptions.clear();
2371 QObject::tr(
"Compression method." ),
2373 << QStringLiteral(
"UNCOMPRESSED" )
2374 << QStringLiteral(
"SNAPPY" ),
2375 QStringLiteral(
"SNAPPY" ),
2380 QObject::tr(
"Geometry encoding." ),
2382 << QStringLiteral(
"WKB" )
2383 << QStringLiteral(
"WKT" )
2384 << QStringLiteral(
"GEOARROW" ),
2385 QStringLiteral(
"WKB" ),
2390 QObject::tr(
"Maximum number of rows per group." ),
2395 QObject::tr(
"Name for the feature identifier column" ),
2400 QObject::tr(
"Name for the geometry column" ),
2401 QStringLiteral(
"geometry" )
2405 QObject::tr(
"Name of the coordinate system for the edges." ),
2407 << QStringLiteral(
"PLANAR" )
2408 << QStringLiteral(
"SPHERICAL" ),
2409 QStringLiteral(
"PLANAR" ),
2413 driverMetadata.insert( QStringLiteral(
"Parquet" ),
2415 QStringLiteral(
"(Geo)Parquet" ),
2416 QObject::tr(
"(Geo)Parquet" ),
2417 QStringLiteral(
"*.parquet" ),
2418 QStringLiteral(
"parquet" ),
2421 QStringLiteral(
"UTF-8" )
2426 datasetOptions.clear();
2427 layerOptions.clear();
2430 QObject::tr(
"Line termination character sequence." ),
2432 << QStringLiteral(
"CRLF" )
2433 << QStringLiteral(
"LF" ),
2434 QStringLiteral(
"LF" ),
2440 QObject::tr(
"Format of geometry columns." ),
2442 << QStringLiteral(
"geometry" )
2443 << QStringLiteral(
"geography" ),
2444 QStringLiteral(
"geometry" ),
2449 QObject::tr(
"Controls whether layer and field names will be laundered for easier use. "
2450 "Laundered names will be converted to lower case and some special "
2451 "characters(' - #) will be changed to underscores." ),
2456 QObject::tr(
"Name for the geometry column. Defaults to wkb_geometry "
2457 "for GEOM_TYPE=geometry or the_geog for GEOM_TYPE=geography" ) ) );
2460 QObject::tr(
"Name of schema into which to create the new table" ) ) );
2463 QObject::tr(
"Whether to explicitly emit the CREATE SCHEMA statement to create the specified schema." ),
2468 QObject::tr(
"Whether to explicitly recreate the table if necessary." ),
2473 QObject::tr(
"Whether to explicitly destroy tables before recreating them." ),
2475 << QStringLiteral(
"YES" )
2476 << QStringLiteral(
"NO" )
2477 << QStringLiteral(
"IF_EXISTS" ),
2478 QStringLiteral(
"YES" ),
2483 QObject::tr(
"Used to force the SRID number of the SRS associated with the layer. "
2484 "When this option isn't specified and that a SRS is associated with the "
2485 "layer, a search is made in the spatial_ref_sys to find a match for the "
2486 "SRS, and, if there is no match, a new entry is inserted for the SRS in "
2487 "the spatial_ref_sys table. When the SRID option is specified, this "
2488 "search (and the eventual insertion of a new entry) will not be done: "
2489 "the specified SRID is used as such." ),
2494 QObject::tr(
"Can be set to 2.0 or 2.2 for PostGIS 2.0/2.2 compatibility. "
2495 "Important to set it correctly if using non-linear geometry types" ),
2496 QStringLiteral(
"2.2" )
2499 driverMetadata.insert( QStringLiteral(
"PGDUMP" ),
2501 QStringLiteral(
"PostgreSQL SQL dump" ),
2502 QObject::tr(
"PostgreSQL SQL dump" ),
2503 QStringLiteral(
"*.sql" ),
2504 QStringLiteral(
"sql" ),
2507 QStringLiteral(
"UTF-8" )
2513 QgsVectorFileWriterMetadataContainer(
const QgsVectorFileWriterMetadataContainer &other ) =
delete;
2514 QgsVectorFileWriterMetadataContainer &operator=(
const QgsVectorFileWriterMetadataContainer &other ) =
delete;
2515 ~QgsVectorFileWriterMetadataContainer()
2517 for (
auto it = driverMetadata.constBegin(); it != driverMetadata.constEnd(); ++it )
2519 for (
auto optionIt = it.value().driverOptions.constBegin(); optionIt != it.value().driverOptions.constEnd(); ++optionIt )
2520 delete optionIt.value();
2521 for (
auto optionIt = it.value().layerOptions.constBegin(); optionIt != it.value().layerOptions.constEnd(); ++optionIt )
2522 delete optionIt.value();
2526 QMap<QString, QgsVectorFileWriter::MetaData> driverMetadata;
2533 static QgsVectorFileWriterMetadataContainer sDriverMetadata;
2534 QMap<QString, MetaData>::ConstIterator it = sDriverMetadata.driverMetadata.constBegin();
2536 for ( ; it != sDriverMetadata.driverMetadata.constEnd(); ++it )
2538 if ( it.key() == QLatin1String(
"PGDUMP" ) &&
2539 driverName != QLatin1String(
"PGDUMP" ) &&
2540 driverName != QLatin1String(
"PostgreSQL SQL dump" ) )
2545 if ( it.key().startsWith( driverName ) || it.value().longName.startsWith( driverName ) )
2560 return QStringList();
2569 return QStringList();
2576 OGRwkbGeometryType ogrType =
static_cast<OGRwkbGeometryType
>( type );
2607 return mCapabilities;
2617 QgsFeatureList::iterator fIt = features.begin();
2619 for ( ; fIt != features.end(); ++fIt )
2644 QString styleString;
2645 QString currentStyle;
2647 QgsSymbolList::const_iterator symbolIt = symbols.constBegin();
2648 for ( ; symbolIt != symbols.constEnd(); ++symbolIt )
2650 int nSymbolLayers = ( *symbolIt )->symbolLayerCount();
2651 for (
int i = 0; i < nSymbolLayers; ++i )
2654 QMap< QgsSymbolLayer *, QString >::const_iterator it =
mSymbolLayerTable.find( ( *symbolIt )->symbolLayer( i ) );
2660 double mmsf = mmScaleFactor(
mSymbologyScale, ( *symbolIt )->outputUnit(), outputUnit );
2661 double musf = mapUnitScaleFactor(
mSymbologyScale, ( *symbolIt )->outputUnit(), outputUnit );
2663 currentStyle = ( *symbolIt )->symbolLayer( i )->ogrFeatureStyle( mmsf, musf );
2669 if ( symbolIt != symbols.constBegin() || i != 0 )
2671 styleString.append(
';' );
2673 styleString.append( currentStyle );
2678 OGR_F_SetStyleString( poFeature.get(), currentStyle.toLocal8Bit().constData() );
2679 if ( !writeFeature(
mLayer, poFeature.get() ) )
2691 OGR_F_SetStyleString( poFeature.get(), styleString.toLocal8Bit().constData() );
2699 if ( !writeFeature(
mLayer, poFeature.get() ) )
2723 int fldIdx = it.key();
2724 int ogrField = it.value();
2726 QVariant attrValue = feature.
attribute( fldIdx );
2731 OGR_F_UnsetField( poFeature.get(), ogrField );
2744 OGR_F_SetFieldNull( poFeature.get(), ogrField );
2759 mErrorMessage = QObject::tr(
"Error converting value (%1) for attribute field %2: %3" )
2760 .arg( feature.
attribute( fldIdx ).toString(),
2767 switch ( field.
type() )
2769 case QMetaType::Type::Int:
2770 OGR_F_SetFieldInteger( poFeature.get(), ogrField, attrValue.toInt() );
2772 case QMetaType::Type::LongLong:
2773 OGR_F_SetFieldInteger64( poFeature.get(), ogrField, attrValue.toLongLong() );
2775 case QMetaType::Type::Bool:
2776 OGR_F_SetFieldInteger( poFeature.get(), ogrField, attrValue.toInt() );
2778 case QMetaType::Type::QString:
2779 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( attrValue.toString() ).constData() );
2781 case QMetaType::Type::Double:
2782 OGR_F_SetFieldDouble( poFeature.get(), ogrField, attrValue.toDouble() );
2784 case QMetaType::Type::QDate:
2785 OGR_F_SetFieldDateTime( poFeature.get(), ogrField,
2786 attrValue.toDate().year(),
2787 attrValue.toDate().month(),
2788 attrValue.toDate().day(),
2791 case QMetaType::Type::QDateTime:
2794 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( attrValue.toDateTime().toString( QStringLiteral(
"yyyy/MM/dd hh:mm:ss.zzz" ) ) ).constData() );
2798 const QDateTime dt = attrValue.toDateTime();
2799 const QDate date = dt.date();
2800 const QTime time = dt.time();
2801 OGR_F_SetFieldDateTimeEx( poFeature.get(), ogrField,
2807 static_cast<float>( time.second() +
static_cast< double >( time.msec() ) / 1000 ),
2811 case QMetaType::Type::QTime:
2814 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( attrValue.toString() ).constData() );
2818 const QTime time = attrValue.toTime();
2819 OGR_F_SetFieldDateTimeEx( poFeature.get(), ogrField,
2823 static_cast<float>( time.second() +
static_cast< double >( time.msec() ) / 1000 ),
2828 case QMetaType::Type::QByteArray:
2830 const QByteArray ba = attrValue.toByteArray();
2831 OGR_F_SetFieldBinary( poFeature.get(), ogrField, ba.size(),
const_cast< GByte *
>(
reinterpret_cast< const GByte *
>( ba.data() ) ) );
2835 case QMetaType::Type::UnknownType:
2838 case QMetaType::Type::QStringList:
2843 const QJsonDocument doc = QJsonDocument::fromVariant( attrValue );
2845 if ( !doc.isNull() )
2847 jsonString = QString::fromUtf8( doc.toJson( QJsonDocument::Compact ).constData() );
2849 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( jsonString.constData() ) );
2853 QStringList list = attrValue.toStringList();
2854 if ( mSupportedListSubTypes.contains( QMetaType::Type::QString ) )
2856 int count = list.count();
2857 char **lst =
new char *[count + 1];
2861 for (
const QString &
string : list )
2863 lst[pos] = CPLStrdup(
mCodec->fromUnicode(
string ).data() );
2867 lst[count] =
nullptr;
2868 OGR_F_SetFieldStringList( poFeature.get(), ogrField, lst );
2873 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( list.join(
',' ) ).constData() );
2878 case QMetaType::Type::QVariantList:
2882 const QJsonDocument doc = QJsonDocument::fromVariant( attrValue );
2884 if ( !doc.isNull() )
2886 jsonString = QString::fromUtf8( doc.toJson( QJsonDocument::Compact ).data() );
2888 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( jsonString.constData() ) );
2893 if ( field.
subType() == QMetaType::Type::QString )
2895 QStringList list = attrValue.toStringList();
2896 if ( mSupportedListSubTypes.contains( QMetaType::Type::QString ) )
2898 int count = list.count();
2899 char **lst =
new char *[count + 1];
2903 for (
const QString &
string : list )
2905 lst[pos] = CPLStrdup(
mCodec->fromUnicode(
string ).data() );
2909 lst[count] =
nullptr;
2910 OGR_F_SetFieldStringList( poFeature.get(), ogrField, lst );
2915 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( list.join(
',' ) ).constData() );
2919 else if ( field.
subType() == QMetaType::Type::Int )
2921 const QVariantList list = attrValue.toList();
2922 if ( mSupportedListSubTypes.contains( QMetaType::Type::Int ) )
2924 const int count = list.count();
2925 int *lst =
new int[count];
2929 for (
const QVariant &value : list )
2931 lst[pos] = value.toInt();
2935 OGR_F_SetFieldIntegerList( poFeature.get(), ogrField, count, lst );
2940 QStringList strings;
2941 strings.reserve( list.size() );
2942 for (
const QVariant &value : list )
2944 strings << QString::number( value.toInt() );
2946 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( strings.join(
',' ) ).constData() );
2950 else if ( field.
subType() == QMetaType::Type::Double )
2952 const QVariantList list = attrValue.toList();
2953 if ( mSupportedListSubTypes.contains( QMetaType::Type::Double ) )
2955 const int count = list.count();
2956 double *lst =
new double[count];
2960 for (
const QVariant &value : list )
2962 lst[pos] = value.toDouble();
2966 OGR_F_SetFieldDoubleList( poFeature.get(), ogrField, count, lst );
2971 QStringList strings;
2972 strings.reserve( list.size() );
2973 for (
const QVariant &value : list )
2975 strings << QString::number( value.toDouble() );
2977 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( strings.join(
',' ) ).constData() );
2981 else if ( field.
subType() == QMetaType::Type::LongLong )
2983 const QVariantList list = attrValue.toList();
2984 if ( mSupportedListSubTypes.contains( QMetaType::Type::LongLong ) )
2986 const int count = list.count();
2987 long long *lst =
new long long[count];
2991 for (
const QVariant &value : list )
2993 lst[pos] = value.toLongLong();
2997 OGR_F_SetFieldInteger64List( poFeature.get(), ogrField, count, lst );
3002 QStringList strings;
3003 strings.reserve( list.size() );
3004 for (
const QVariant &value : list )
3006 strings << QString::number( value.toLongLong() );
3008 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( strings.join(
',' ) ).constData() );
3015 case QMetaType::Type::QVariantMap:
3018 const char *pszDataSubTypes = GDALGetMetadataItem( OGRGetDriverByName(
mOgrDriverName.toLocal8Bit().constData() ), GDAL_DMD_CREATIONFIELDDATASUBTYPES,
nullptr );
3019 if ( pszDataSubTypes && strstr( pszDataSubTypes,
"JSON" ) )
3021 const QJsonDocument doc = QJsonDocument::fromVariant( attrValue );
3023 if ( !doc.isNull() )
3025 const QByteArray json { doc.toJson( QJsonDocument::Compact ) };
3026 jsonString = QString::fromUtf8( json.data() );
3028 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( jsonString.constData() ) );
3038 mErrorMessage = QObject::tr(
"Invalid variant type for field %1[%2]: received %3 with type %4" )
3041 .arg( attrValue.typeName(),
3042 attrValue.toString() );
3055 if ( mCoordinateTransform )
3060 geom.
transform( *mCoordinateTransform );
3078 OGRGeometryH mGeom2 =
nullptr;
3107 geom.
get()->
addZValue( std::numeric_limits<double>::quiet_NaN() );
3114 geom.
get()->
addMValue( std::numeric_limits<double>::quiet_NaN() );
3134 mErrorMessage = QObject::tr(
"Feature geometry not imported (OGR error: %1)" )
3135 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3145 QByteArray wkb( geom.
asWkb( wkbFlags ) );
3146 OGRErr err = OGR_G_ImportFromWkb( mGeom2,
reinterpret_cast<unsigned char *
>(
const_cast<char *
>( wkb.constData() ) ), wkb.length() );
3147 if ( err != OGRERR_NONE )
3149 mErrorMessage = QObject::tr(
"Feature geometry not imported (OGR error: %1)" )
3150 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3157 OGR_F_SetGeometryDirectly( poFeature.get(), mGeom2 );
3165 QByteArray wkb( geom.
asWkb( wkbFlags ) );
3167 OGRErr err = OGR_G_ImportFromWkb( ogrGeom,
reinterpret_cast<unsigned char *
>(
const_cast<char *
>( wkb.constData() ) ), wkb.length() );
3168 if ( err != OGRERR_NONE )
3170 mErrorMessage = QObject::tr(
"Feature geometry not imported (OGR error: %1)" )
3171 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3178 OGR_F_SetGeometryDirectly( poFeature.get(), ogrGeom );
3193 for (
int i = 0; i < attributes.size(); i++ )
3195 if ( omap.find( i ) != omap.end() )
3200bool QgsVectorFileWriter::writeFeature( OGRLayerH layer, OGRFeatureH feature )
3202 if ( OGR_L_CreateFeature( layer, feature ) != OGRERR_NONE )
3204 mErrorMessage = QObject::tr(
"Feature creation error (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3214 if ( mUsingTransaction )
3216 if ( OGRERR_NONE != OGR_L_CommitTransaction(
mLayer ) )
3218 QgsDebugError( QStringLiteral(
"Error while committing transaction on OGRLayer." ) );
3231 const QString &fileName,
3232 const QString &fileEncoding,
3234 const QString &driverName,
3236 QString *errorMessage,
3237 const QStringList &datasourceOptions,
3238 const QStringList &layerOptions,
3239 bool skipAttributeCreation,
3240 QString *newFilename,
3242 double symbologyScale,
3252 if ( destCRS.
isValid() && layer )
3278 const QString &fileName,
3279 const QString &fileEncoding,
3281 const QString &driverName,
3283 QString *errorMessage,
3284 const QStringList &datasourceOptions,
3285 const QStringList &layerOptions,
3286 bool skipAttributeCreation,
3287 QString *newFilename,
3289 double symbologyScale,
3320 : driverName( QStringLiteral(
"GPKG" ) )
3328 if ( !layer || !layer->
isValid() )
3335 details.sourceCrs = layer->
crs();
3336 details.sourceWkbType = layer->
wkbType();
3337 details.sourceFields = layer->
fields();
3346 if ( details.storageType == QLatin1String(
"ESRI Shapefile" ) )
3354 details.geometryTypeScanIterator = layer->
getFeatures( req );
3358 details.renderContext.setExpressionContext( details.expressionContext );
3359 details.renderContext.setRendererScale( options.
symbologyScale );
3361 details.shallTransform =
false;
3366 details.shallTransform =
true;
3371 details.outputCrs = details.sourceCrs;
3374 details.destWkbType = details.sourceWkbType;
3388 details.attributes.clear();
3389 else if ( details.attributes.isEmpty() )
3391 const QgsAttributeList allAttributes = details.sourceFields.allAttributesList();
3392 for (
int idx : allAttributes )
3394 QgsField fld = details.sourceFields.at( idx );
3395 if ( details.providerType == QLatin1String(
"oracle" ) && fld.
typeName().contains( QLatin1String(
"SDO_GEOMETRY" ) ) )
3397 details.attributes.append( idx );
3401 if ( !details.attributes.isEmpty() )
3403 for (
int attrIdx : std::as_const( details.attributes ) )
3405 if ( details.sourceFields.exists( attrIdx ) )
3407 QgsField field = details.sourceFields.at( attrIdx );
3409 details.outputFields.append( field );
3413 QgsDebugError( QStringLiteral(
"No such source field with index '%1' available." ).arg( attrIdx ) );
3420 if ( details.providerType == QLatin1String(
"spatialite" ) )
3422 for (
int i = 0; i < details.outputFields.size(); i++ )
3424 if ( details.outputFields.at( i ).type() == QMetaType::Type::LongLong )
3429 if ( std::max( std::llabs( min.toLongLong() ), std::llabs( max.toLongLong() ) ) < std::numeric_limits<int>::max() )
3431 details.outputFields[i].setType( QMetaType::Type::Int );
3439 addRendererAttributes( details.renderer.get(), details.renderContext, details.sourceFields, details.attributes );
3449 bool useFilterRect =
true;
3450 if ( details.shallTransform )
3461 useFilterRect =
false;
3464 if ( useFilterRect )
3470 details.filterRectEngine->prepareGeometry();
3472 details.sourceFeatureIterator = layer->
getFeatures( req );
3491 int lastProgressReport = 0;
3492 long long total = details.featureCount;
3495 if ( details.providerType == QLatin1String(
"ogr" ) && !details.dataSourceUri.isEmpty() )
3497 QString srcFileName( details.providerUriParams.value( QStringLiteral(
"path" ) ).toString() );
3498 if ( QFile::exists( srcFileName ) && QFileInfo( fileName ).canonicalFilePath() == QFileInfo( srcFileName ).canonicalFilePath() )
3502 if ( !( ( options.
driverName == QLatin1String(
"GPKG" ) ||
3503 options.
driverName == QLatin1String(
"SpatiaLite" ) ||
3504 options.
driverName == QLatin1String(
"SQLite" ) ) &&
3505 options.
layerName != details.providerUriParams.value( QStringLiteral(
"layerName" ) ) ) )
3508 *
errorMessage = QObject::tr(
"Cannot overwrite an OGR layer in place" );
3528 int newProgress =
static_cast<int>( ( 5.0 * scanned ) / total );
3529 if ( newProgress != lastProgressReport )
3531 lastProgressReport = newProgress;
3546 QString tempNewFilename;
3547 QString tempNewLayer;
3555 std::unique_ptr< QgsVectorFileWriter > writer(
create( fileName, details.outputFields, destWkbType, details.outputCrs, transformContext, newOptions, sinkFlags, &tempNewFilename, &tempNewLayer ) );
3559 *newFilename = tempNewFilename;
3562 *newLayer = tempNewLayer;
3591 switch ( writer->symbologyExport() )
3609 int n = 0, errors = 0;
3618 writer->startRender( details.renderer.get(), details.sourceFields );
3620 writer->resetMap( details.attributes );
3622 writer->mFields = details.sourceFields;
3626 int initialProgress = lastProgressReport;
3627 while ( details.sourceFeatureIterator.nextFeature( fet ) )
3638 int newProgress =
static_cast<int>( initialProgress + ( ( 100.0 - initialProgress ) * saved ) / total );
3639 if ( newProgress < 100 && newProgress != lastProgressReport )
3641 lastProgressReport = newProgress;
3646 if ( details.shallTransform )
3659 const QString msg = QObject::tr(
"Failed to transform feature with ID '%1'. Writing stopped. (Exception: %2)" )
3660 .arg( fet.
id() ).arg( e.
what() );
3677 if ( !writer->addFeatureWithStyle( fet, writer->mRenderer.get(), mapUnits ) )
3684 *
errorMessage = QObject::tr(
"Feature write errors:" );
3690 if ( errors > 1000 )
3694 *
errorMessage += QObject::tr(
"Stopping after %n error(s)",
nullptr, errors );
3704 writer->stopRender();
3708 *
errorMessage += QObject::tr(
"\nOnly %1 of %2 features written." ).arg( n - errors ).arg( n );
3713 bool metadataFailure =
false;
3718 {QStringLiteral(
"path" ), tempNewFilename },
3719 {QStringLiteral(
"layerName" ), tempNewLayer }
3733 metadataFailure =
true;
3744 metadataFailure =
true;
3752 const QString &fileName,
3754 QString *newFilename,
3758 QgsVectorFileWriter::PreparedWriterDetails details;
3759 WriterError err = prepareWriteAsVectorFormat( layer, options, details );
3767 const QString &fileName,
3770 QString *newFilename,
3774 QgsVectorFileWriter::PreparedWriterDetails details;
3775 WriterError err = prepareWriteAsVectorFormat( layer, options, details );
3784 QgsVectorFileWriter::PreparedWriterDetails details;
3785 WriterError err = prepareWriteAsVectorFormat( layer, options, details );
3794 QFileInfo fi( fileName );
3795 QDir dir = fi.dir();
3798 for (
const char *suffix : {
".shp",
".shx",
".dbf",
".prj",
".qix",
".qpj",
".cpg",
".sbn",
".sbx",
".idm",
".ind" } )
3800 filter << fi.completeBaseName() + suffix;
3804 const auto constEntryList = dir.entryList( filter );
3805 for (
const QString &file : constEntryList )
3807 QFile f( dir.canonicalPath() +
'/' + file );
3810 QgsDebugError( QStringLiteral(
"Removing file %1 failed: %2" ).arg( file, f.errorString() ) );
3826 QStringList driverNames;
3829 for (
int i = 0; i < GDALGetDriverCount(); ++i )
3831 GDALDriverH
driver = GDALGetDriver( i );
3838 const QString driverExtensions = GDALGetMetadataItem(
driver, GDAL_DMD_EXTENSIONS,
"" );
3839 if ( driverExtensions.isEmpty() )
3842 const QSet< QString > splitExtensions = qgis::listToSet( driverExtensions.split(
' ', Qt::SkipEmptyParts ) );
3843 if ( splitExtensions.intersects( multiLayerExtensions ) )
3845 driverNames << OGR_Dr_GetName(
driver );
3853 static QReadWriteLock sFilterLock;
3854 static QMap< VectorFormatOptions, QList< QgsVectorFileWriter::FilterFormatDetails > > sFilters;
3858 const auto it = sFilters.constFind( options );
3859 if ( it != sFilters.constEnd() )
3863 QList< QgsVectorFileWriter::FilterFormatDetails > results;
3866 int const drvCount = OGRGetDriverCount();
3870 for (
int i = 0; i < drvCount; ++i )
3872 OGRSFDriverH drv = OGRGetDriver( i );
3875 const QString drvName = OGR_Dr_GetName( drv );
3879 if ( !multiLayerDrivers.contains( drvName ) )
3883 GDALDriverH gdalDriver = GDALGetDriverByName( drvName.toLocal8Bit().constData() );
3884 bool nonSpatialFormat =
false;
3887 nonSpatialFormat = GDALGetMetadataItem( gdalDriver, GDAL_DCAP_NONSPATIAL,
nullptr );
3890 if ( OGR_Dr_TestCapability( drv,
"CreateDataSource" ) != 0 )
3895 if ( nonSpatialFormat )
3900 if ( filterString.isEmpty() )
3907 globs = metadata.
glob.toLower().split(
' ' );
3913 details.
globs = globs;
3922 if ( options & SortRecommended )
3924 if ( a.driverName == QLatin1String(
"GPKG" ) )
3926 else if ( b.driverName == QLatin1String(
"GPKG" ) )
3928 else if ( a.driverName == QLatin1String(
"ESRI Shapefile" ) )
3930 else if ( b.driverName == QLatin1String(
"ESRI Shapefile" ) )
3937 sFilters.insert( options, results );
3944 QSet< QString > extensions;
3946 const thread_local QRegularExpression rx( QStringLiteral(
"\\*\\.(.*)$" ) );
3950 for (
const QString &glob : format.globs )
3952 const QRegularExpressionMatch match = rx.match( glob );
3953 if ( !match.hasMatch() )
3956 const QString matched = match.captured( 1 );
3957 extensions.insert( matched );
3961 QStringList extensionList( extensions.constBegin(), extensions.constEnd() );
3963 std::sort( extensionList.begin(), extensionList.end(), [options](
const QString & a,
const QString & b ) ->
bool
3965 if ( options & SortRecommended )
3967 if ( a == QLatin1String(
"gpkg" ) )
3969 else if ( b == QLatin1String(
"gpkg" ) )
3971 else if ( a == QLatin1String(
"shp" ) )
3973 else if ( b == QLatin1String(
"shp" ) )
3977 return a.toLower().localeAwareCompare( b.toLower() ) < 0;
3980 return extensionList;
3985 QList< QgsVectorFileWriter::DriverDetails > results;
3988 const int drvCount = OGRGetDriverCount();
3992 QStringList writableDrivers;
3993 for (
int i = 0; i < drvCount; ++i )
3995 OGRSFDriverH drv = OGRGetDriver( i );
3998 const QString drvName = OGR_Dr_GetName( drv );
4002 if ( !multiLayerDrivers.contains( drvName ) )
4010 if ( drvName == QLatin1String(
"ODS" ) || drvName == QLatin1String(
"XLSX" ) || drvName == QLatin1String(
"XLS" ) )
4014 if ( drvName == QLatin1String(
"ESRI Shapefile" ) )
4016 writableDrivers << QStringLiteral(
"DBF file" );
4018 if ( OGR_Dr_TestCapability( drv,
"CreateDataSource" ) != 0 )
4021 if ( drvName == QLatin1String(
"MapInfo File" ) )
4023 writableDrivers << QStringLiteral(
"MapInfo MIF" );
4025 else if ( drvName == QLatin1String(
"SQLite" ) )
4032 QString option = QStringLiteral(
"SPATIALITE=YES" );
4033 char *options[2] = { CPLStrdup( option.toLocal8Bit().constData() ),
nullptr };
4034 OGRSFDriverH poDriver;
4036 poDriver = OGRGetDriverByName( drvName.toLocal8Bit().constData() );
4039 gdal::ogr_datasource_unique_ptr ds( OGR_Dr_CreateDataSource( poDriver, QStringLiteral(
"/vsimem/spatialitetest.sqlite" ).toUtf8().constData(), options ) );
4042 writableDrivers << QStringLiteral(
"SpatiaLite" );
4043 OGR_Dr_DeleteDataSource( poDriver, QStringLiteral(
"/vsimem/spatialitetest.sqlite" ).toUtf8().constData() );
4046 CPLFree( options[0] );
4048 writableDrivers << drvName;
4053 results.reserve( writableDrivers.count() );
4054 for (
const QString &drvName : std::as_const( writableDrivers ) )
4068 if ( options & SortRecommended )
4070 if ( a.driverName == QLatin1String(
"GPKG" ) )
4072 else if ( b.driverName == QLatin1String(
"GPKG" ) )
4074 else if ( a.driverName == QLatin1String(
"ESRI Shapefile" ) )
4076 else if ( b.driverName == QLatin1String(
"ESRI Shapefile" ) )
4080 return a.
longName.toLower().localeAwareCompare( b.
longName.toLower() ) < 0;
4087 QString ext = extension.trimmed();
4088 if ( ext.isEmpty() )
4091 if ( ext.startsWith(
'.' ) )
4095 int const drvCount = GDALGetDriverCount();
4097 for (
int i = 0; i < drvCount; ++i )
4099 GDALDriverH drv = GDALGetDriver( i );
4105 QString drvName = GDALGetDriverShortName( drv );
4106 QStringList driverExtensions = QString( GDALGetMetadataItem( drv, GDAL_DMD_EXTENSIONS,
nullptr ) ).split(
' ' );
4108 const auto constDriverExtensions = driverExtensions;
4109 for (
const QString &
driver : constDriverExtensions )
4111 if (
driver.compare( ext, Qt::CaseInsensitive ) == 0 )
4122 QString filterString;
4126 if ( !filterString.isEmpty() )
4127 filterString += QLatin1String(
";;" );
4129 filterString += details.filterString;
4131 return filterString;
4140 return QStringLiteral(
"%1 (%2 %3)" ).arg( metadata.
trLongName,
4141 metadata.
glob.toLower(),
4142 metadata.
glob.toUpper() );
4147 if ( codecName == QLatin1String(
"System" ) )
4148 return QStringLiteral(
"LDID/0" );
4150 const thread_local QRegularExpression re( QRegularExpression::anchoredPattern( QString(
"(CP|windows-|ISO[ -])(.+)" ) ), QRegularExpression::CaseInsensitiveOption );
4151 const QRegularExpressionMatch match = re.match( codecName );
4152 if ( match.hasMatch() )
4154 QString
c = match.captured( 2 ).remove(
'-' );
4156 ( void )
c.toInt( &isNumber );
4184 OGRStyleTableH ogrStyleTable = OGR_STBL_Create();
4185 OGRStyleMgrH styleManager = OGR_SM_Create( ogrStyleTable );
4188 int nTotalLevels = 0;
4190 QgsSymbolList::iterator symbolIt = symbolList.begin();
4191 for ( ; symbolIt != symbolList.end(); ++symbolIt )
4193 double mmsf = mmScaleFactor(
mSymbologyScale, ( *symbolIt )->outputUnit(), mapUnits );
4194 double musf = mapUnitScaleFactor(
mSymbologyScale, ( *symbolIt )->outputUnit(), mapUnits );
4196 int nLevels = ( *symbolIt )->symbolLayerCount();
4197 for (
int i = 0; i < nLevels; ++i )
4199 mSymbolLayerTable.insert( ( *symbolIt )->symbolLayer( i ), QString::number( nTotalLevels ) );
4200 OGR_SM_AddStyle( styleManager, QString::number( nTotalLevels ).toLocal8Bit(),
4201 ( *symbolIt )->symbolLayer( i )->ogrFeatureStyle( mmsf, musf ).toLocal8Bit() );
4205 OGR_DS_SetStyleTableDirectly( ds, ogrStyleTable );
4211 if ( !details.renderer )
4216 QHash< QgsSymbol *, QList<QgsFeature> > features;
4225 startRender( details.renderer.get(), details.sourceFields );
4245 QString msg = QObject::tr(
"Failed to transform, writing stopped. (Exception: %1)" )
4256 featureSymbol = mRenderer->symbolForFeature( fet, mRenderContext );
4257 if ( !featureSymbol )
4262 QHash< QgsSymbol *, QList<QgsFeature> >::iterator it = features.find( featureSymbol );
4263 if ( it == features.end() )
4265 it = features.insert( featureSymbol, QList<QgsFeature>() );
4267 it.value().append( fet );
4272 QgsSymbolList symbols = mRenderer->symbols( mRenderContext );
4273 for (
int i = 0; i < symbols.count(); i++ )
4279 if ( level < 0 || level >= 1000 )
4282 while ( level >= levels.count() )
4284 levels[level].append( item );
4289 int nTotalFeatures = 0;
4292 for (
int l = 0; l < levels.count(); l++ )
4295 for (
int i = 0; i < level.count(); i++ )
4298 QHash< QgsSymbol *, QList<QgsFeature> >::iterator levelIt = features.find( item.
symbol() );
4299 if ( levelIt == features.end() )
4305 double mmsf = mmScaleFactor(
mSymbologyScale, levelIt.key()->outputUnit(), mapUnits );
4306 double musf = mapUnitScaleFactor(
mSymbologyScale, levelIt.key()->outputUnit(), mapUnits );
4308 int llayer = item.
layer();
4309 QList<QgsFeature> &featureList = levelIt.value();
4310 QList<QgsFeature>::iterator featureIt = featureList.begin();
4311 for ( ; featureIt != featureList.end(); ++featureIt )
4321 QString styleString = levelIt.key()->symbolLayer( llayer )->ogrFeatureStyle( mmsf, musf );
4322 if ( !styleString.isEmpty() )
4324 OGR_F_SetStyleString( ogrFeature.get(), styleString.toLocal8Bit().constData() );
4325 if ( !writeFeature(
mLayer, ogrFeature.get() ) )
4338 *
errorMessage += QObject::tr(
"\nOnly %1 of %2 features written." ).arg( nTotalFeatures - nErrors ).arg( nTotalFeatures );
4355 return 1000 / scale;
4372 return scale / 1000;
4380 mRenderer = createSymbologyRenderer( sourceRenderer );
4386 mRenderer->startRender( mRenderContext, fields );
4389void QgsVectorFileWriter::stopRender()
4396 mRenderer->stopRender( mRenderContext );
4399std::unique_ptr<QgsFeatureRenderer> QgsVectorFileWriter::createSymbologyRenderer(
QgsFeatureRenderer *sourceRenderer )
const
4412 if ( !sourceRenderer )
4417 return std::unique_ptr< QgsFeatureRenderer >( sourceRenderer->
clone() );
4424 const QSet<QString> rendererAttributes = renderer->
usedAttributes( context );
4425 for (
const QString &attr : rendererAttributes )
4430 attList.append( index );
4436QStringList QgsVectorFileWriter::concatenateOptions(
const QMap<QString, QgsVectorFileWriter::Option *> &options )
4439 QMap<QString, QgsVectorFileWriter::Option *>::ConstIterator it;
4441 for ( it = options.constBegin(); it != options.constEnd(); ++it )
4444 switch ( option->
type )
4451 list.append( QStringLiteral(
"%1=%2" ).arg( it.key() ).arg( opt->
defaultValue ) );
4461 list.append( QStringLiteral(
"%1=%2" ).arg( it.key(), opt->
defaultValue ) );
4471 list.append( QStringLiteral(
"%1=%2" ).arg( it.key(), opt->
defaultValue ) );
4478 if ( opt && !opt->
mValue.isEmpty() )
4480 list.append( QStringLiteral(
"%1=%2" ).arg( it.key(), opt->
mValue ) );
4491 OGRSFDriverH hDriver =
nullptr;
4495 QString drvName = OGR_Dr_GetName( hDriver );
4497 if ( OGR_DS_TestCapability( hDS.get(), ODsCCreateLayer ) )
4502 if ( !( drvName == QLatin1String(
"ESRI Shapefile" ) && QFile::exists( datasetName ) ) )
4505 if ( OGR_DS_TestCapability( hDS.get(), ODsCDeleteLayer ) )
4509 int layer_count = OGR_DS_GetLayerCount( hDS.get() );
4512 OGRLayerH hLayer = OGR_DS_GetLayer( hDS.get(), 0 );
4515 if ( OGR_L_TestCapability( hLayer, OLCSequentialWrite ) )
4518 if ( OGR_L_TestCapability( hLayer, OLCCreateField ) )
4529 const QString &layerNameIn )
4531 OGRSFDriverH hDriver =
nullptr;
4536 QString layerName( layerNameIn );
4537 if ( layerName.isEmpty() )
4538 layerName = QFileInfo( datasetName ).baseName();
4540 return OGR_DS_GetLayerByName( hDS.get(), layerName.toUtf8().constData() );
4545 const QString &layerName,
4549 OGRSFDriverH hDriver =
nullptr;
4553 OGRLayerH hLayer = OGR_DS_GetLayerByName( hDS.get(), layerName.toUtf8().constData() );
4559 OGRFeatureDefnH defn = OGR_L_GetLayerDefn( hLayer );
4560 const auto constAttributes = attributes;
4561 for (
int idx : constAttributes )
4564 if ( OGR_FD_GetFieldIndex( defn, fld.
name().toUtf8().constData() ) < 0 )
@ FieldComments
Writer can support field comments.
@ FieldAliases
Writer can support field aliases.
DistanceUnit
Units of distance.
QFlags< VectorFileWriterCapability > VectorFileWriterCapabilities
Capabilities supported by a QgsVectorFileWriter object.
RenderUnit
Rendering size units.
@ Millimeters
Millimeters.
WkbType
The WKB type describes the number of dimensions a geometry has.
@ MultiPolygon25D
MultiPolygon25D.
@ GeometryCollectionZ
GeometryCollectionZ.
@ MultiLineString
MultiLineString.
@ MultiPolygonZ
MultiPolygonZ.
FeatureSymbologyExport
Options for exporting features considering their symbology.
@ PerFeature
Keeps the number of features and export symbology per feature.
@ PerSymbolLayer
Exports one feature per symbol layer (considering symbol levels)
@ NoSymbology
Export only data.
@ Reverse
Reverse/inverse transform (from destination to source)
The QgsAbstractDatabaseProviderConnection class provides common functionality for DB based connection...
virtual QgsFieldDomain * fieldDomain(const QString &name) const
Returns the field domain with the specified name from the provider.
virtual bool addZValue(double zValue=0)=0
Adds a z-dimension to the geometry, initialized to a preset value.
virtual bool dropMValue()=0
Drops any measure values which exist in the geometry.
QFlags< WkbFlag > WkbFlags
virtual bool addMValue(double mValue=0)=0
Adds a measure to the geometry, initialized to a preset value.
virtual bool dropZValue()=0
Drops any z-dimensions which exist in the geometry.
@ FlagExportTrianglesAsPolygons
Triangles should be exported as polygon geometries.
@ FlagExportNanAsDoubleMin
Use -DOUBLE_MAX to represent NaN.
static void registerOgrDrivers()
Register OGR drivers ensuring this only happens once.
This class represents a coordinate reference system (CRS).
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
static Q_INVOKABLE QgsCoordinateReferenceSystem fromEpsgId(long epsg)
Creates a CRS from a given EPSG ID.
Qgis::DistanceUnit mapUnits
Contains information about the context in which a coordinate transform is executed.
Custom exception class for Coordinate Reference System related exceptions.
virtual QString dataSourceUri(bool expandAuthConfig=false) const
Gets the data source specification.
Class for storing the component parts of a RDBMS data source URI (e.g.
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and 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.
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.
Abstract base class for all 2D vector feature renderers.
virtual QgsSymbolList symbolsForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Returns list of symbols used for rendering the feature.
virtual QgsSymbolList symbols(QgsRenderContext &context) const
Returns list of symbols used by the renderer.
bool usingSymbolLevels() const
virtual QgsFeatureRenderer::Capabilities capabilities()
Returns details about internals of this renderer.
virtual QSet< QString > usedAttributes(const QgsRenderContext &context) const =0
Returns a list of attributes required by this renderer.
@ SymbolLevels
Rendering with symbol levels (i.e. implements symbols(), symbolForFeature())
virtual QgsFeatureRenderer * clone() const =0
Create a deep copy of this renderer.
This class wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFilterFids(const QgsFeatureIds &fids)
Sets the feature IDs that should be fetched.
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
QgsFeatureRequest & setNoAttributes()
Set that no attributes will be fetched.
QgsFeatureRequest & setFilterRect(const QgsRectangle &rectangle)
Sets the rectangle from which features will be taken.
QFlags< SinkFlag > SinkFlags
@ 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...
void initAttributes(int fieldCount)
Initialize this feature with the given number of fields.
bool hasGeometry() const
Returns true if the feature has an associated geometry.
bool isUnsetValue(int fieldIdx) const
Returns true if the attribute at the specified index is an unset value.
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
bool isCanceled() const
Tells whether the operation has been canceled already.
void setProgress(double progress)
Sets the current progress for the feedback object.
QString domainName() const
Returns the associated field domain name, for providers which support field domains.
@ ConstraintNotNull
Field may not be null.
@ ConstraintUnique
Field must have a unique value.
Encapsulate a field in an attribute table or data source.
QString typeName() const
Gets the field type.
bool convertCompatible(QVariant &v, QString *errorMessage=nullptr) const
Converts the provided variant to a compatible format.
void setName(const QString &name)
Set the field name.
QMetaType::Type subType() const
If the field is a collection, gets its element's type.
QgsFieldConstraints constraints
Container of fields for a vector layer.
int size() const
Returns number of items.
void clear()
Removes all fields.
QgsField at(int i) 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.
static QStringList multiLayerFileExtensions()
Returns a list of file extensions which potentially contain multiple layers representing GDAL raster ...
A geometry is the spatial representation of a feature.
static QgsGeometry fromRect(const QgsRectangle &rect)
Creates a new geometry from a QgsRectangle.
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.
QgsAbstractGeometry * get()
Returns a modifiable (non-const) reference to the underlying abstract geometry primitive.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
bool convertToMultiType()
Converts single type geometry into multitype geometry e.g.
QByteArray asWkb(QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const
Export the geometry to WKB.
Qgis::WkbType wkbType() const
Returns type of the geometry as a WKB type (point / linestring / polygon etc.)
static QgsGeometryEngine * createGeometryEngine(const QgsAbstractGeometry *geometry, double precision=0.0, Qgis::GeosCreationFlags flags=Qgis::GeosCreationFlag::SkipEmptyInteriorRings)
Creates and returns a new geometry engine representing the specified geometry using precision on a gr...
static void warning(const QString &msg)
Goes to qWarning.
static QgsAbstractDatabaseProviderConnection * databaseConnection(const QgsMapLayer *layer)
Creates and returns the (possibly nullptr) database connection for a layer.
QString providerType() const
Returns the provider type (provider key) for this layer.
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)
Adds a message to the log instance (and creates it if necessary).
Custom exception class which is raised when an operation is not supported.
static OGRSpatialReferenceH crsToOGRSpatialReference(const QgsCoordinateReferenceSystem &crs)
Returns a OGRSpatialReferenceH corresponding to the specified crs object.
static std::unique_ptr< QgsFieldDomain > convertFieldDomain(OGRFieldDomainH domain)
Converts an OGR field domain definition to a QgsFieldDomain equivalent.
static int OGRTZFlagFromQt(const QDateTime &datetime)
Gets the value of OGRField::Date::TZFlag from the timezone of a QDateTime.
Custom exception class for provider connection related exceptions.
QVariantMap decodeUri(const QString &providerKey, const QString &uri)
Breaks a provider data source URI into its component paths (e.g.
static QgsProviderRegistry * instance(const QString &pluginPath=QString())
Means of accessing canonical single instance.
QString encodeUri(const QString &providerKey, const QVariantMap &parts)
Reassembles a provider data source URI from its component paths (e.g.
bool saveLayerMetadata(const QString &providerKey, const QString &uri, const QgsLayerMetadata &metadata, QString &errorMessage)
Saves metadata to the layer corresponding to the specified uri.
The QgsReadWriteLocker class is a convenience class that simplifies locking and unlocking QReadWriteL...
void changeMode(Mode mode)
Change the mode of the lock to mode.
A rectangle specified with double values.
bool isNull() const
Test if the rectangle is null (holding no spatial information).
Contains information about the context of a rendering operation.
QgsExpressionContext & expressionContext()
Gets the expression context.
void setRendererScale(double scale)
Sets the renderer map scale.
This class is a composition of two QSettings instances:
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
int renderingPass() const
Specifies the rendering pass in which this symbol layer should be rendered.
int layer() const
The layer of this symbol level.
QgsSymbol * symbol() const
The symbol of this symbol level.
Abstract base class for all rendered symbols.
QgsSymbolLayer * symbolLayer(int layer)
Returns the symbol layer at the specified index.
int symbolLayerCount() const
Returns the total number of symbol layers contained in the symbol.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
Interface to convert raw field values to their user-friendly value.
virtual QVariant convert(int fieldIdxInLayer, const QVariant &value)
Convert the provided value, for field fieldIdxInLayer.
virtual QgsVectorFileWriter::FieldValueConverter * clone() const
Creates a clone of the FieldValueConverter.
virtual QgsField fieldDefinition(const QgsField &field)
Returns a possibly modified field definition.
QgsVectorFileWriter::OptionType type
Options to pass to writeAsVectorFormat()
QString fileEncoding
Encoding to use.
bool forceMulti
Sets to true to force creation of multi* geometries.
FieldNameSource fieldNameSource
Source for exported field names.
QString driverName
OGR driver to use.
QgsCoordinateTransform ct
Transform to reproject exported geometries with, or invalid transform for no transformation.
QStringList attributesExportNames
Attributes export names.
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 includeConstraints
Set to true to transfer field constraints to the exported vector file.
const QgsAbstractDatabaseProviderConnection * sourceDatabaseProviderConnection
Source database provider connection, for field domains.
QgsVectorFileWriter::FieldValueConverter * fieldValueConverter
Field value converter.
QStringList layerOptions
List of OGR layer creation options.
Qgis::WkbType overrideGeometryType
Set to a valid geometry type to override the default geometry type for the layer.
bool includeZ
Sets to true to include z dimension in output. This option is only valid if overrideGeometryType is s...
Qgis::FeatureSymbologyExport symbologyExport
Symbology to export.
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.
bool setFieldDomains
Set to true to transfer field domains to the exported vector file.
double symbologyScale
Scale of symbology.
QStringList datasourceOptions
List of OGR data source creation options.
QgsFeedback * feedback
Optional feedback object allowing cancellation of layer save.
A convenience class for writing vector layers to disk based formats (e.g.
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.
Qgis::FeatureSymbologyExport mSymbologyExport
QString lastError() const override
Returns the most recent error encountered by the sink, e.g.
@ CanAddNewFieldsToExistingLayer
Flag to indicate that new fields can be added to an existing layer. Imply CanAppendToExistingLayer.
@ CanAppendToExistingLayer
Flag to indicate that new features can be added to an existing layer.
@ CanAddNewLayer
Flag to indicate that a new layer can be added to the dataset.
@ CanDeleteLayer
Flag to indicate that an existing layer can be deleted.
static QgsVectorFileWriter::EditionCapabilities editionCapabilities(const QString &datasetName)
Returns edition capabilities for an existing dataset name.
bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a single feature to the sink.
static bool supportsFeatureStyles(const QString &driverName)
Returns true if the specified driverName supports feature styles.
Qgis::WkbType mWkbType
Geometry type which is being used.
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a list of features to the sink.
double mSymbologyScale
Scale for symbology export (e.g. for symbols units in map units)
QMap< int, int > mAttrIdxToOgrIdx
Map attribute indizes to OGR field indexes.
@ ErrAttributeTypeUnsupported
@ Canceled
Writing was interrupted by manual cancellation.
@ ErrAttributeCreationFailed
@ ErrSavingMetadata
Metadata saving failed.
gdal::ogr_datasource_unique_ptr mDS
static Q_DECL_DEPRECATED QgsVectorFileWriter::WriterError writeAsVectorFormatV2(QgsVectorLayer *layer, const QString &fileName, const QgsCoordinateTransformContext &transformContext, const QgsVectorFileWriter::SaveVectorOptions &options, QString *newFilename=nullptr, QString *newLayer=nullptr, QString *errorMessage=nullptr)
Writes a layer out to a vector file.
OGRGeometryH createEmptyGeometry(Qgis::WkbType wkbType)
QString mOgrDriverLongName
QFlags< EditionCapability > EditionCapabilities
Combination of CanAddNewLayer, CanAppendToExistingLayer, CanAddNewFieldsToExistingLayer or CanDeleteL...
~QgsVectorFileWriter() override
Close opened shapefile for writing.
static bool targetLayerExists(const QString &datasetName, const QString &layerName)
Returns whether the target layer already exists.
double symbologyScale() const
Returns the reference scale for output.
static QStringList defaultLayerOptions(const QString &driverName)
Returns a list of the default layer options for a specified driver.
static QString driverForExtension(const QString &extension)
Returns the OGR driver name for a specified file extension.
Qgis::VectorFileWriterCapabilities capabilities() const
Returns the capabilities supported by the writer.
static QList< QgsVectorFileWriter::FilterFormatDetails > supportedFiltersAndFormats(VectorFormatOptions options=SortRecommended)
Returns a list or pairs, with format filter string as first element and OGR format key as second elem...
OGRSpatialReferenceH mOgrRef
static bool driverMetadata(const QString &driverName, MetaData &driverMetadata)
static QgsVectorFileWriter * create(const QString &fileName, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &srs, const QgsCoordinateTransformContext &transformContext, const QgsVectorFileWriter::SaveVectorOptions &options, QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags(), QString *newFilename=nullptr, QString *newLayer=nullptr)
Create a new vector file writer.
QString driver() const
Returns the GDAL (short) driver name associated with the output file.
static bool deleteShapeFile(const QString &fileName)
Delete a shapefile (and its accompanying shx / dbf / prj / qix / qpj / cpg / sbn / sbx / idm / ind)
Q_DECL_DEPRECATED QgsVectorFileWriter(const QString &vectorFileName, const QString &fileEncoding, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &srs=QgsCoordinateReferenceSystem(), const QString &driverName="GPKG", const QStringList &datasourceOptions=QStringList(), const QStringList &layerOptions=QStringList(), QString *newFilename=nullptr, Qgis::FeatureSymbologyExport symbologyExport=Qgis::FeatureSymbologyExport::NoSymbology, QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags(), QString *newLayer=nullptr, const QgsCoordinateTransformContext &transformContext=QgsCoordinateTransformContext(), FieldNameSource fieldNameSource=Original)
Create a new vector file writer.
static Q_DECL_DEPRECATED QgsVectorFileWriter::WriterError writeAsVectorFormat(QgsVectorLayer *layer, const QString &fileName, const QString &fileEncoding, const QgsCoordinateReferenceSystem &destCRS=QgsCoordinateReferenceSystem(), const QString &driverName="GPKG", bool onlySelected=false, QString *errorMessage=nullptr, const QStringList &datasourceOptions=QStringList(), const QStringList &layerOptions=QStringList(), bool skipAttributeCreation=false, QString *newFilename=nullptr, Qgis::FeatureSymbologyExport symbologyExport=Qgis::FeatureSymbologyExport::NoSymbology, double symbologyScale=1.0, const QgsRectangle *filterExtent=nullptr, Qgis::WkbType overrideGeometryType=Qgis::WkbType::Unknown, bool forceMulti=false, bool includeZ=false, const QgsAttributeList &attributes=QgsAttributeList(), QgsVectorFileWriter::FieldValueConverter *fieldValueConverter=nullptr, QString *newLayer=nullptr)
Write contents of vector layer to an (OGR supported) vector format.
static QString filterForDriver(const QString &driverName)
Creates a filter for an OGR driver key.
QgsVectorFileWriter::WriterError hasError() const
Checks whether there were any errors in constructor.
@ SupportsMultipleLayers
Filter to only formats which support multiple layers.
@ SkipNonSpatialFormats
Filter out any formats which do not have spatial support (e.g. those which cannot save geometries)
static bool areThereNewFieldsToCreate(const QString &datasetName, const QString &layerName, QgsVectorLayer *layer, const QgsAttributeList &attributes)
Returns whether there are among the attributes specified some that do not exist yet in the layer.
static QList< QgsVectorFileWriter::DriverDetails > ogrDriverList(VectorFormatOptions options=SortRecommended)
Returns the driver list that can be used for dialogs.
QString driverLongName() const
Returns the GDAL long driver name associated with the output file.
QFlags< VectorFormatOption > VectorFormatOptions
WriterError mError
Contains error value if construction was not successful.
Qgis::FeatureSymbologyExport symbologyExport() const
Returns the feature symbology export handling for the writer.
FieldNameSource
Source for exported field names.
@ PreferAlias
Use the field alias as the exported field name, wherever one is set. Otherwise use the original field...
@ Original
Use original field names.
bool mIncludeConstraints
Whether to transfer field constraints to output.
static QStringList defaultDatasetOptions(const QString &driverName)
Returns a list of the default dataset options for a specified driver.
bool addFeatureWithStyle(QgsFeature &feature, QgsFeatureRenderer *renderer, Qgis::DistanceUnit outputUnit=Qgis::DistanceUnit::Meters)
Adds a feature to the currently opened data source, using the style from a specified renderer.
static QStringList supportedFormatExtensions(VectorFormatOptions options=SortRecommended)
Returns a list of file extensions for supported formats, e.g "shp", "gpkg".
bool mSetFieldDomains
Whether to set field domains to output.
static QString convertCodecNameForEncodingOption(const QString &codecName)
Converts codec name to string passed to ENCODING layer creation option of OGR Shapefile.
FieldValueConverter * mFieldValueConverter
Field value converter.
QString errorMessage() const
Retrieves error message.
void setSymbologyScale(double scale)
Set reference scale for output.
static OGRwkbGeometryType ogrTypeFromWkbType(Qgis::WkbType type)
Gets the ogr geometry type from an internal QGIS wkb type enum.
QMap< QgsSymbolLayer *, QString > mSymbolLayerTable
static QString fileFilterString(VectorFormatOptions options=SortRecommended)
Returns filter string that can be used for dialogs.
ActionOnExistingFile
Enumeration to describe how to handle existing files.
@ CreateOrOverwriteLayer
Create or overwrite layer.
@ CreateOrOverwriteFile
Create or overwrite file.
@ AppendToLayerNoNewFields
Append features to existing layer, but do not create new fields.
@ AppendToLayerAddFields
Append features to existing layer, and create new fields if needed.
Represents a vector layer which manages a vector based data sets.
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.
QString storageType() const
Returns the permanent storage type for this layer as a friendly name.
Q_INVOKABLE Qgis::WkbType wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
QgsFeatureRenderer * renderer()
Returns the feature renderer used for rendering the features in the layer in 2D map views.
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
void minimumAndMaximumValue(int index, QVariant &minimum, QVariant &maximum) const
Calculates both the minimum and maximum value for an attribute column.
static Qgis::WkbType to25D(Qgis::WkbType type)
Will convert the 25D version of the flat type if supported or Unknown if not supported.
static bool isMultiType(Qgis::WkbType type)
Returns true if the WKB type is a multi type.
static Qgis::WkbType addZ(Qgis::WkbType type)
Adds the z dimension to a WKB type and returns the new type.
static Qgis::WkbType singleType(Qgis::WkbType type)
Returns the single type for a WKB type.
static bool hasZ(Qgis::WkbType type)
Tests whether a WKB type contains the z-dimension.
static bool hasM(Qgis::WkbType type)
Tests whether a WKB type contains m values.
static Qgis::WkbType multiType(Qgis::WkbType type)
Returns the multi type for a WKB type.
static Qgis::WkbType flatType(Qgis::WkbType type)
Returns the flat type for a WKB type.
std::unique_ptr< std::remove_pointer< OGRFeatureH >::type, OGRFeatureDeleter > ogr_feature_unique_ptr
Scoped OGR feature.
std::unique_ptr< std::remove_pointer< OGRDataSourceH >::type, OGRDataSourceDeleter > ogr_datasource_unique_ptr
Scoped OGR data source.
std::unique_ptr< std::remove_pointer< OGRFieldDefnH >::type, OGRFldDeleter > ogr_field_def_unique_ptr
Scoped OGR field definition.
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
#define Q_NOWARN_DEPRECATED_POP
#define Q_NOWARN_DEPRECATED_PUSH
QList< QgsFeature > QgsFeatureList
QList< int > QgsAttributeList
#define QgsDebugMsgLevel(str, level)
#define QgsDebugError(str)
QList< QgsSymbolLevel > QgsSymbolLevelOrder
QList< QgsSymbolLevelItem > QgsSymbolLevel
QList< QgsSymbol * > QgsSymbolList
QStringList multiLayerFormats()
Details of available driver formats.
QString longName
Descriptive, user friendly name for the driver.
QString driverName
Unique driver name.