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 ) )
931 std::unique_ptr<QgsFieldDomain> domain( sourceDatabaseProviderConnection->
fieldDomain( domainName ) );
937 char *pszFailureReason =
nullptr;
938 if ( GDALDatasetAddFieldDomain(
mDS.get(), hFieldDomain, &pszFailureReason ) )
940 existingDestDomainNames.insert( domainName );
941 canSetFieldDomainName =
true;
945 QgsDebugMsgLevel( QStringLiteral(
"cannot create field domain: %1" ).arg( pszFailureReason ), 2 );
947 CPLFree( pszFailureReason );
948 OGR_FldDomain_Destroy( hFieldDomain );
952 if ( canSetFieldDomainName )
954 OGR_Fld_SetDomainName( fld.get(), domainName.toUtf8().toStdString().c_str() );
962 " type " + QString( QVariant::typeToName( attrField.
type() ) ) +
963 " width " + QString::number( ogrWidth ) +
964 " precision " + QString::number( ogrPrecision ), 2 );
965 if ( OGR_L_CreateField(
mLayer, fld.get(),
true ) != OGRERR_NONE )
968 mErrorMessage = QObject::tr(
"Creation of field %1 failed (OGR error: %2)" )
969 .arg( attrField.
name(),
970 QString::fromUtf8( CPLGetLastErrorMsg() ) );
975 int ogrIdx = OGR_FD_GetFieldIndex( defn,
mCodec->fromUnicode( name ) );
976 QgsDebugMsgLevel( QStringLiteral(
"returned field index for %1: %2" ).arg( name ).arg( ogrIdx ), 2 );
977 if ( ogrIdx < 0 || existingIdxs.contains( ogrIdx ) )
980 ogrIdx = OGR_FD_GetFieldCount( defn ) - 1;
985 mErrorMessage = QObject::tr(
"Created field %1 not found (OGR error: %2)" )
986 .arg( attrField.
name(),
987 QString::fromUtf8( CPLGetLastErrorMsg() ) );
993 existingIdxs.insert( ogrIdx );
1001 for (
int fldIdx = 0; fldIdx < fields.
count(); ++fldIdx )
1004 QString name( attrField.
name() );
1005 int ogrIdx = OGR_FD_GetFieldIndex( defn,
mCodec->fromUnicode( name ) );
1017 int fidIdx = fields.
lookupField( QStringLiteral(
"FID" ) );
1028 *newFilename = vectorFileName;
1031 mUsingTransaction =
true;
1032 if ( OGRERR_NONE != OGR_L_StartTransaction(
mLayer ) )
1034 mUsingTransaction =
false;
1044class QgsVectorFileWriterMetadataContainer
1048 QgsVectorFileWriterMetadataContainer()
1050 QMap<QString, QgsVectorFileWriter::Option *> datasetOptions;
1051 QMap<QString, QgsVectorFileWriter::Option *> layerOptions;
1054 datasetOptions.clear();
1055 layerOptions.clear();
1058 QObject::tr(
"Compression method." ),
1060 << QStringLiteral(
"UNCOMPRESSED" )
1061 << QStringLiteral(
"ZSTD" )
1062 << QStringLiteral(
"LZ4" ),
1063 QStringLiteral(
"LZ4" ),
1068 QObject::tr(
"Geometry encoding." ),
1070 << QStringLiteral(
"GEOARROW" )
1071 << QStringLiteral(
"WKB" )
1072 << QStringLiteral(
"WKT" ),
1073 QStringLiteral(
"GEOARROW" ),
1078 QObject::tr(
"Maximum number of rows per batch." ),
1083 QObject::tr(
"Name for the feature identifier column" ),
1088 QObject::tr(
"Name for the geometry column" ),
1089 QStringLiteral(
"geometry" )
1092 driverMetadata.insert( QStringLiteral(
"Arrow" ),
1094 QStringLiteral(
"(Geo)Arrow" ),
1095 QObject::tr(
"(Geo)Arrow" ),
1096 QStringLiteral(
"*.arrow *.feather *.arrows *.ipc" ),
1097 QStringLiteral(
"arrow" ),
1100 QStringLiteral(
"UTF-8" )
1105 datasetOptions.clear();
1106 layerOptions.clear();
1108 driverMetadata.insert( QStringLiteral(
"AVCE00" ),
1110 QStringLiteral(
"Arc/Info ASCII Coverage" ),
1111 QObject::tr(
"Arc/Info ASCII Coverage" ),
1112 QStringLiteral(
"*.e00" ),
1113 QStringLiteral(
"e00" ),
1120 datasetOptions.clear();
1121 layerOptions.clear();
1124 QObject::tr(
"By default when creating new .csv files they "
1125 "are created with the line termination conventions "
1126 "of the local platform (CR/LF on Win32 or LF on all other systems). "
1127 "This may be overridden through the use of the LINEFORMAT option." ),
1129 << QStringLiteral(
"CRLF" )
1130 << QStringLiteral(
"LF" ),
1136 QObject::tr(
"By default, the geometry of a feature written to a .csv file is discarded. "
1137 "It is possible to export the geometry in its WKT representation by "
1138 "specifying GEOMETRY=AS_WKT. It is also possible to export point geometries "
1139 "into their X,Y,Z components by specifying GEOMETRY=AS_XYZ, GEOMETRY=AS_XY "
1140 "or GEOMETRY=AS_YX." ),
1142 << QStringLiteral(
"AS_WKT" )
1143 << QStringLiteral(
"AS_XYZ" )
1144 << QStringLiteral(
"AS_XY" )
1145 << QStringLiteral(
"AS_YX" ),
1151 QObject::tr(
"Create the associated .csvt file to describe the type of each "
1152 "column of the layer and its optional width and precision." ),
1157 QObject::tr(
"Field separator character." ),
1159 << QStringLiteral(
"COMMA" )
1160 << QStringLiteral(
"SEMICOLON" )
1161 << QStringLiteral(
"TAB" ),
1162 QStringLiteral(
"COMMA" )
1166 QObject::tr(
"Double-quote strings. IF_AMBIGUOUS means that string values that look like numbers will be quoted." ),
1168 << QStringLiteral(
"IF_NEEDED" )
1169 << QStringLiteral(
"IF_AMBIGUOUS" )
1170 << QStringLiteral(
"ALWAYS" ),
1171 QStringLiteral(
"IF_AMBIGUOUS" )
1175 QObject::tr(
"Write a UTF-8 Byte Order Mark (BOM) at the start of the file." ),
1179 driverMetadata.insert( QStringLiteral(
"CSV" ),
1181 QStringLiteral(
"Comma Separated Value [CSV]" ),
1182 QObject::tr(
"Comma Separated Value [CSV]" ),
1183 QStringLiteral(
"*.csv" ),
1184 QStringLiteral(
"csv" ),
1191 datasetOptions.clear();
1192 layerOptions.clear();
1194 driverMetadata.insert( QStringLiteral(
"FlatGeobuf" ),
1196 QStringLiteral(
"FlatGeobuf" ),
1197 QObject::tr(
"FlatGeobuf" ),
1198 QStringLiteral(
"*.fgb" ),
1199 QStringLiteral(
"fgb" ),
1202 QStringLiteral(
"UTF-8" )
1207 datasetOptions.clear();
1208 layerOptions.clear();
1211 QObject::tr(
"Override the type of shapefile created. "
1212 "Can be one of NULL for a simple .dbf file with no .shp file, POINT, "
1213 "ARC, POLYGON or MULTIPOINT for 2D, or POINTZ, ARCZ, POLYGONZ or "
1214 "MULTIPOINTZ for 3D;" ) +
1215 QObject::tr(
" POINTM, ARCM, POLYGONM or MULTIPOINTM for measured geometries"
1216 " and POINTZM, ARCZM, POLYGONZM or MULTIPOINTZM for 3D measured"
1218 QObject::tr(
" MULTIPATCH files are supported since GDAL 2.2." ) +
1221 << QStringLiteral(
"NULL" )
1222 << QStringLiteral(
"POINT" )
1223 << QStringLiteral(
"ARC" )
1224 << QStringLiteral(
"POLYGON" )
1225 << QStringLiteral(
"MULTIPOINT" )
1226 << QStringLiteral(
"POINTZ" )
1227 << QStringLiteral(
"ARCZ" )
1228 << QStringLiteral(
"POLYGONZ" )
1229 << QStringLiteral(
"MULTIPOINTZ" )
1230 << QStringLiteral(
"POINTM" )
1231 << QStringLiteral(
"ARCM" )
1232 << QStringLiteral(
"POLYGONM" )
1233 << QStringLiteral(
"MULTIPOINTM" )
1234 << QStringLiteral(
"POINTZM" )
1235 << QStringLiteral(
"ARCZM" )
1236 << QStringLiteral(
"POLYGONZM" )
1237 << QStringLiteral(
"MULTIPOINTZM" )
1238 << QStringLiteral(
"MULTIPATCH" )
1248 QObject::tr(
"Set the encoding value in the DBF file. "
1249 "The default value is LDID/87. It is not clear "
1250 "what other values may be appropriate." ),
1258 QObject::tr(
"Set to YES to resize fields to their optimal size." ),
1262 driverMetadata.insert( QStringLiteral(
"ESRI" ),
1264 QStringLiteral(
"ESRI Shapefile" ),
1265 QObject::tr(
"ESRI Shapefile" ),
1266 QStringLiteral(
"*.shp" ),
1267 QStringLiteral(
"shp" ),
1274 datasetOptions.clear();
1275 layerOptions.clear();
1277 driverMetadata.insert( QStringLiteral(
"DBF File" ),
1279 QStringLiteral(
"DBF File" ),
1280 QObject::tr(
"DBF File" ),
1281 QStringLiteral(
"*.dbf" ),
1282 QStringLiteral(
"dbf" ),
1289 datasetOptions.clear();
1290 layerOptions.clear();
1293 QObject::tr(
"Set to YES to write a bbox property with the bounding box "
1294 "of the geometries at the feature and feature collection level." ),
1299 QObject::tr(
"Maximum number of figures after decimal separator to write in coordinates. "
1300 "Defaults to 15. Truncation will occur to remove trailing zeros." ),
1305 QObject::tr(
"Whether to use RFC 7946 standard. "
1306 "If disabled GeoJSON 2008 initial version will be used. "
1307 "Default is NO (thus GeoJSON 2008). See also Documentation (via Help button)" ),
1311 driverMetadata.insert( QStringLiteral(
"GeoJSON" ),
1313 QStringLiteral(
"GeoJSON" ),
1314 QObject::tr(
"GeoJSON" ),
1315 QStringLiteral(
"*.geojson" ),
1316 QStringLiteral(
"geojson" ),
1319 QStringLiteral(
"UTF-8" )
1324 datasetOptions.clear();
1325 layerOptions.clear();
1328 QObject::tr(
"Maximum number of figures after decimal separator to write in coordinates. "
1329 "Defaults to 15. Truncation will occur to remove trailing zeros." ),
1334 QObject::tr(
"Whether to start records with the RS=0x1E character (RFC 8142 standard). "
1335 "Defaults to NO: Newline Delimited JSON (geojsonl). \n"
1336 "If set to YES: RFC 8142 standard: GeoJSON Text Sequences (geojsons)." ),
1340 driverMetadata.insert( QStringLiteral(
"GeoJSONSeq" ),
1342 QStringLiteral(
"GeoJSON - Newline Delimited" ),
1343 QObject::tr(
"GeoJSON - Newline Delimited" ),
1344 QStringLiteral(
"*.geojsonl *.geojsons *.json" ),
1345 QStringLiteral(
"geojsonl geojsons json" ),
1348 QStringLiteral(
"UTF-8" )
1353 datasetOptions.clear();
1354 layerOptions.clear();
1357 QObject::tr(
"whether the document must be in RSS 2.0 or Atom 1.0 format. "
1358 "Default value : RSS" ),
1360 << QStringLiteral(
"RSS" )
1361 << QStringLiteral(
"ATOM" ),
1362 QStringLiteral(
"RSS" )
1366 QObject::tr(
"The encoding of location information. Default value : SIMPLE. "
1367 "W3C_GEO only supports point geometries. "
1368 "SIMPLE or W3C_GEO only support geometries in geographic WGS84 coordinates." ),
1370 << QStringLiteral(
"SIMPLE" )
1371 << QStringLiteral(
"GML" )
1372 << QStringLiteral(
"W3C_GEO" ),
1373 QStringLiteral(
"SIMPLE" )
1377 QObject::tr(
"If defined to YES, extension fields will be written. "
1378 "If the field name not found in the base schema matches "
1379 "the foo_bar pattern, foo will be considered as the namespace "
1380 "of the element, and a <foo:bar> element will be written. "
1381 "Otherwise, elements will be written in the <ogr:> namespace." ),
1386 QObject::tr(
"If defined to NO, only <entry> or <item> elements will be written. "
1387 "The user will have to provide the appropriate header and footer of the document." ),
1392 QObject::tr(
"XML content that will be put between the <channel> element and the "
1393 "first <item> element for a RSS document, or between the xml tag and "
1394 "the first <entry> element for an Atom document." ),
1399 QObject::tr(
"Value put inside the <title> element in the header. "
1400 "If not provided, a dummy value will be used as that element is compulsory." ),
1405 QObject::tr(
"Value put inside the <description> element in the header. "
1406 "If not provided, a dummy value will be used as that element is compulsory." ),
1411 QObject::tr(
"Value put inside the <link> element in the header. "
1412 "If not provided, a dummy value will be used as that element is compulsory." ),
1417 QObject::tr(
"Value put inside the <updated> element in the header. "
1418 "Should be formatted as a XML datetime. "
1419 "If not provided, a dummy value will be used as that element is compulsory." ),
1424 QObject::tr(
"Value put inside the <author><name> element in the header. "
1425 "If not provided, a dummy value will be used as that element is compulsory." ),
1430 QObject::tr(
"Value put inside the <id> element in the header. "
1431 "If not provided, a dummy value will be used as that element is compulsory." ),
1435 driverMetadata.insert( QStringLiteral(
"GeoRSS" ),
1437 QStringLiteral(
"GeoRSS" ),
1438 QObject::tr(
"GeoRSS" ),
1439 QStringLiteral(
"*.xml" ),
1440 QStringLiteral(
"xml" ),
1443 QStringLiteral(
"UTF-8" )
1448 datasetOptions.clear();
1449 layerOptions.clear();
1452 QObject::tr(
"If provided, this URI will be inserted as the schema location. "
1453 "Note that the schema file isn't actually accessed by OGR, so it "
1454 "is up to the user to ensure it will match the schema of the OGR "
1455 "produced GML data file." ),
1460 QObject::tr(
"This writes a GML application schema file to a corresponding "
1461 ".xsd file (with the same basename). If INTERNAL is used the "
1462 "schema is written within the GML file, but this is experimental "
1463 "and almost certainly not valid XML. "
1464 "OFF disables schema generation (and is implicit if XSISCHEMAURI is used)." ),
1466 << QStringLiteral(
"EXTERNAL" )
1467 << QStringLiteral(
"INTERNAL" )
1468 << QStringLiteral(
"OFF" ),
1469 QStringLiteral(
"EXTERNAL" )
1473 QObject::tr(
"This is the prefix for the application target namespace." ),
1474 QStringLiteral(
"ogr" )
1478 QObject::tr(
"Can be set to TRUE to avoid writing the prefix of the "
1479 "application target namespace in the GML file." ),
1484 QObject::tr(
"Defaults to 'http://ogr.maptools.org/'. "
1485 "This is the application target namespace." ),
1486 QStringLiteral(
"http://ogr.maptools.org/" )
1490 QObject::tr(
"GML version to use." ),
1492 << QStringLiteral(
"GML2" )
1493 << QStringLiteral(
"GML3" )
1494 << QStringLiteral(
"GML3Deegree" )
1495 << QStringLiteral(
"GML3.2" ),
1496 QStringLiteral(
"GML3.2" )
1500 QObject::tr(
"Only valid when FORMAT=GML3/GML3Degree/GML3.2. Default to YES. "
1501 "If YES, SRS with EPSG authority will be written with the "
1502 "'urn:ogc:def:crs:EPSG::' prefix. In the case the SRS is a "
1503 "geographic SRS without explicit AXIS order, but that the same "
1504 "SRS authority code imported with ImportFromEPSGA() should be "
1505 "treated as lat/long, then the function will take care of coordinate "
1506 "order swapping. If set to NO, SRS with EPSG authority will be "
1507 "written with the 'EPSG:' prefix, even if they are in lat/long order." ),
1512 QObject::tr(
"only valid when FORMAT=GML3/GML3Degree/GML3.2) Default to YES. "
1513 "If set to NO, the <gml:boundedBy> element will not be written for "
1519 QObject::tr(
"Default to YES. If YES, the output will be indented with spaces "
1520 "for more readability, but at the expense of file size." ),
1525 driverMetadata.insert( QStringLiteral(
"GML" ),
1527 QStringLiteral(
"Geography Markup Language [GML]" ),
1528 QObject::tr(
"Geography Markup Language [GML]" ),
1529 QStringLiteral(
"*.gml" ),
1530 QStringLiteral(
"gml" ),
1533 QStringLiteral(
"UTF-8" )
1538 datasetOptions.clear();
1539 layerOptions.clear();
1542 QObject::tr(
"Human-readable identifier (e.g. short name) for the layer content" ),
1547 QObject::tr(
"Human-readable description for the layer content" ),
1552 QObject::tr(
"Name for the feature identifier column" ),
1553 QStringLiteral(
"fid" )
1557 QObject::tr(
"Name for the geometry column" ),
1558 QStringLiteral(
"geom" )
1562 QObject::tr(
"If a spatial index must be created." ),
1566 driverMetadata.insert( QStringLiteral(
"GPKG" ),
1568 QStringLiteral(
"GeoPackage" ),
1569 QObject::tr(
"GeoPackage" ),
1570 QStringLiteral(
"*.gpkg" ),
1571 QStringLiteral(
"gpkg" ),
1574 QStringLiteral(
"UTF-8" )
1579 datasetOptions.clear();
1580 layerOptions.clear();
1582 driverMetadata.insert( QStringLiteral(
"GMT" ),
1584 QStringLiteral(
"Generic Mapping Tools [GMT]" ),
1585 QObject::tr(
"Generic Mapping Tools [GMT]" ),
1586 QStringLiteral(
"*.gmt" ),
1587 QStringLiteral(
"gmt" ),
1594 datasetOptions.clear();
1595 layerOptions.clear();
1598 QObject::tr(
"By default when writing a layer whose features are of "
1599 "type wkbLineString, the GPX driver chooses to write "
1600 "them as routes. If FORCE_GPX_TRACK=YES is specified, "
1601 "they will be written as tracks." ),
1606 QObject::tr(
"By default when writing a layer whose features are of "
1607 "type wkbMultiLineString, the GPX driver chooses to write "
1608 "them as tracks. If FORCE_GPX_ROUTE=YES is specified, "
1609 "they will be written as routes, provided that the multilines "
1610 "are composed of only one single line." ),
1615 QObject::tr(
"If GPX_USE_EXTENSIONS=YES is specified, "
1616 "extra fields will be written inside the <extensions> tag." ),
1621 QObject::tr(
"Only used if GPX_USE_EXTENSIONS=YES and GPX_EXTENSIONS_NS_URL "
1622 "is set. The namespace value used for extension tags. By default, 'ogr'." ),
1623 QStringLiteral(
"ogr" )
1627 QObject::tr(
"Only used if GPX_USE_EXTENSIONS=YES and GPX_EXTENSIONS_NS "
1628 "is set. The namespace URI. By default, 'http://osgeo.org/gdal'." ),
1629 QStringLiteral(
"http://osgeo.org/gdal" )
1633 QObject::tr(
"By default files are created with the line termination "
1634 "conventions of the local platform (CR/LF on win32 or LF "
1635 "on all other systems). This may be overridden through use "
1636 "of the LINEFORMAT layer creation option which may have a value "
1637 "of CRLF (DOS format) or LF (Unix format)." ),
1639 << QStringLiteral(
"CRLF" )
1640 << QStringLiteral(
"LF" ),
1645 driverMetadata.insert( QStringLiteral(
"GPX" ),
1647 QStringLiteral(
"GPS eXchange Format [GPX]" ),
1648 QObject::tr(
"GPS eXchange Format [GPX]" ),
1649 QStringLiteral(
"*.gpx" ),
1650 QStringLiteral(
"gpx" ),
1653 QStringLiteral(
"UTF-8" )
1658 datasetOptions.clear();
1659 layerOptions.clear();
1661 driverMetadata.insert( QStringLiteral(
"Interlis 1" ),
1663 QStringLiteral(
"INTERLIS 1" ),
1664 QObject::tr(
"INTERLIS 1" ),
1665 QStringLiteral(
"*.itf *.xml *.ili" ),
1666 QStringLiteral(
"ili" ),
1673 datasetOptions.clear();
1674 layerOptions.clear();
1676 driverMetadata.insert( QStringLiteral(
"Interlis 2" ),
1678 QStringLiteral(
"INTERLIS 2" ),
1679 QObject::tr(
"INTERLIS 2" ),
1680 QStringLiteral(
"*.xtf *.xml *.ili" ),
1681 QStringLiteral(
"ili" ),
1688 datasetOptions.clear();
1689 layerOptions.clear();
1692 QObject::tr(
"Allows you to specify the field to use for the KML <name> element." ),
1693 QStringLiteral(
"Name" )
1697 QObject::tr(
"Allows you to specify the field to use for the KML <description> element." ),
1698 QStringLiteral(
"Description" )
1702 QObject::tr(
"Allows you to specify the AltitudeMode to use for KML geometries. "
1703 "This will only affect 3D geometries and must be one of the valid KML options." ),
1705 << QStringLiteral(
"clampToGround" )
1706 << QStringLiteral(
"relativeToGround" )
1707 << QStringLiteral(
"absolute" ),
1708 QStringLiteral(
"relativeToGround" )
1712 QObject::tr(
"The DOCUMENT_ID datasource creation option can be used to specified "
1713 "the id of the root <Document> node. The default value is root_doc." ),
1714 QStringLiteral(
"root_doc" )
1717 driverMetadata.insert( QStringLiteral(
"KML" ),
1719 QStringLiteral(
"Keyhole Markup Language [KML]" ),
1720 QObject::tr(
"Keyhole Markup Language [KML]" ),
1721 QStringLiteral(
"*.kml" ),
1722 QStringLiteral(
"kml" ),
1725 QStringLiteral(
"UTF-8" )
1730 datasetOptions.clear();
1731 layerOptions.clear();
1733 auto insertMapInfoOptions = []( QMap<QString, QgsVectorFileWriter::Option *> &datasetOptions, QMap<QString, QgsVectorFileWriter::Option *> &layerOptions )
1736 QObject::tr(
"Use this to turn on 'quick spatial index mode'. "
1737 "In this mode writing files can be about 5 times faster, "
1738 "but spatial queries can be up to 30 times slower." ),
1740 << QStringLiteral(
"QUICK" )
1741 << QStringLiteral(
"OPTIMIZED" ),
1742 QStringLiteral(
"QUICK" ),
1747 QObject::tr(
"(multiples of 512): Block size for .map files. Defaults "
1748 "to 512. MapInfo 15.2 and above creates .tab files with a "
1749 "blocksize of 16384 bytes. Any MapInfo version should be "
1750 "able to handle block sizes from 512 to 32256." ),
1754 QObject::tr(
"xmin,ymin,xmax,ymax: Define custom layer bounds to increase the "
1755 "accuracy of the coordinates. Note: the geometry of written "
1756 "features must be within the defined box." ),
1760 insertMapInfoOptions( datasetOptions, layerOptions );
1762 driverMetadata.insert( QStringLiteral(
"MapInfo File" ),
1764 QStringLiteral(
"Mapinfo" ),
1765 QObject::tr(
"Mapinfo TAB" ),
1766 QStringLiteral(
"*.tab" ),
1767 QStringLiteral(
"tab" ),
1772 datasetOptions.clear();
1773 layerOptions.clear();
1774 insertMapInfoOptions( datasetOptions, layerOptions );
1777 driverMetadata.insert( QStringLiteral(
"MapInfo MIF" ),
1779 QStringLiteral(
"Mapinfo" ),
1780 QObject::tr(
"Mapinfo MIF" ),
1781 QStringLiteral(
"*.mif" ),
1782 QStringLiteral(
"mif" ),
1789 datasetOptions.clear();
1790 layerOptions.clear();
1793 QObject::tr(
"Determine whether 2D (seed_2d.dgn) or 3D (seed_3d.dgn) "
1794 "seed file should be used. This option is ignored if the SEED option is provided." ),
1799 QObject::tr(
"Override the seed file to use." ),
1804 QObject::tr(
"Indicate whether the whole seed file should be copied. "
1805 "If not, only the first three elements will be copied." ),
1810 QObject::tr(
"Indicates whether the color table should be copied from the seed file." ),
1815 QObject::tr(
"Override the master unit name from the seed file with "
1816 "the provided one or two character unit name." ),
1821 QObject::tr(
"Override the sub unit name from the seed file with the provided "
1822 "one or two character unit name." ),
1827 QObject::tr(
"Override the number of subunits per master unit. "
1828 "By default the seed file value is used." ),
1833 QObject::tr(
"Override the number of UORs (Units of Resolution) "
1834 "per sub unit. By default the seed file value is used." ),
1839 QObject::tr(
"ORIGIN=x,y,z: Override the origin of the design plane. "
1840 "By default the origin from the seed file is used." ),
1844 driverMetadata.insert( QStringLiteral(
"DGN" ),
1846 QStringLiteral(
"Microstation DGN" ),
1847 QObject::tr(
"Microstation DGN" ),
1848 QStringLiteral(
"*.dgn" ),
1849 QStringLiteral(
"dgn" ),
1856 datasetOptions.clear();
1857 layerOptions.clear();
1860 QObject::tr(
"Should update files be incorporated into the base data on the fly." ),
1862 << QStringLiteral(
"APPLY" )
1863 << QStringLiteral(
"IGNORE" ),
1864 QStringLiteral(
"APPLY" )
1868 QObject::tr(
"Should multipoint soundings be split into many single point sounding features. "
1869 "Multipoint geometries are not well handled by many formats, "
1870 "so it can be convenient to split single sounding features with many points "
1871 "into many single point features." ),
1876 QObject::tr(
"Should a DEPTH attribute be added on SOUNDG features and assign the depth "
1877 "of the sounding. This should only be enabled when SPLIT_MULTIPOINT is "
1883 QObject::tr(
"Should all the low level geometry primitives be returned as special "
1884 "IsolatedNode, ConnectedNode, Edge and Face layers." ),
1889 QObject::tr(
"If enabled, numeric attributes assigned an empty string as a value will "
1890 "be preserved as a special numeric value. This option should not generally "
1891 "be needed, but may be useful when translated S-57 to S-57 losslessly." ),
1896 QObject::tr(
"Should LNAM and LNAM_REFS fields be attached to features capturing "
1897 "the feature to feature relationships in the FFPT group of the S-57 file." ),
1902 QObject::tr(
"Should additional attributes relating features to their underlying "
1903 "geometric primitives be attached. These are the values of the FSPT group, "
1904 "and are primarily needed when doing S-57 to S-57 translations." ),
1909 QObject::tr(
"Should attribute values be recoded to UTF-8 from the character encoding "
1910 "specified in the S57 DSSI record." ),
1916 driverMetadata.insert( QStringLiteral(
"S57" ),
1918 QStringLiteral(
"S-57 Base file" ),
1919 QObject::tr(
"S-57 Base file" ),
1920 QStringLiteral(
"*.000" ),
1921 QStringLiteral(
"000" ),
1928 datasetOptions.clear();
1929 layerOptions.clear();
1931 driverMetadata.insert( QStringLiteral(
"SDTS" ),
1933 QStringLiteral(
"Spatial Data Transfer Standard [SDTS]" ),
1934 QObject::tr(
"Spatial Data Transfer Standard [SDTS]" ),
1935 QStringLiteral(
"*catd.ddf" ),
1936 QStringLiteral(
"ddf" ),
1943 datasetOptions.clear();
1944 layerOptions.clear();
1947 QObject::tr(
"Can be used to avoid creating the geometry_columns and spatial_ref_sys "
1948 "tables in a new database. By default these metadata tables are created "
1949 "when a new database is created." ),
1955 QStringLiteral(
"NO" )
1960 QStringLiteral(
"NO" )
1964 QObject::tr(
"Controls the format used for the geometry column. Defaults to WKB. "
1965 "This is generally more space and processing efficient, but harder "
1966 "to inspect or use in simple applications than WKT (Well Known Text)." ),
1968 << QStringLiteral(
"WKB" )
1969 << QStringLiteral(
"WKT" ),
1970 QStringLiteral(
"WKB" )
1974 QObject::tr(
"Controls whether layer and field names will be laundered for easier use "
1975 "in SQLite. Laundered names will be converted to lower case and some special "
1976 "characters(' - #) will be changed to underscores." ),
1981 QStringLiteral(
"NO" )
1985 QStringLiteral(
"NO" )
1993 QObject::tr(
"column_name1[,column_name2, …] A list of (String) columns that "
1994 "must be compressed with ZLib DEFLATE algorithm. This might be beneficial "
1995 "for databases that have big string blobs. However, use with care, since "
1996 "the value of such columns will be seen as compressed binary content with "
1997 "other SQLite utilities (or previous OGR versions). With OGR, when inserting, "
1998 "modifying or querying compressed columns, compression/decompression is "
1999 "done transparently. However, such columns cannot be (easily) queried with "
2000 "an attribute filter or WHERE clause. Note: in table definition, such columns "
2001 "have the 'VARCHAR_deflate' declaration type." ),
2005 driverMetadata.insert( QStringLiteral(
"SQLite" ),
2007 QStringLiteral(
"SQLite" ),
2008 QObject::tr(
"SQLite" ),
2009 QStringLiteral(
"*.sqlite" ),
2010 QStringLiteral(
"sqlite" ),
2013 QStringLiteral(
"UTF-8" )
2018 datasetOptions.clear();
2019 layerOptions.clear();
2022 QObject::tr(
"Can be used to avoid creating the geometry_columns and spatial_ref_sys "
2023 "tables in a new database. By default these metadata tables are created "
2024 "when a new database is created." ),
2029 QStringLiteral(
"YES" )
2033 QObject::tr(
"Insert the content of the EPSG CSV files into the spatial_ref_sys table. "
2034 "Set to NO for regular SQLite databases." ),
2039 QStringLiteral(
"SPATIALITE" )
2043 QObject::tr(
"Controls whether layer and field names will be laundered for easier use "
2044 "in SQLite. Laundered names will be converted to lower case and some special "
2045 "characters(' - #) will be changed to underscores." ),
2050 QObject::tr(
"If the database is of the SpatiaLite flavor, and if OGR is linked "
2051 "against libspatialite, this option can be used to control if a spatial "
2052 "index must be created." ),
2057 QObject::tr(
"If the format of the geometry BLOB is of the SpatiaLite flavor, "
2058 "this option can be used to control if the compressed format for "
2059 "geometries (LINESTRINGs, POLYGONs) must be used." ),
2064 QObject::tr(
"Used to force the SRID number of the SRS associated with the layer. "
2065 "When this option isn't specified and that a SRS is associated with the "
2066 "layer, a search is made in the spatial_ref_sys to find a match for the "
2067 "SRS, and, if there is no match, a new entry is inserted for the SRS in "
2068 "the spatial_ref_sys table. When the SRID option is specified, this "
2069 "search (and the eventual insertion of a new entry) will not be done: "
2070 "the specified SRID is used as such." ),
2075 QObject::tr(
"column_name1[,column_name2, …] A list of (String) columns that "
2076 "must be compressed with ZLib DEFLATE algorithm. This might be beneficial "
2077 "for databases that have big string blobs. However, use with care, since "
2078 "the value of such columns will be seen as compressed binary content with "
2079 "other SQLite utilities (or previous OGR versions). With OGR, when inserting, "
2080 "modifying or queryings compressed columns, compression/decompression is "
2081 "done transparently. However, such columns cannot be (easily) queried with "
2082 "an attribute filter or WHERE clause. Note: in table definition, such columns "
2083 "have the 'VARCHAR_deflate' declaration type." ),
2087 driverMetadata.insert( QStringLiteral(
"SpatiaLite" ),
2089 QStringLiteral(
"SpatiaLite" ),
2090 QObject::tr(
"SpatiaLite" ),
2091 QStringLiteral(
"*.sqlite" ),
2092 QStringLiteral(
"sqlite" ),
2095 QStringLiteral(
"UTF-8" )
2099 datasetOptions.clear();
2100 layerOptions.clear();
2103 QObject::tr(
"Override the header file used - in place of header.dxf." ),
2108 QObject::tr(
"Override the trailer file used - in place of trailer.dxf." ),
2112 driverMetadata.insert( QStringLiteral(
"DXF" ),
2114 QStringLiteral(
"AutoCAD DXF" ),
2115 QObject::tr(
"AutoCAD DXF" ),
2116 QStringLiteral(
"*.dxf" ),
2117 QStringLiteral(
"dxf" ),
2124 datasetOptions.clear();
2125 layerOptions.clear();
2128 QObject::tr(
"Indicates the GeoConcept export file extension. "
2129 "TXT was used by earlier releases of GeoConcept. GXT is currently used." ),
2131 << QStringLiteral(
"GXT" )
2132 << QStringLiteral(
"TXT" ),
2133 QStringLiteral(
"GXT" )
2137 QObject::tr(
"Path to the GCT: the GCT file describes the GeoConcept types definitions: "
2138 "In this file, every line must start with //# followed by a keyword. "
2139 "Lines starting with // are comments." ),
2144 QObject::tr(
"Defines the feature to be created. The TYPE corresponds to one of the Name "
2145 "found in the GCT file for a type section. The SUBTYPE corresponds to one of "
2146 "the Name found in the GCT file for a sub-type section within the previous "
2151 driverMetadata.insert( QStringLiteral(
"Geoconcept" ),
2153 QStringLiteral(
"Geoconcept" ),
2154 QObject::tr(
"Geoconcept" ),
2155 QStringLiteral(
"*.gxt *.txt" ),
2156 QStringLiteral(
"gxt" ),
2163 datasetOptions.clear();
2164 layerOptions.clear();
2166#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,9,0)
2168 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." ),
2170 << QStringLiteral(
"ALL" )
2171 << QStringLiteral(
"ARCGIS_PRO_3_2_OR_LATER" ),
2172 QStringLiteral(
"ALL" )
2177 QObject::tr(
"When this option is set, the new layer will be created inside the named "
2178 "FeatureDataset folder. If the folder does not already exist, it will be created." ),
2183 QObject::tr(
"Set layer name alias." ),
2188 QObject::tr(
"Set name of geometry column in new layer. Defaults to 'SHAPE'." ),
2189 QStringLiteral(
"SHAPE" )
2193 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'." ),
2198 QObject::tr(
"Name of the OID column to create. Defaults to 'OBJECTID'." ),
2199 QStringLiteral(
"OBJECTID" )
2215 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." ),
2220 QObject::tr(
"XML documentation for the layer." ),
2224 QObject::tr(
"Customize how data is stored. By default text in UTF-8 and data up to 1TB." ),
2225 {QStringLiteral(
"DEFAULTS" ), QStringLiteral(
"MAX_FILE_SIZE_4GB" ), QStringLiteral(
"MAX_FILE_SIZE_256TB" )},
2226 QStringLiteral(
"DEFAULTS" ),
2231 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." ),
2235 driverMetadata.insert( QStringLiteral(
"OpenFileGDB" ),
2237 QStringLiteral(
"ESRI File Geodatabase" ),
2238 QObject::tr(
"ESRI File Geodatabase" ),
2239 QStringLiteral(
"*.gdb" ),
2240 QStringLiteral(
"gdb" ),
2243 QStringLiteral(
"UTF-8" )
2248 datasetOptions.clear();
2249 layerOptions.clear();
2252 QObject::tr(
"When this option is set, the new layer will be created inside the named "
2253 "FeatureDataset folder. If the folder does not already exist, it will be created." ),
2258 QObject::tr(
"Set name of geometry column in new layer. Defaults to 'SHAPE'." ),
2259 QStringLiteral(
"SHAPE" )
2263 QObject::tr(
"Name of the OID column to create. Defaults to 'OBJECTID'." ),
2264 QStringLiteral(
"OBJECTID" )
2267 driverMetadata.insert( QStringLiteral(
"FileGDB" ),
2269 QStringLiteral(
"ESRI FileGDB" ),
2270 QObject::tr(
"ESRI FileGDB" ),
2271 QStringLiteral(
"*.gdb" ),
2272 QStringLiteral(
"gdb" ),
2275 QStringLiteral(
"UTF-8" )
2280 datasetOptions.clear();
2281 layerOptions.clear();
2284 QObject::tr(
"By default, the driver will try to detect the data type of fields. If set "
2285 "to STRING, all fields will be of String type." ),
2287 << QStringLiteral(
"AUTO" )
2288 << QStringLiteral(
"STRING" ),
2289 QStringLiteral(
"AUTO" ),
2294 QObject::tr(
"By default, the driver will read the first lines of each sheet to detect "
2295 "if the first line might be the name of columns. If set to FORCE, the driver "
2296 "will consider the first line as the header line. If set to "
2297 "DISABLE, it will be considered as the first feature. Otherwise "
2298 "auto-detection will occur." ),
2300 << QStringLiteral(
"FORCE" )
2301 << QStringLiteral(
"DISABLE" )
2302 << QStringLiteral(
"AUTO" ),
2303 QStringLiteral(
"AUTO" ),
2307 driverMetadata.insert( QStringLiteral(
"XLSX" ),
2309 QStringLiteral(
"MS Office Open XML spreadsheet" ),
2310 QObject::tr(
"MS Office Open XML spreadsheet [XLSX]" ),
2311 QStringLiteral(
"*.xlsx" ),
2312 QStringLiteral(
"xlsx" ),
2315 QStringLiteral(
"UTF-8" )
2320 datasetOptions.clear();
2321 layerOptions.clear();
2324 QObject::tr(
"By default, the driver will try to detect the data type of fields. If set "
2325 "to STRING, all fields will be of String type." ),
2327 << QStringLiteral(
"AUTO" )
2328 << QStringLiteral(
"STRING" ),
2329 QStringLiteral(
"AUTO" ),
2334 QObject::tr(
"By default, the driver will read the first lines of each sheet to detect "
2335 "if the first line might be the name of columns. If set to FORCE, the driver "
2336 "will consider the first line as the header line. If set to "
2337 "DISABLE, it will be considered as the first feature. Otherwise "
2338 "auto-detection will occur." ),
2340 << QStringLiteral(
"FORCE" )
2341 << QStringLiteral(
"DISABLE" )
2342 << QStringLiteral(
"AUTO" ),
2343 QStringLiteral(
"AUTO" ),
2347 driverMetadata.insert( QStringLiteral(
"ODS" ),
2349 QStringLiteral(
"Open Document Spreadsheet" ),
2350 QObject::tr(
"Open Document Spreadsheet [ODS]" ),
2351 QStringLiteral(
"*.ods" ),
2352 QStringLiteral(
"ods" ),
2355 QStringLiteral(
"UTF-8" )
2360 datasetOptions.clear();
2361 layerOptions.clear();
2364 QObject::tr(
"Compression method." ),
2366 << QStringLiteral(
"UNCOMPRESSED" )
2367 << QStringLiteral(
"SNAPPY" ),
2368 QStringLiteral(
"SNAPPY" ),
2373 QObject::tr(
"Geometry encoding." ),
2375 << QStringLiteral(
"WKB" )
2376 << QStringLiteral(
"WKT" )
2377 << QStringLiteral(
"GEOARROW" ),
2378 QStringLiteral(
"WKB" ),
2383 QObject::tr(
"Maximum number of rows per group." ),
2388 QObject::tr(
"Name for the feature identifier column" ),
2393 QObject::tr(
"Name for the geometry column" ),
2394 QStringLiteral(
"geometry" )
2398 QObject::tr(
"Name of the coordinate system for the edges." ),
2400 << QStringLiteral(
"PLANAR" )
2401 << QStringLiteral(
"SPHERICAL" ),
2402 QStringLiteral(
"PLANAR" ),
2406 driverMetadata.insert( QStringLiteral(
"Parquet" ),
2408 QStringLiteral(
"(Geo)Parquet" ),
2409 QObject::tr(
"(Geo)Parquet" ),
2410 QStringLiteral(
"*.parquet" ),
2411 QStringLiteral(
"parquet" ),
2414 QStringLiteral(
"UTF-8" )
2419 datasetOptions.clear();
2420 layerOptions.clear();
2423 QObject::tr(
"Line termination character sequence." ),
2425 << QStringLiteral(
"CRLF" )
2426 << QStringLiteral(
"LF" ),
2427 QStringLiteral(
"LF" ),
2433 QObject::tr(
"Format of geometry columns." ),
2435 << QStringLiteral(
"geometry" )
2436 << QStringLiteral(
"geography" ),
2437 QStringLiteral(
"geometry" ),
2442 QObject::tr(
"Controls whether layer and field names will be laundered for easier use. "
2443 "Laundered names will be converted to lower case and some special "
2444 "characters(' - #) will be changed to underscores." ),
2449 QObject::tr(
"Name for the geometry column. Defaults to wkb_geometry "
2450 "for GEOM_TYPE=geometry or the_geog for GEOM_TYPE=geography" ) ) );
2453 QObject::tr(
"Name of schema into which to create the new table" ) ) );
2456 QObject::tr(
"Whether to explicitly emit the CREATE SCHEMA statement to create the specified schema." ),
2461 QObject::tr(
"Whether to explicitly recreate the table if necessary." ),
2466 QObject::tr(
"Whether to explicitly destroy tables before recreating them." ),
2468 << QStringLiteral(
"YES" )
2469 << QStringLiteral(
"NO" )
2470 << QStringLiteral(
"IF_EXISTS" ),
2471 QStringLiteral(
"YES" ),
2476 QObject::tr(
"Used to force the SRID number of the SRS associated with the layer. "
2477 "When this option isn't specified and that a SRS is associated with the "
2478 "layer, a search is made in the spatial_ref_sys to find a match for the "
2479 "SRS, and, if there is no match, a new entry is inserted for the SRS in "
2480 "the spatial_ref_sys table. When the SRID option is specified, this "
2481 "search (and the eventual insertion of a new entry) will not be done: "
2482 "the specified SRID is used as such." ),
2487 QObject::tr(
"Can be set to 2.0 or 2.2 for PostGIS 2.0/2.2 compatibility. "
2488 "Important to set it correctly if using non-linear geometry types" ),
2489 QStringLiteral(
"2.2" )
2492 driverMetadata.insert( QStringLiteral(
"PGDUMP" ),
2494 QStringLiteral(
"PostgreSQL SQL dump" ),
2495 QObject::tr(
"PostgreSQL SQL dump" ),
2496 QStringLiteral(
"*.sql" ),
2497 QStringLiteral(
"sql" ),
2500 QStringLiteral(
"UTF-8" )
2506 QgsVectorFileWriterMetadataContainer(
const QgsVectorFileWriterMetadataContainer &other ) =
delete;
2507 QgsVectorFileWriterMetadataContainer &operator=(
const QgsVectorFileWriterMetadataContainer &other ) =
delete;
2508 ~QgsVectorFileWriterMetadataContainer()
2510 for (
auto it = driverMetadata.constBegin(); it != driverMetadata.constEnd(); ++it )
2512 for (
auto optionIt = it.value().driverOptions.constBegin(); optionIt != it.value().driverOptions.constEnd(); ++optionIt )
2513 delete optionIt.value();
2514 for (
auto optionIt = it.value().layerOptions.constBegin(); optionIt != it.value().layerOptions.constEnd(); ++optionIt )
2515 delete optionIt.value();
2519 QMap<QString, QgsVectorFileWriter::MetaData> driverMetadata;
2526 static QgsVectorFileWriterMetadataContainer sDriverMetadata;
2527 QMap<QString, MetaData>::ConstIterator it = sDriverMetadata.driverMetadata.constBegin();
2529 for ( ; it != sDriverMetadata.driverMetadata.constEnd(); ++it )
2531 if ( it.key() == QLatin1String(
"PGDUMP" ) &&
2532 driverName != QLatin1String(
"PGDUMP" ) &&
2533 driverName != QLatin1String(
"PostgreSQL SQL dump" ) )
2538 if ( it.key().startsWith( driverName ) || it.value().longName.startsWith( driverName ) )
2553 return QStringList();
2562 return QStringList();
2569 OGRwkbGeometryType ogrType =
static_cast<OGRwkbGeometryType
>( type );
2600 return mCapabilities;
2610 QgsFeatureList::iterator fIt = features.begin();
2612 for ( ; fIt != features.end(); ++fIt )
2637 QString styleString;
2638 QString currentStyle;
2640 QgsSymbolList::const_iterator symbolIt = symbols.constBegin();
2641 for ( ; symbolIt != symbols.constEnd(); ++symbolIt )
2643 int nSymbolLayers = ( *symbolIt )->symbolLayerCount();
2644 for (
int i = 0; i < nSymbolLayers; ++i )
2647 QMap< QgsSymbolLayer *, QString >::const_iterator it =
mSymbolLayerTable.find( ( *symbolIt )->symbolLayer( i ) );
2653 double mmsf = mmScaleFactor(
mSymbologyScale, ( *symbolIt )->outputUnit(), outputUnit );
2654 double musf = mapUnitScaleFactor(
mSymbologyScale, ( *symbolIt )->outputUnit(), outputUnit );
2656 currentStyle = ( *symbolIt )->symbolLayer( i )->ogrFeatureStyle( mmsf, musf );
2662 if ( symbolIt != symbols.constBegin() || i != 0 )
2664 styleString.append(
';' );
2666 styleString.append( currentStyle );
2671 OGR_F_SetStyleString( poFeature.get(), currentStyle.toLocal8Bit().constData() );
2672 if ( !writeFeature(
mLayer, poFeature.get() ) )
2684 OGR_F_SetStyleString( poFeature.get(), styleString.toLocal8Bit().constData() );
2692 if ( !writeFeature(
mLayer, poFeature.get() ) )
2716 int fldIdx = it.key();
2717 int ogrField = it.value();
2719 QVariant attrValue = feature.
attribute( fldIdx );
2724 OGR_F_UnsetField( poFeature.get(), ogrField );
2737 OGR_F_SetFieldNull( poFeature.get(), ogrField );
2752 mErrorMessage = QObject::tr(
"Error converting value (%1) for attribute field %2: %3" )
2753 .arg( feature.
attribute( fldIdx ).toString(),
2760 switch ( field.
type() )
2762 case QMetaType::Type::Int:
2763 OGR_F_SetFieldInteger( poFeature.get(), ogrField, attrValue.toInt() );
2765 case QMetaType::Type::LongLong:
2766 OGR_F_SetFieldInteger64( poFeature.get(), ogrField, attrValue.toLongLong() );
2768 case QMetaType::Type::Bool:
2769 OGR_F_SetFieldInteger( poFeature.get(), ogrField, attrValue.toInt() );
2771 case QMetaType::Type::QString:
2772 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( attrValue.toString() ).constData() );
2774 case QMetaType::Type::Double:
2775 OGR_F_SetFieldDouble( poFeature.get(), ogrField, attrValue.toDouble() );
2777 case QMetaType::Type::QDate:
2778 OGR_F_SetFieldDateTime( poFeature.get(), ogrField,
2779 attrValue.toDate().year(),
2780 attrValue.toDate().month(),
2781 attrValue.toDate().day(),
2784 case QMetaType::Type::QDateTime:
2787 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( attrValue.toDateTime().toString( QStringLiteral(
"yyyy/MM/dd hh:mm:ss.zzz" ) ) ).constData() );
2791 const QDateTime dt = attrValue.toDateTime();
2792 const QDate date = dt.date();
2793 const QTime time = dt.time();
2794 OGR_F_SetFieldDateTimeEx( poFeature.get(), ogrField,
2800 static_cast<float>( time.second() +
static_cast< double >( time.msec() ) / 1000 ),
2804 case QMetaType::Type::QTime:
2807 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( attrValue.toString() ).constData() );
2811 const QTime time = attrValue.toTime();
2812 OGR_F_SetFieldDateTimeEx( poFeature.get(), ogrField,
2816 static_cast<float>( time.second() +
static_cast< double >( time.msec() ) / 1000 ),
2821 case QMetaType::Type::QByteArray:
2823 const QByteArray ba = attrValue.toByteArray();
2824 OGR_F_SetFieldBinary( poFeature.get(), ogrField, ba.size(),
const_cast< GByte *
>(
reinterpret_cast< const GByte *
>( ba.data() ) ) );
2828 case QMetaType::Type::UnknownType:
2831 case QMetaType::Type::QStringList:
2836 const QJsonDocument doc = QJsonDocument::fromVariant( attrValue );
2838 if ( !doc.isNull() )
2840 jsonString = QString::fromUtf8( doc.toJson( QJsonDocument::Compact ).constData() );
2842 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( jsonString.constData() ) );
2846 QStringList list = attrValue.toStringList();
2847 if ( mSupportedListSubTypes.contains( QMetaType::Type::QString ) )
2849 int count = list.count();
2850 char **lst =
new char *[count + 1];
2854 for (
const QString &
string : list )
2856 lst[pos] = CPLStrdup(
mCodec->fromUnicode(
string ).data() );
2860 lst[count] =
nullptr;
2861 OGR_F_SetFieldStringList( poFeature.get(), ogrField, lst );
2866 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( list.join(
',' ) ).constData() );
2871 case QMetaType::Type::QVariantList:
2875 const QJsonDocument doc = QJsonDocument::fromVariant( attrValue );
2877 if ( !doc.isNull() )
2879 jsonString = QString::fromUtf8( doc.toJson( QJsonDocument::Compact ).data() );
2881 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( jsonString.constData() ) );
2886 if ( field.
subType() == QMetaType::Type::QString )
2888 QStringList list = attrValue.toStringList();
2889 if ( mSupportedListSubTypes.contains( QMetaType::Type::QString ) )
2891 int count = list.count();
2892 char **lst =
new char *[count + 1];
2896 for (
const QString &
string : list )
2898 lst[pos] = CPLStrdup(
mCodec->fromUnicode(
string ).data() );
2902 lst[count] =
nullptr;
2903 OGR_F_SetFieldStringList( poFeature.get(), ogrField, lst );
2908 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( list.join(
',' ) ).constData() );
2912 else if ( field.
subType() == QMetaType::Type::Int )
2914 const QVariantList list = attrValue.toList();
2915 if ( mSupportedListSubTypes.contains( QMetaType::Type::Int ) )
2917 const int count = list.count();
2918 int *lst =
new int[count];
2922 for (
const QVariant &value : list )
2924 lst[pos] = value.toInt();
2928 OGR_F_SetFieldIntegerList( poFeature.get(), ogrField, count, lst );
2933 QStringList strings;
2934 strings.reserve( list.size() );
2935 for (
const QVariant &value : list )
2937 strings << QString::number( value.toInt() );
2939 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( strings.join(
',' ) ).constData() );
2943 else if ( field.
subType() == QMetaType::Type::Double )
2945 const QVariantList list = attrValue.toList();
2946 if ( mSupportedListSubTypes.contains( QMetaType::Type::Double ) )
2948 const int count = list.count();
2949 double *lst =
new double[count];
2953 for (
const QVariant &value : list )
2955 lst[pos] = value.toDouble();
2959 OGR_F_SetFieldDoubleList( poFeature.get(), ogrField, count, lst );
2964 QStringList strings;
2965 strings.reserve( list.size() );
2966 for (
const QVariant &value : list )
2968 strings << QString::number( value.toDouble() );
2970 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( strings.join(
',' ) ).constData() );
2974 else if ( field.
subType() == QMetaType::Type::LongLong )
2976 const QVariantList list = attrValue.toList();
2977 if ( mSupportedListSubTypes.contains( QMetaType::Type::LongLong ) )
2979 const int count = list.count();
2980 long long *lst =
new long long[count];
2984 for (
const QVariant &value : list )
2986 lst[pos] = value.toLongLong();
2990 OGR_F_SetFieldInteger64List( poFeature.get(), ogrField, count, lst );
2995 QStringList strings;
2996 strings.reserve( list.size() );
2997 for (
const QVariant &value : list )
2999 strings << QString::number( value.toLongLong() );
3001 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( strings.join(
',' ) ).constData() );
3008 case QMetaType::Type::QVariantMap:
3011 const char *pszDataSubTypes = GDALGetMetadataItem( OGRGetDriverByName(
mOgrDriverName.toLocal8Bit().constData() ), GDAL_DMD_CREATIONFIELDDATASUBTYPES,
nullptr );
3012 if ( pszDataSubTypes && strstr( pszDataSubTypes,
"JSON" ) )
3014 const QJsonDocument doc = QJsonDocument::fromVariant( attrValue );
3016 if ( !doc.isNull() )
3018 const QByteArray json { doc.toJson( QJsonDocument::Compact ) };
3019 jsonString = QString::fromUtf8( json.data() );
3021 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( jsonString.constData() ) );
3031 mErrorMessage = QObject::tr(
"Invalid variant type for field %1[%2]: received %3 with type %4" )
3034 .arg( attrValue.typeName(),
3035 attrValue.toString() );
3048 if ( mCoordinateTransform )
3053 geom.
transform( *mCoordinateTransform );
3071 OGRGeometryH mGeom2 =
nullptr;
3100 geom.
get()->
addZValue( std::numeric_limits<double>::quiet_NaN() );
3107 geom.
get()->
addMValue( std::numeric_limits<double>::quiet_NaN() );
3127 mErrorMessage = QObject::tr(
"Feature geometry not imported (OGR error: %1)" )
3128 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3138 QByteArray wkb( geom.
asWkb( wkbFlags ) );
3139 OGRErr err = OGR_G_ImportFromWkb( mGeom2,
reinterpret_cast<unsigned char *
>(
const_cast<char *
>( wkb.constData() ) ), wkb.length() );
3140 if ( err != OGRERR_NONE )
3142 mErrorMessage = QObject::tr(
"Feature geometry not imported (OGR error: %1)" )
3143 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3150 OGR_F_SetGeometryDirectly( poFeature.get(), mGeom2 );
3158 QByteArray wkb( geom.
asWkb( wkbFlags ) );
3160 OGRErr err = OGR_G_ImportFromWkb( ogrGeom,
reinterpret_cast<unsigned char *
>(
const_cast<char *
>( wkb.constData() ) ), wkb.length() );
3161 if ( err != OGRERR_NONE )
3163 mErrorMessage = QObject::tr(
"Feature geometry not imported (OGR error: %1)" )
3164 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3171 OGR_F_SetGeometryDirectly( poFeature.get(), ogrGeom );
3186 for (
int i = 0; i < attributes.size(); i++ )
3188 if ( omap.find( i ) != omap.end() )
3193bool QgsVectorFileWriter::writeFeature( OGRLayerH layer, OGRFeatureH feature )
3195 if ( OGR_L_CreateFeature( layer, feature ) != OGRERR_NONE )
3197 mErrorMessage = QObject::tr(
"Feature creation error (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3207 if ( mUsingTransaction )
3209 if ( OGRERR_NONE != OGR_L_CommitTransaction(
mLayer ) )
3211 QgsDebugError( QStringLiteral(
"Error while committing transaction on OGRLayer." ) );
3224 const QString &fileName,
3225 const QString &fileEncoding,
3227 const QString &driverName,
3229 QString *errorMessage,
3230 const QStringList &datasourceOptions,
3231 const QStringList &layerOptions,
3232 bool skipAttributeCreation,
3233 QString *newFilename,
3235 double symbologyScale,
3245 if ( destCRS.
isValid() && layer )
3271 const QString &fileName,
3272 const QString &fileEncoding,
3274 const QString &driverName,
3276 QString *errorMessage,
3277 const QStringList &datasourceOptions,
3278 const QStringList &layerOptions,
3279 bool skipAttributeCreation,
3280 QString *newFilename,
3282 double symbologyScale,
3313 : driverName( QStringLiteral(
"GPKG" ) )
3321 if ( !layer || !layer->
isValid() )
3328 details.sourceCrs = layer->
crs();
3329 details.sourceWkbType = layer->
wkbType();
3330 details.sourceFields = layer->
fields();
3339 if ( details.storageType == QLatin1String(
"ESRI Shapefile" ) )
3347 details.geometryTypeScanIterator = layer->
getFeatures( req );
3351 details.renderContext.setExpressionContext( details.expressionContext );
3352 details.renderContext.setRendererScale( options.
symbologyScale );
3354 details.shallTransform =
false;
3359 details.shallTransform =
true;
3364 details.outputCrs = details.sourceCrs;
3367 details.destWkbType = details.sourceWkbType;
3381 details.attributes.clear();
3382 else if ( details.attributes.isEmpty() )
3384 const QgsAttributeList allAttributes = details.sourceFields.allAttributesList();
3385 for (
int idx : allAttributes )
3387 QgsField fld = details.sourceFields.at( idx );
3388 if ( details.providerType == QLatin1String(
"oracle" ) && fld.
typeName().contains( QLatin1String(
"SDO_GEOMETRY" ) ) )
3390 details.attributes.append( idx );
3394 if ( !details.attributes.isEmpty() )
3396 for (
int attrIdx : std::as_const( details.attributes ) )
3398 if ( details.sourceFields.exists( attrIdx ) )
3400 QgsField field = details.sourceFields.at( attrIdx );
3402 details.outputFields.append( field );
3406 QgsDebugError( QStringLiteral(
"No such source field with index '%1' available." ).arg( attrIdx ) );
3413 if ( details.providerType == QLatin1String(
"spatialite" ) )
3415 for (
int i = 0; i < details.outputFields.size(); i++ )
3417 if ( details.outputFields.at( i ).type() == QMetaType::Type::LongLong )
3422 if ( std::max( std::llabs( min.toLongLong() ), std::llabs( max.toLongLong() ) ) < std::numeric_limits<int>::max() )
3424 details.outputFields[i].setType( QMetaType::Type::Int );
3432 addRendererAttributes( details.renderer.get(), details.renderContext, details.sourceFields, details.attributes );
3442 bool useFilterRect =
true;
3443 if ( details.shallTransform )
3454 useFilterRect =
false;
3457 if ( useFilterRect )
3463 details.filterRectEngine->prepareGeometry();
3465 details.sourceFeatureIterator = layer->
getFeatures( req );
3484 int lastProgressReport = 0;
3485 long long total = details.featureCount;
3488 if ( details.providerType == QLatin1String(
"ogr" ) && !details.dataSourceUri.isEmpty() )
3490 QString srcFileName( details.providerUriParams.value( QStringLiteral(
"path" ) ).toString() );
3491 if ( QFile::exists( srcFileName ) && QFileInfo( fileName ).canonicalFilePath() == QFileInfo( srcFileName ).canonicalFilePath() )
3495 if ( !( ( options.
driverName == QLatin1String(
"GPKG" ) ||
3496 options.
driverName == QLatin1String(
"SpatiaLite" ) ||
3497 options.
driverName == QLatin1String(
"SQLite" ) ) &&
3498 options.
layerName != details.providerUriParams.value( QStringLiteral(
"layerName" ) ) ) )
3501 *
errorMessage = QObject::tr(
"Cannot overwrite an OGR layer in place" );
3521 int newProgress =
static_cast<int>( ( 5.0 * scanned ) / total );
3522 if ( newProgress != lastProgressReport )
3524 lastProgressReport = newProgress;
3539 QString tempNewFilename;
3540 QString tempNewLayer;
3548 std::unique_ptr< QgsVectorFileWriter > writer(
create( fileName, details.outputFields, destWkbType, details.outputCrs, transformContext, newOptions, sinkFlags, &tempNewFilename, &tempNewLayer ) );
3552 *newFilename = tempNewFilename;
3555 *newLayer = tempNewLayer;
3584 switch ( writer->symbologyExport() )
3602 int n = 0, errors = 0;
3611 writer->startRender( details.renderer.get(), details.sourceFields );
3613 writer->resetMap( details.attributes );
3615 writer->mFields = details.sourceFields;
3619 int initialProgress = lastProgressReport;
3620 while ( details.sourceFeatureIterator.nextFeature( fet ) )
3631 int newProgress =
static_cast<int>( initialProgress + ( ( 100.0 - initialProgress ) * saved ) / total );
3632 if ( newProgress < 100 && newProgress != lastProgressReport )
3634 lastProgressReport = newProgress;
3639 if ( details.shallTransform )
3652 const QString msg = QObject::tr(
"Failed to transform feature with ID '%1'. Writing stopped. (Exception: %2)" )
3653 .arg( fet.
id() ).arg( e.
what() );
3670 if ( !writer->addFeatureWithStyle( fet, writer->mRenderer.get(), mapUnits ) )
3677 *
errorMessage = QObject::tr(
"Feature write errors:" );
3683 if ( errors > 1000 )
3687 *
errorMessage += QObject::tr(
"Stopping after %n error(s)",
nullptr, errors );
3697 writer->stopRender();
3701 *
errorMessage += QObject::tr(
"\nOnly %1 of %2 features written." ).arg( n - errors ).arg( n );
3706 bool metadataFailure =
false;
3711 {QStringLiteral(
"path" ), tempNewFilename },
3712 {QStringLiteral(
"layerName" ), tempNewLayer }
3726 metadataFailure =
true;
3737 metadataFailure =
true;
3745 const QString &fileName,
3747 QString *newFilename,
3751 QgsVectorFileWriter::PreparedWriterDetails details;
3752 WriterError err = prepareWriteAsVectorFormat( layer, options, details );
3760 const QString &fileName,
3763 QString *newFilename,
3767 QgsVectorFileWriter::PreparedWriterDetails details;
3768 WriterError err = prepareWriteAsVectorFormat( layer, options, details );
3777 QgsVectorFileWriter::PreparedWriterDetails details;
3778 WriterError err = prepareWriteAsVectorFormat( layer, options, details );
3787 QFileInfo fi( fileName );
3788 QDir dir = fi.dir();
3791 for (
const char *suffix : {
".shp",
".shx",
".dbf",
".prj",
".qix",
".qpj",
".cpg",
".sbn",
".sbx",
".idm",
".ind" } )
3793 filter << fi.completeBaseName() + suffix;
3797 const auto constEntryList = dir.entryList( filter );
3798 for (
const QString &file : constEntryList )
3800 QFile f( dir.canonicalPath() +
'/' + file );
3803 QgsDebugError( QStringLiteral(
"Removing file %1 failed: %2" ).arg( file, f.errorString() ) );
3819 QStringList driverNames;
3822 for (
int i = 0; i < GDALGetDriverCount(); ++i )
3824 GDALDriverH
driver = GDALGetDriver( i );
3831 const QString driverExtensions = GDALGetMetadataItem(
driver, GDAL_DMD_EXTENSIONS,
"" );
3832 if ( driverExtensions.isEmpty() )
3835 const QSet< QString > splitExtensions = qgis::listToSet( driverExtensions.split(
' ', Qt::SkipEmptyParts ) );
3836 if ( splitExtensions.intersects( multiLayerExtensions ) )
3838 driverNames << OGR_Dr_GetName(
driver );
3846 static QReadWriteLock sFilterLock;
3847 static QMap< VectorFormatOptions, QList< QgsVectorFileWriter::FilterFormatDetails > > sFilters;
3851 const auto it = sFilters.constFind( options );
3852 if ( it != sFilters.constEnd() )
3856 QList< QgsVectorFileWriter::FilterFormatDetails > results;
3859 int const drvCount = OGRGetDriverCount();
3863 for (
int i = 0; i < drvCount; ++i )
3865 OGRSFDriverH drv = OGRGetDriver( i );
3868 const QString drvName = OGR_Dr_GetName( drv );
3872 if ( !multiLayerDrivers.contains( drvName ) )
3876 GDALDriverH gdalDriver = GDALGetDriverByName( drvName.toLocal8Bit().constData() );
3877 bool nonSpatialFormat =
false;
3880 nonSpatialFormat = GDALGetMetadataItem( gdalDriver, GDAL_DCAP_NONSPATIAL,
nullptr );
3883 if ( OGR_Dr_TestCapability( drv,
"CreateDataSource" ) != 0 )
3888 if ( nonSpatialFormat )
3893 if ( filterString.isEmpty() )
3900 globs = metadata.
glob.toLower().split(
' ' );
3906 details.
globs = globs;
3915 if ( options & SortRecommended )
3917 if ( a.driverName == QLatin1String(
"GPKG" ) )
3919 else if ( b.driverName == QLatin1String(
"GPKG" ) )
3921 else if ( a.driverName == QLatin1String(
"ESRI Shapefile" ) )
3923 else if ( b.driverName == QLatin1String(
"ESRI Shapefile" ) )
3930 sFilters.insert( options, results );
3937 QSet< QString > extensions;
3939 const thread_local QRegularExpression rx( QStringLiteral(
"\\*\\.(.*)$" ) );
3943 for (
const QString &glob : format.globs )
3945 const QRegularExpressionMatch match = rx.match( glob );
3946 if ( !match.hasMatch() )
3949 const QString matched = match.captured( 1 );
3950 extensions.insert( matched );
3954 QStringList extensionList( extensions.constBegin(), extensions.constEnd() );
3956 std::sort( extensionList.begin(), extensionList.end(), [options](
const QString & a,
const QString & b ) ->
bool
3958 if ( options & SortRecommended )
3960 if ( a == QLatin1String(
"gpkg" ) )
3962 else if ( b == QLatin1String(
"gpkg" ) )
3964 else if ( a == QLatin1String(
"shp" ) )
3966 else if ( b == QLatin1String(
"shp" ) )
3970 return a.toLower().localeAwareCompare( b.toLower() ) < 0;
3973 return extensionList;
3978 QList< QgsVectorFileWriter::DriverDetails > results;
3981 const int drvCount = OGRGetDriverCount();
3985 QStringList writableDrivers;
3986 for (
int i = 0; i < drvCount; ++i )
3988 OGRSFDriverH drv = OGRGetDriver( i );
3991 const QString drvName = OGR_Dr_GetName( drv );
3995 if ( !multiLayerDrivers.contains( drvName ) )
4003 if ( drvName == QLatin1String(
"ODS" ) || drvName == QLatin1String(
"XLSX" ) || drvName == QLatin1String(
"XLS" ) )
4007 if ( drvName == QLatin1String(
"ESRI Shapefile" ) )
4009 writableDrivers << QStringLiteral(
"DBF file" );
4011 if ( OGR_Dr_TestCapability( drv,
"CreateDataSource" ) != 0 )
4014 if ( drvName == QLatin1String(
"MapInfo File" ) )
4016 writableDrivers << QStringLiteral(
"MapInfo MIF" );
4018 else if ( drvName == QLatin1String(
"SQLite" ) )
4025 QString option = QStringLiteral(
"SPATIALITE=YES" );
4026 char *options[2] = { CPLStrdup( option.toLocal8Bit().constData() ),
nullptr };
4027 OGRSFDriverH poDriver;
4029 poDriver = OGRGetDriverByName( drvName.toLocal8Bit().constData() );
4032 gdal::ogr_datasource_unique_ptr ds( OGR_Dr_CreateDataSource( poDriver, QStringLiteral(
"/vsimem/spatialitetest.sqlite" ).toUtf8().constData(), options ) );
4035 writableDrivers << QStringLiteral(
"SpatiaLite" );
4036 OGR_Dr_DeleteDataSource( poDriver, QStringLiteral(
"/vsimem/spatialitetest.sqlite" ).toUtf8().constData() );
4039 CPLFree( options[0] );
4041 writableDrivers << drvName;
4046 results.reserve( writableDrivers.count() );
4047 for (
const QString &drvName : std::as_const( writableDrivers ) )
4061 if ( options & SortRecommended )
4063 if ( a.driverName == QLatin1String(
"GPKG" ) )
4065 else if ( b.driverName == QLatin1String(
"GPKG" ) )
4067 else if ( a.driverName == QLatin1String(
"ESRI Shapefile" ) )
4069 else if ( b.driverName == QLatin1String(
"ESRI Shapefile" ) )
4073 return a.
longName.toLower().localeAwareCompare( b.
longName.toLower() ) < 0;
4080 QString ext = extension.trimmed();
4081 if ( ext.isEmpty() )
4084 if ( ext.startsWith(
'.' ) )
4088 int const drvCount = GDALGetDriverCount();
4090 for (
int i = 0; i < drvCount; ++i )
4092 GDALDriverH drv = GDALGetDriver( i );
4098 QString drvName = GDALGetDriverShortName( drv );
4099 QStringList driverExtensions = QString( GDALGetMetadataItem( drv, GDAL_DMD_EXTENSIONS,
nullptr ) ).split(
' ' );
4101 const auto constDriverExtensions = driverExtensions;
4102 for (
const QString &
driver : constDriverExtensions )
4104 if (
driver.compare( ext, Qt::CaseInsensitive ) == 0 )
4115 QString filterString;
4119 if ( !filterString.isEmpty() )
4120 filterString += QLatin1String(
";;" );
4122 filterString += details.filterString;
4124 return filterString;
4133 return QStringLiteral(
"%1 (%2 %3)" ).arg( metadata.
trLongName,
4134 metadata.
glob.toLower(),
4135 metadata.
glob.toUpper() );
4140 if ( codecName == QLatin1String(
"System" ) )
4141 return QStringLiteral(
"LDID/0" );
4143 const thread_local QRegularExpression re( QRegularExpression::anchoredPattern( QString(
"(CP|windows-|ISO[ -])(.+)" ) ), QRegularExpression::CaseInsensitiveOption );
4144 const QRegularExpressionMatch match = re.match( codecName );
4145 if ( match.hasMatch() )
4147 QString
c = match.captured( 2 ).remove(
'-' );
4149 ( void )
c.toInt( &isNumber );
4177 OGRStyleTableH ogrStyleTable = OGR_STBL_Create();
4178 OGRStyleMgrH styleManager = OGR_SM_Create( ogrStyleTable );
4181 int nTotalLevels = 0;
4183 QgsSymbolList::iterator symbolIt = symbolList.begin();
4184 for ( ; symbolIt != symbolList.end(); ++symbolIt )
4186 double mmsf = mmScaleFactor(
mSymbologyScale, ( *symbolIt )->outputUnit(), mapUnits );
4187 double musf = mapUnitScaleFactor(
mSymbologyScale, ( *symbolIt )->outputUnit(), mapUnits );
4189 int nLevels = ( *symbolIt )->symbolLayerCount();
4190 for (
int i = 0; i < nLevels; ++i )
4192 mSymbolLayerTable.insert( ( *symbolIt )->symbolLayer( i ), QString::number( nTotalLevels ) );
4193 OGR_SM_AddStyle( styleManager, QString::number( nTotalLevels ).toLocal8Bit(),
4194 ( *symbolIt )->symbolLayer( i )->ogrFeatureStyle( mmsf, musf ).toLocal8Bit() );
4198 OGR_DS_SetStyleTableDirectly( ds, ogrStyleTable );
4204 if ( !details.renderer )
4209 QHash< QgsSymbol *, QList<QgsFeature> > features;
4218 startRender( details.renderer.get(), details.sourceFields );
4238 QString msg = QObject::tr(
"Failed to transform, writing stopped. (Exception: %1)" )
4249 featureSymbol = mRenderer->symbolForFeature( fet, mRenderContext );
4250 if ( !featureSymbol )
4255 QHash< QgsSymbol *, QList<QgsFeature> >::iterator it = features.find( featureSymbol );
4256 if ( it == features.end() )
4258 it = features.insert( featureSymbol, QList<QgsFeature>() );
4260 it.value().append( fet );
4265 QgsSymbolList symbols = mRenderer->symbols( mRenderContext );
4266 for (
int i = 0; i < symbols.count(); i++ )
4272 if ( level < 0 || level >= 1000 )
4275 while ( level >= levels.count() )
4277 levels[level].append( item );
4282 int nTotalFeatures = 0;
4285 for (
int l = 0; l < levels.count(); l++ )
4288 for (
int i = 0; i < level.count(); i++ )
4291 QHash< QgsSymbol *, QList<QgsFeature> >::iterator levelIt = features.find( item.
symbol() );
4292 if ( levelIt == features.end() )
4298 double mmsf = mmScaleFactor(
mSymbologyScale, levelIt.key()->outputUnit(), mapUnits );
4299 double musf = mapUnitScaleFactor(
mSymbologyScale, levelIt.key()->outputUnit(), mapUnits );
4301 int llayer = item.
layer();
4302 QList<QgsFeature> &featureList = levelIt.value();
4303 QList<QgsFeature>::iterator featureIt = featureList.begin();
4304 for ( ; featureIt != featureList.end(); ++featureIt )
4314 QString styleString = levelIt.key()->symbolLayer( llayer )->ogrFeatureStyle( mmsf, musf );
4315 if ( !styleString.isEmpty() )
4317 OGR_F_SetStyleString( ogrFeature.get(), styleString.toLocal8Bit().constData() );
4318 if ( !writeFeature(
mLayer, ogrFeature.get() ) )
4331 *
errorMessage += QObject::tr(
"\nOnly %1 of %2 features written." ).arg( nTotalFeatures - nErrors ).arg( nTotalFeatures );
4348 return 1000 / scale;
4365 return scale / 1000;
4373 mRenderer = createSymbologyRenderer( sourceRenderer );
4379 mRenderer->startRender( mRenderContext, fields );
4382void QgsVectorFileWriter::stopRender()
4389 mRenderer->stopRender( mRenderContext );
4392std::unique_ptr<QgsFeatureRenderer> QgsVectorFileWriter::createSymbologyRenderer(
QgsFeatureRenderer *sourceRenderer )
const
4405 if ( !sourceRenderer )
4410 return std::unique_ptr< QgsFeatureRenderer >( sourceRenderer->
clone() );
4417 const QSet<QString> rendererAttributes = renderer->
usedAttributes( context );
4418 for (
const QString &attr : rendererAttributes )
4423 attList.append( index );
4429QStringList QgsVectorFileWriter::concatenateOptions(
const QMap<QString, QgsVectorFileWriter::Option *> &options )
4432 QMap<QString, QgsVectorFileWriter::Option *>::ConstIterator it;
4434 for ( it = options.constBegin(); it != options.constEnd(); ++it )
4437 switch ( option->
type )
4444 list.append( QStringLiteral(
"%1=%2" ).arg( it.key() ).arg( opt->
defaultValue ) );
4454 list.append( QStringLiteral(
"%1=%2" ).arg( it.key(), opt->
defaultValue ) );
4464 list.append( QStringLiteral(
"%1=%2" ).arg( it.key(), opt->
defaultValue ) );
4471 if ( opt && !opt->
mValue.isEmpty() )
4473 list.append( QStringLiteral(
"%1=%2" ).arg( it.key(), opt->
mValue ) );
4484 OGRSFDriverH hDriver =
nullptr;
4488 QString drvName = OGR_Dr_GetName( hDriver );
4490 if ( OGR_DS_TestCapability( hDS.get(), ODsCCreateLayer ) )
4495 if ( !( drvName == QLatin1String(
"ESRI Shapefile" ) && QFile::exists( datasetName ) ) )
4498 if ( OGR_DS_TestCapability( hDS.get(), ODsCDeleteLayer ) )
4502 int layer_count = OGR_DS_GetLayerCount( hDS.get() );
4505 OGRLayerH hLayer = OGR_DS_GetLayer( hDS.get(), 0 );
4508 if ( OGR_L_TestCapability( hLayer, OLCSequentialWrite ) )
4511 if ( OGR_L_TestCapability( hLayer, OLCCreateField ) )
4522 const QString &layerNameIn )
4524 OGRSFDriverH hDriver =
nullptr;
4529 QString layerName( layerNameIn );
4530 if ( layerName.isEmpty() )
4531 layerName = QFileInfo( datasetName ).baseName();
4533 return OGR_DS_GetLayerByName( hDS.get(), layerName.toUtf8().constData() );
4538 const QString &layerName,
4542 OGRSFDriverH hDriver =
nullptr;
4546 OGRLayerH hLayer = OGR_DS_GetLayerByName( hDS.get(), layerName.toUtf8().constData() );
4552 OGRFeatureDefnH defn = OGR_L_GetLayerDefn( hLayer );
4553 const auto constAttributes = attributes;
4554 for (
int idx : constAttributes )
4557 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.
static QgsGeometryEngine * createGeometryEngine(const QgsAbstractGeometry *geometry, double precision=0.0)
Creates and returns a new geometry engine representing the specified geometry using precision on a gr...
Qgis::WkbType wkbType() const
Returns type of the geometry as a WKB type (point / linestring / polygon etc.)
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.
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.