47#include <QRegularExpression>
48#include <QJsonDocument>
54#include <ogr_srs_api.h>
57#include <cpl_string.h>
76 const QString &fileEncoding,
80 const QString &driverName,
81 const QStringList &datasourceOptions,
82 const QStringList &layerOptions,
94 init( vectorFileName, fileEncoding, fields, geometryType,
95 srs, driverName, datasourceOptions, layerOptions, newFilename,
nullptr,
100 const QString &fileEncoding,
104 const QString &driverName,
105 const QStringList &datasourceOptions,
106 const QStringList &layerOptions,
107 QString *newFilename,
110 const QString &layerName,
116 bool includeConstraints,
117 bool setFieldDomains,
120 , mWkbType( geometryType )
121 , mSymbologyExport( symbologyExport )
122 , mSymbologyScale( 1.0 )
123 , mIncludeConstraints( includeConstraints )
124 , mSetFieldDomains( setFieldDomains )
126 init( vectorFileName, fileEncoding, fields, geometryType, srs, driverName,
127 datasourceOptions, layerOptions, newFilename, fieldValueConverter,
128 layerName, action, newLayer, sinkFlags, transformContext, fieldNameSource, sourceDatabaseProviderConnection );
132 const QString &fileName,
139 QString *newFilename,
153 if ( driverName == QLatin1String(
"MapInfo MIF" ) )
157 GDALDriverH gdalDriver = GDALGetDriverByName( driverName.toLocal8Bit().constData() );
165#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,7,0)
166 return CSLFetchBoolean(
driverMetadata, GDAL_DCAP_FEATURE_STYLES_WRITE,
false );
168 return CSLFetchBoolean(
driverMetadata, GDAL_DCAP_FEATURE_STYLES,
false );
172void QgsVectorFileWriter::init( QString vectorFileName,
173 QString fileEncoding,
177 const QString &driverName,
178 QStringList datasourceOptions,
179 QStringList layerOptions,
180 QString *newFilename,
181 FieldValueConverter *fieldValueConverter,
182 const QString &layerNameIn,
183 ActionOnExistingFile action,
184 QString *newLayer, SinkFlags sinkFlags,
188#if GDAL_VERSION_NUM < GDAL_COMPUTE_VERSION(3,5,0)
189 ( void )sourceDatabaseProviderConnection;
194 if ( vectorFileName.isEmpty() )
201 if ( driverName == QLatin1String(
"MapInfo MIF" ) )
205 else if ( driverName == QLatin1String(
"SpatiaLite" ) )
208 if ( !datasourceOptions.contains( QStringLiteral(
"SPATIALITE=YES" ) ) )
210 datasourceOptions.append( QStringLiteral(
"SPATIALITE=YES" ) );
213 else if ( driverName == QLatin1String(
"DBF file" ) )
216 if ( !layerOptions.contains( QStringLiteral(
"SHPT=NULL" ) ) )
218 layerOptions.append( QStringLiteral(
"SHPT=NULL" ) );
227#if GDAL_VERSION_NUM < GDAL_COMPUTE_VERSION(3,3,1)
228 QString fidFieldName;
231 for (
const QString &layerOption : layerOptions )
233 if ( layerOption.startsWith( QLatin1String(
"FID=" ) ) )
235 fidFieldName = layerOption.mid( 4 );
239 if ( fidFieldName.isEmpty() )
240 fidFieldName = QStringLiteral(
"fid" );
245 OGRSFDriverH poDriver;
248 poDriver = OGRGetDriverByName(
mOgrDriverName.toLocal8Bit().constData() );
252 mErrorMessage = QObject::tr(
"OGR driver for '%1' not found (OGR error: %2)" )
254 QString::fromUtf8( CPLGetLastErrorMsg() ) );
259 mOgrDriverLongName = QString( GDALGetMetadataItem( poDriver, GDAL_DMD_LONGNAME,
nullptr ) );
266 if ( layerOptions.join( QString() ).toUpper().indexOf( QLatin1String(
"ENCODING=" ) ) == -1 )
271 if ( driverName == QLatin1String(
"ESRI Shapefile" ) && !vectorFileName.endsWith( QLatin1String(
".shp" ), Qt::CaseInsensitive ) )
273 vectorFileName += QLatin1String(
".shp" );
275 else if ( driverName == QLatin1String(
"DBF file" ) && !vectorFileName.endsWith( QLatin1String(
".dbf" ), Qt::CaseInsensitive ) )
277 vectorFileName += QLatin1String(
".dbf" );
287 QStringList allExts = metadata.ext.split(
' ', Qt::SkipEmptyParts );
289 const auto constAllExts = allExts;
290 for (
const QString &ext : constAllExts )
292 if ( vectorFileName.endsWith(
'.' + ext, Qt::CaseInsensitive ) )
301 vectorFileName +=
'.' + allExts[0];
307 if ( vectorFileName.endsWith( QLatin1String(
".gdb" ), Qt::CaseInsensitive ) )
309 QDir dir( vectorFileName );
312 QFileInfoList fileList = dir.entryInfoList(
313 QDir::NoDotAndDotDot | QDir::System | QDir::Hidden | QDir::AllDirs | QDir::Files, QDir::DirsFirst );
314 const auto constFileList = fileList;
315 for (
const QFileInfo &info : constFileList )
317 QFile::remove( info.absoluteFilePath() );
320 QDir().rmdir( vectorFileName );
324 QFile::remove( vectorFileName );
329 if ( metadataFound && !metadata.compulsoryEncoding.isEmpty() )
331 if ( fileEncoding.compare( metadata.compulsoryEncoding, Qt::CaseInsensitive ) != 0 )
333 QgsDebugMsgLevel( QStringLiteral(
"forced %1 encoding for %2" ).arg( metadata.compulsoryEncoding, driverName ), 2 );
334 fileEncoding = metadata.compulsoryEncoding;
339 char **options =
nullptr;
340 if ( !datasourceOptions.isEmpty() )
342 options =
new char *[ datasourceOptions.size() + 1 ];
343 for (
int i = 0; i < datasourceOptions.size(); i++ )
345 QgsDebugMsgLevel( QStringLiteral(
"-dsco=%1" ).arg( datasourceOptions[i] ), 2 );
346 options[i] = CPLStrdup( datasourceOptions[i].toUtf8().constData() );
348 options[ datasourceOptions.size()] =
nullptr;
355 mDS.reset( OGR_Dr_CreateDataSource( poDriver, vectorFileName.toUtf8().constData(), options ) );
357 mDS.reset( OGROpen( vectorFileName.toUtf8().constData(), TRUE,
nullptr ) );
361 for (
int i = 0; i < datasourceOptions.size(); i++ )
362 CPLFree( options[i] );
371 mErrorMessage = QObject::tr(
"Creation of data source failed (OGR error: %1)" )
372 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
374 mErrorMessage = QObject::tr(
"Opening of data source in update mode failed (OGR error: %1)" )
375 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
379 QString layerName( layerNameIn );
380 if ( layerName.isEmpty() )
381 layerName = QFileInfo( vectorFileName ).baseName();
385 const int layer_count = OGR_DS_GetLayerCount(
mDS.get() );
386 for (
int i = 0; i < layer_count; i++ )
388 OGRLayerH hLayer = OGR_DS_GetLayer(
mDS.get(), i );
389 if ( EQUAL( OGR_L_GetName( hLayer ), layerName.toUtf8().constData() ) )
391 if ( OGR_DS_DeleteLayer(
mDS.get(), i ) != OGRERR_NONE )
394 mErrorMessage = QObject::tr(
"Overwriting of existing layer failed (OGR error: %1)" )
395 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
409 QgsDebugMsgLevel( QStringLiteral(
"Opened data source in update mode" ), 2 );
413 mCodec = QTextCodec::codecForName( fileEncoding.toLocal8Bit().constData() );
416 QgsDebugError(
"error finding QTextCodec for " + fileEncoding );
419 QString enc = settings.
value( QStringLiteral(
"UI/encoding" ),
"System" ).toString();
420 mCodec = QTextCodec::codecForName( enc.toLocal8Bit().constData() );
424 mCodec = QTextCodec::codecForLocale();
430 if ( driverName == QLatin1String(
"KML" ) || driverName == QLatin1String(
"LIBKML" ) || driverName == QLatin1String(
"GPX" ) )
432 if ( srs.
authid() != QLatin1String(
"EPSG:4326" ) )
447 int optIndex = layerOptions.indexOf( QLatin1String(
"FEATURE_DATASET=" ) );
448 if ( optIndex != -1 )
450 layerOptions.removeAt( optIndex );
453 if ( !layerOptions.isEmpty() )
455 options =
new char *[ layerOptions.size() + 1 ];
456 for (
int i = 0; i < layerOptions.size(); i++ )
459 options[i] = CPLStrdup( layerOptions[i].toUtf8().constData() );
461 options[ layerOptions.size()] =
nullptr;
465 CPLSetConfigOption(
"SHAPE_ENCODING",
"" );
469 mLayer = OGR_DS_CreateLayer(
mDS.get(), layerName.toUtf8().constData(),
mOgrRef, wkbType, options );
472 *newLayer = OGR_L_GetName(
mLayer );
473 if ( driverName == QLatin1String(
"GPX" ) )
480 if ( !EQUAL( layerName.toUtf8().constData(),
"track_points" ) &&
481 !EQUAL( layerName.toUtf8().constData(),
"route_points" ) )
483 *newLayer = QStringLiteral(
"waypoints" );
490 const char *pszForceGPXTrack
491 = CSLFetchNameValue( options,
"FORCE_GPX_TRACK" );
492 if ( pszForceGPXTrack && CPLTestBool( pszForceGPXTrack ) )
493 *newLayer = QStringLiteral(
"tracks" );
495 *newLayer = QStringLiteral(
"routes" );
502 const char *pszForceGPXRoute
503 = CSLFetchNameValue( options,
"FORCE_GPX_ROUTE" );
504 if ( pszForceGPXRoute && CPLTestBool( pszForceGPXRoute ) )
505 *newLayer = QStringLiteral(
"routes" );
507 *newLayer = QStringLiteral(
"tracks" );
517 else if ( driverName == QLatin1String(
"DGN" ) )
519 mLayer = OGR_DS_GetLayerByName(
mDS.get(),
"elements" );
523 mLayer = OGR_DS_GetLayerByName(
mDS.get(), layerName.toUtf8().constData() );
528 for (
int i = 0; i < layerOptions.size(); i++ )
529 CPLFree( options[i] );
538 QString layerName = vectorFileName.left( vectorFileName.indexOf( QLatin1String(
".shp" ), Qt::CaseInsensitive ) );
539 QFile prjFile( layerName +
".qpj" );
540 if ( prjFile.exists() )
548 mErrorMessage = QObject::tr(
"Creation of layer failed (OGR error: %1)" )
549 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
551 mErrorMessage = QObject::tr(
"Opening of layer failed (OGR error: %1)" )
552 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
557 OGRFeatureDefnH defn = OGR_L_GetLayerDefn(
mLayer );
566 QSet<int> existingIdxs;
570#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,7,0)
571 if (
const char *pszCreateFieldDefnFlags = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATION_FIELD_DEFN_FLAGS,
nullptr ) )
573 char **papszTokens = CSLTokenizeString2( pszCreateFieldDefnFlags,
" ", 0 );
574 if ( CSLFindString( papszTokens,
"AlternativeName" ) >= 0 )
578 if ( CSLFindString( papszTokens,
"Comment" ) >= 0 )
582 CSLDestroy( papszTokens );
592#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,5,0)
593 QSet<QString> existingDestDomainNames;
594 if ( sourceDatabaseProviderConnection )
596 char **domainNames = GDALDatasetGetFieldDomainNames(
mDS.get(),
nullptr );
597 for (
const char *
const *iterDomainNames = domainNames; iterDomainNames && *iterDomainNames; ++iterDomainNames )
599 existingDestDomainNames.insert( QString::fromUtf8( *iterDomainNames ) );
601 CSLDestroy( domainNames );
604#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,6,0)
605 QSet< QString > usedAlternativeNames;
607 for (
int fldIdx = 0; fldIdx < fields.
count(); ++fldIdx )
611 if ( fieldValueConverter )
613 attrField = fieldValueConverter->fieldDefinition( fields.
at( fldIdx ) );
618 int ogrIdx = OGR_FD_GetFieldIndex( defn,
mCodec->fromUnicode( attrField.
name() ) );
627 switch ( fieldNameSource )
630 name = attrField.
name();
634 name = !attrField.
alias().isEmpty() ? attrField.
alias() : attrField.
name();
638 OGRFieldType ogrType = OFTString;
639 OGRFieldSubType ogrSubType = OFSTNone;
640 int ogrWidth = attrField.
length();
641 int ogrPrecision = attrField.
precision();
642 if ( ogrPrecision > 0 )
645 switch ( attrField.
type() )
647 case QMetaType::Type::LongLong:
649 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES,
nullptr );
650 if ( pszDataTypes && strstr( pszDataTypes,
"Integer64" ) )
651 ogrType = OFTInteger64;
654 ogrWidth = ogrWidth > 0 && ogrWidth <= 20 ? ogrWidth : 20;
658 case QMetaType::Type::QString:
660 if ( ( ogrWidth <= 0 || ogrWidth > 255 ) &&
mOgrDriverName == QLatin1String(
"ESRI Shapefile" ) )
664 case QMetaType::Type::Int:
665 ogrType = OFTInteger;
666 ogrWidth = ogrWidth > 0 && ogrWidth <= 10 ? ogrWidth : 10;
670 case QMetaType::Type::Bool:
671 ogrType = OFTInteger;
672 ogrSubType = OFSTBoolean;
677 case QMetaType::Type::Double:
678#if GDAL_VERSION_NUM < GDAL_COMPUTE_VERSION(3,3,1)
679 if (
mOgrDriverName == QLatin1String(
"GPKG" ) && attrField.
precision() == 0 && attrField.
name().compare( fidFieldName, Qt::CaseInsensitive ) == 0 )
682 ogrType = OFTInteger64;
689 case QMetaType::Type::QDate:
693 case QMetaType::Type::QTime:
705 case QMetaType::Type::QDateTime:
713 ogrType = OFTDateTime;
717 case QMetaType::Type::QByteArray:
721 case QMetaType::Type::QStringList:
727 ogrSubType = OFSTJSON;
731 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES,
nullptr );
732 if ( pszDataTypes && strstr( pszDataTypes,
"StringList" ) )
734 ogrType = OFTStringList;
735 mSupportedListSubTypes.insert( QMetaType::Type::QString );
745 case QMetaType::Type::QVariantMap:
748 const char *pszDataSubTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATASUBTYPES,
nullptr );
749 if ( pszDataSubTypes && strstr( pszDataSubTypes,
"JSON" ) )
752 ogrSubType = OFSTJSON;
760 case QMetaType::Type::QVariantList:
765 ogrSubType = OFSTJSON;
770 if ( attrField.
subType() == QMetaType::Type::QString )
772 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES,
nullptr );
773 if ( pszDataTypes && strstr( pszDataTypes,
"StringList" ) )
775 ogrType = OFTStringList;
776 mSupportedListSubTypes.insert( QMetaType::Type::QString );
785 else if ( attrField.
subType() == QMetaType::Type::Int )
787 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES,
nullptr );
788 if ( pszDataTypes && strstr( pszDataTypes,
"IntegerList" ) )
790 ogrType = OFTIntegerList;
791 mSupportedListSubTypes.insert( QMetaType::Type::Int );
800 else if ( attrField.
subType() == QMetaType::Type::Double )
802 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES,
nullptr );
803 if ( pszDataTypes && strstr( pszDataTypes,
"RealList" ) )
805 ogrType = OFTRealList;
806 mSupportedListSubTypes.insert( QMetaType::Type::Double );
815 else if ( attrField.
subType() == QMetaType::Type::LongLong )
817 const char *pszDataTypes = GDALGetMetadataItem( poDriver, GDAL_DMD_CREATIONFIELDDATATYPES,
nullptr );
818 if ( pszDataTypes && strstr( pszDataTypes,
"Integer64List" ) )
820 ogrType = OFTInteger64List;
821 mSupportedListSubTypes.insert( QMetaType::Type::LongLong );
835 mErrorMessage = QObject::tr(
"Unsupported type for field %1" )
836 .arg( attrField.
name() );
841 if (
mOgrDriverName == QLatin1String(
"SQLite" ) && name.compare( QLatin1String(
"ogc_fid" ), Qt::CaseInsensitive ) == 0 )
844 for ( i = 0; i < 10; i++ )
846 name = QStringLiteral(
"ogc_fid%1" ).arg( i );
849 for ( j = 0; j < fields.
size() && name.compare( fields.
at( j ).
name(), Qt::CaseInsensitive ) != 0; j++ )
852 if ( j == fields.
size() )
858 mErrorMessage = QObject::tr(
"No available replacement for internal fieldname ogc_fid found" ).arg( attrField.
name() );
863 QgsMessageLog::logMessage( QObject::tr(
"Reserved attribute name ogc_fid replaced with %1" ).arg( name ), QObject::tr(
"OGR" ) );
870 OGR_Fld_SetWidth( fld.get(), ogrWidth );
873 if ( ogrPrecision >= 0 )
875 OGR_Fld_SetPrecision( fld.get(), ogrPrecision );
878 if ( ogrSubType != OFSTNone )
879 OGR_Fld_SetSubType( fld.get(), ogrSubType );
881#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,6,0)
882 if ( !attrField.
alias().isEmpty() )
884 QString alternativeName = attrField.
alias();
886 while ( usedAlternativeNames.contains( alternativeName ) )
889 alternativeName = attrField.
alias() + QStringLiteral(
" (%1)" ).arg( ++counter );
891 OGR_Fld_SetAlternativeName( fld.get(),
mCodec->fromUnicode( alternativeName ).constData() );
892 usedAlternativeNames.insert( alternativeName );
895#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,7,0)
896 OGR_Fld_SetComment( fld.get(),
mCodec->fromUnicode( attrField.
comment() ).constData() );
903 OGR_Fld_SetNullable( fld.get(),
false );
907 OGR_Fld_SetUnique( fld.get(),
true );
910#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,5,0)
914 if ( !domainName.isEmpty() )
916 bool canSetFieldDomainName =
false;
917 if ( existingDestDomainNames.contains( domainName ) )
921 canSetFieldDomainName =
true;
923 else if ( GDALDatasetTestCapability(
mDS.get(), ODsCAddFieldDomain ) )
933 std::unique_ptr<QgsFieldDomain> domain( sourceDatabaseProviderConnection->
fieldDomain( domainName ) );
939 char *pszFailureReason =
nullptr;
940 if ( GDALDatasetAddFieldDomain(
mDS.get(), hFieldDomain, &pszFailureReason ) )
942 existingDestDomainNames.insert( domainName );
943 canSetFieldDomainName =
true;
947 QgsDebugError( QStringLiteral(
"cannot create field domain: %1" ).arg( pszFailureReason ) );
949 CPLFree( pszFailureReason );
950 OGR_FldDomain_Destroy( hFieldDomain );
956 QgsDebugError( QStringLiteral(
"Cannot retrieve field domain: %1" ).arg( domainName ) );
959 if ( canSetFieldDomainName )
961 OGR_Fld_SetDomainName( fld.get(), domainName.toUtf8().toStdString().c_str() );
969 " type " + QString( QVariant::typeToName( attrField.
type() ) ) +
970 " width " + QString::number( ogrWidth ) +
971 " precision " + QString::number( ogrPrecision ), 2 );
972 if ( OGR_L_CreateField(
mLayer, fld.get(),
true ) != OGRERR_NONE )
975 mErrorMessage = QObject::tr(
"Creation of field %1 (%2) failed (OGR error: %3)" )
976 .arg( attrField.
name(),
977 QVariant::typeToName( attrField.
type() ),
978 QString::fromUtf8( CPLGetLastErrorMsg() ) );
983 int ogrIdx = OGR_FD_GetFieldIndex( defn,
mCodec->fromUnicode( name ) );
984 QgsDebugMsgLevel( QStringLiteral(
"returned field index for %1: %2" ).arg( name ).arg( ogrIdx ), 2 );
985 if ( ogrIdx < 0 || existingIdxs.contains( ogrIdx ) )
988 ogrIdx = OGR_FD_GetFieldCount( defn ) - 1;
993 mErrorMessage = QObject::tr(
"Created field %1 not found (OGR error: %2)" )
994 .arg( attrField.
name(),
995 QString::fromUtf8( CPLGetLastErrorMsg() ) );
1001 existingIdxs.insert( ogrIdx );
1009 for (
int fldIdx = 0; fldIdx < fields.
count(); ++fldIdx )
1012 QString name( attrField.
name() );
1013 int ogrIdx = OGR_FD_GetFieldIndex( defn,
mCodec->fromUnicode( name ) );
1025 int fidIdx = fields.
lookupField( QStringLiteral(
"FID" ) );
1036 *newFilename = vectorFileName;
1039 mUsingTransaction =
true;
1040 if ( OGRERR_NONE != OGR_L_StartTransaction(
mLayer ) )
1042 mUsingTransaction =
false;
1052class QgsVectorFileWriterMetadataContainer
1056 QgsVectorFileWriterMetadataContainer()
1058 QMap<QString, QgsVectorFileWriter::Option *> datasetOptions;
1059 QMap<QString, QgsVectorFileWriter::Option *> layerOptions;
1062 datasetOptions.clear();
1063 layerOptions.clear();
1066 QObject::tr(
"Compression method." ),
1068 << QStringLiteral(
"UNCOMPRESSED" )
1069 << QStringLiteral(
"ZSTD" )
1070 << QStringLiteral(
"LZ4" ),
1071 QStringLiteral(
"LZ4" ),
1076 QObject::tr(
"Geometry encoding." ),
1078 << QStringLiteral(
"GEOARROW" )
1079 << QStringLiteral(
"WKB" )
1080 << QStringLiteral(
"WKT" ),
1081 QStringLiteral(
"GEOARROW" ),
1086 QObject::tr(
"Maximum number of rows per batch." ),
1091 QObject::tr(
"Name for the feature identifier column" ),
1096 QObject::tr(
"Name for the geometry column" ),
1097 QStringLiteral(
"geometry" )
1100 driverMetadata.insert( QStringLiteral(
"Arrow" ),
1102 QStringLiteral(
"(Geo)Arrow" ),
1103 QObject::tr(
"(Geo)Arrow" ),
1104 QStringLiteral(
"*.arrow *.feather *.arrows *.ipc" ),
1105 QStringLiteral(
"arrow" ),
1108 QStringLiteral(
"UTF-8" )
1113 datasetOptions.clear();
1114 layerOptions.clear();
1116 driverMetadata.insert( QStringLiteral(
"AVCE00" ),
1118 QStringLiteral(
"Arc/Info ASCII Coverage" ),
1119 QObject::tr(
"Arc/Info ASCII Coverage" ),
1120 QStringLiteral(
"*.e00" ),
1121 QStringLiteral(
"e00" ),
1128 datasetOptions.clear();
1129 layerOptions.clear();
1132 QObject::tr(
"By default when creating new .csv files they "
1133 "are created with the line termination conventions "
1134 "of the local platform (CR/LF on Win32 or LF on all other systems). "
1135 "This may be overridden through the use of the LINEFORMAT option." ),
1137 << QStringLiteral(
"CRLF" )
1138 << QStringLiteral(
"LF" ),
1144 QObject::tr(
"By default, the geometry of a feature written to a .csv file is discarded. "
1145 "It is possible to export the geometry in its WKT representation by "
1146 "specifying GEOMETRY=AS_WKT. It is also possible to export point geometries "
1147 "into their X,Y,Z components by specifying GEOMETRY=AS_XYZ, GEOMETRY=AS_XY "
1148 "or GEOMETRY=AS_YX." ),
1150 << QStringLiteral(
"AS_WKT" )
1151 << QStringLiteral(
"AS_XYZ" )
1152 << QStringLiteral(
"AS_XY" )
1153 << QStringLiteral(
"AS_YX" ),
1159 QObject::tr(
"Create the associated .csvt file to describe the type of each "
1160 "column of the layer and its optional width and precision." ),
1165 QObject::tr(
"Field separator character." ),
1167 << QStringLiteral(
"COMMA" )
1168 << QStringLiteral(
"SEMICOLON" )
1169 << QStringLiteral(
"TAB" ),
1170 QStringLiteral(
"COMMA" )
1174 QObject::tr(
"Double-quote strings. IF_AMBIGUOUS means that string values that look like numbers will be quoted." ),
1176 << QStringLiteral(
"IF_NEEDED" )
1177 << QStringLiteral(
"IF_AMBIGUOUS" )
1178 << QStringLiteral(
"ALWAYS" ),
1179 QStringLiteral(
"IF_AMBIGUOUS" )
1183 QObject::tr(
"Write a UTF-8 Byte Order Mark (BOM) at the start of the file." ),
1187 driverMetadata.insert( QStringLiteral(
"CSV" ),
1189 QStringLiteral(
"Comma Separated Value [CSV]" ),
1190 QObject::tr(
"Comma Separated Value [CSV]" ),
1191 QStringLiteral(
"*.csv" ),
1192 QStringLiteral(
"csv" ),
1199 datasetOptions.clear();
1200 layerOptions.clear();
1202 driverMetadata.insert( QStringLiteral(
"FlatGeobuf" ),
1204 QStringLiteral(
"FlatGeobuf" ),
1205 QObject::tr(
"FlatGeobuf" ),
1206 QStringLiteral(
"*.fgb" ),
1207 QStringLiteral(
"fgb" ),
1210 QStringLiteral(
"UTF-8" )
1215 datasetOptions.clear();
1216 layerOptions.clear();
1219 QObject::tr(
"Override the type of shapefile created. "
1220 "Can be one of NULL for a simple .dbf file with no .shp file, POINT, "
1221 "ARC, POLYGON or MULTIPOINT for 2D, or POINTZ, ARCZ, POLYGONZ or "
1222 "MULTIPOINTZ for 3D;" ) +
1223 QObject::tr(
" POINTM, ARCM, POLYGONM or MULTIPOINTM for measured geometries"
1224 " and POINTZM, ARCZM, POLYGONZM or MULTIPOINTZM for 3D measured"
1226 QObject::tr(
" MULTIPATCH files are supported since GDAL 2.2." ) +
1229 << QStringLiteral(
"NULL" )
1230 << QStringLiteral(
"POINT" )
1231 << QStringLiteral(
"ARC" )
1232 << QStringLiteral(
"POLYGON" )
1233 << QStringLiteral(
"MULTIPOINT" )
1234 << QStringLiteral(
"POINTZ" )
1235 << QStringLiteral(
"ARCZ" )
1236 << QStringLiteral(
"POLYGONZ" )
1237 << QStringLiteral(
"MULTIPOINTZ" )
1238 << QStringLiteral(
"POINTM" )
1239 << QStringLiteral(
"ARCM" )
1240 << QStringLiteral(
"POLYGONM" )
1241 << QStringLiteral(
"MULTIPOINTM" )
1242 << QStringLiteral(
"POINTZM" )
1243 << QStringLiteral(
"ARCZM" )
1244 << QStringLiteral(
"POLYGONZM" )
1245 << QStringLiteral(
"MULTIPOINTZM" )
1246 << QStringLiteral(
"MULTIPATCH" )
1256 QObject::tr(
"Set the encoding value in the DBF file. "
1257 "The default value is LDID/87. It is not clear "
1258 "what other values may be appropriate." ),
1266 QObject::tr(
"Set to YES to resize fields to their optimal size." ),
1270 driverMetadata.insert( QStringLiteral(
"ESRI" ),
1272 QStringLiteral(
"ESRI Shapefile" ),
1273 QObject::tr(
"ESRI Shapefile" ),
1274 QStringLiteral(
"*.shp" ),
1275 QStringLiteral(
"shp" ),
1282 datasetOptions.clear();
1283 layerOptions.clear();
1285 driverMetadata.insert( QStringLiteral(
"DBF File" ),
1287 QStringLiteral(
"DBF File" ),
1288 QObject::tr(
"DBF File" ),
1289 QStringLiteral(
"*.dbf" ),
1290 QStringLiteral(
"dbf" ),
1297 datasetOptions.clear();
1298 layerOptions.clear();
1301 QObject::tr(
"Set to YES to write a bbox property with the bounding box "
1302 "of the geometries at the feature and feature collection level." ),
1307 QObject::tr(
"Maximum number of figures after decimal separator to write in coordinates. "
1308 "Defaults to 15. Truncation will occur to remove trailing zeros." ),
1313 QObject::tr(
"Whether to use RFC 7946 standard. "
1314 "If disabled GeoJSON 2008 initial version will be used. "
1315 "Default is NO (thus GeoJSON 2008). See also Documentation (via Help button)" ),
1319 driverMetadata.insert( QStringLiteral(
"GeoJSON" ),
1321 QStringLiteral(
"GeoJSON" ),
1322 QObject::tr(
"GeoJSON" ),
1323 QStringLiteral(
"*.geojson" ),
1324 QStringLiteral(
"geojson" ),
1327 QStringLiteral(
"UTF-8" )
1332 datasetOptions.clear();
1333 layerOptions.clear();
1336 QObject::tr(
"Maximum number of figures after decimal separator to write in coordinates. "
1337 "Defaults to 15. Truncation will occur to remove trailing zeros." ),
1342 QObject::tr(
"Whether to start records with the RS=0x1E character (RFC 8142 standard). "
1343 "Defaults to NO: Newline Delimited JSON (geojsonl). \n"
1344 "If set to YES: RFC 8142 standard: GeoJSON Text Sequences (geojsons)." ),
1348 driverMetadata.insert( QStringLiteral(
"GeoJSONSeq" ),
1350 QStringLiteral(
"GeoJSON - Newline Delimited" ),
1351 QObject::tr(
"GeoJSON - Newline Delimited" ),
1352 QStringLiteral(
"*.geojsonl *.geojsons *.json" ),
1353 QStringLiteral(
"geojsonl geojsons json" ),
1356 QStringLiteral(
"UTF-8" )
1361 datasetOptions.clear();
1362 layerOptions.clear();
1365 QObject::tr(
"whether the document must be in RSS 2.0 or Atom 1.0 format. "
1366 "Default value : RSS" ),
1368 << QStringLiteral(
"RSS" )
1369 << QStringLiteral(
"ATOM" ),
1370 QStringLiteral(
"RSS" )
1374 QObject::tr(
"The encoding of location information. Default value : SIMPLE. "
1375 "W3C_GEO only supports point geometries. "
1376 "SIMPLE or W3C_GEO only support geometries in geographic WGS84 coordinates." ),
1378 << QStringLiteral(
"SIMPLE" )
1379 << QStringLiteral(
"GML" )
1380 << QStringLiteral(
"W3C_GEO" ),
1381 QStringLiteral(
"SIMPLE" )
1385 QObject::tr(
"If defined to YES, extension fields will be written. "
1386 "If the field name not found in the base schema matches "
1387 "the foo_bar pattern, foo will be considered as the namespace "
1388 "of the element, and a <foo:bar> element will be written. "
1389 "Otherwise, elements will be written in the <ogr:> namespace." ),
1394 QObject::tr(
"If defined to NO, only <entry> or <item> elements will be written. "
1395 "The user will have to provide the appropriate header and footer of the document." ),
1400 QObject::tr(
"XML content that will be put between the <channel> element and the "
1401 "first <item> element for a RSS document, or between the xml tag and "
1402 "the first <entry> element for an Atom document." ),
1407 QObject::tr(
"Value put inside the <title> element in the header. "
1408 "If not provided, a dummy value will be used as that element is compulsory." ),
1413 QObject::tr(
"Value put inside the <description> element in the header. "
1414 "If not provided, a dummy value will be used as that element is compulsory." ),
1419 QObject::tr(
"Value put inside the <link> element in the header. "
1420 "If not provided, a dummy value will be used as that element is compulsory." ),
1425 QObject::tr(
"Value put inside the <updated> element in the header. "
1426 "Should be formatted as a XML datetime. "
1427 "If not provided, a dummy value will be used as that element is compulsory." ),
1432 QObject::tr(
"Value put inside the <author><name> element in the header. "
1433 "If not provided, a dummy value will be used as that element is compulsory." ),
1438 QObject::tr(
"Value put inside the <id> element in the header. "
1439 "If not provided, a dummy value will be used as that element is compulsory." ),
1443 driverMetadata.insert( QStringLiteral(
"GeoRSS" ),
1445 QStringLiteral(
"GeoRSS" ),
1446 QObject::tr(
"GeoRSS" ),
1447 QStringLiteral(
"*.xml" ),
1448 QStringLiteral(
"xml" ),
1451 QStringLiteral(
"UTF-8" )
1456 datasetOptions.clear();
1457 layerOptions.clear();
1460 QObject::tr(
"If provided, this URI will be inserted as the schema location. "
1461 "Note that the schema file isn't actually accessed by OGR, so it "
1462 "is up to the user to ensure it will match the schema of the OGR "
1463 "produced GML data file." ),
1468 QObject::tr(
"This writes a GML application schema file to a corresponding "
1469 ".xsd file (with the same basename). If INTERNAL is used the "
1470 "schema is written within the GML file, but this is experimental "
1471 "and almost certainly not valid XML. "
1472 "OFF disables schema generation (and is implicit if XSISCHEMAURI is used)." ),
1474 << QStringLiteral(
"EXTERNAL" )
1475 << QStringLiteral(
"INTERNAL" )
1476 << QStringLiteral(
"OFF" ),
1477 QStringLiteral(
"EXTERNAL" )
1481 QObject::tr(
"This is the prefix for the application target namespace." ),
1482 QStringLiteral(
"ogr" )
1486 QObject::tr(
"Can be set to TRUE to avoid writing the prefix of the "
1487 "application target namespace in the GML file." ),
1492 QObject::tr(
"Defaults to 'http://ogr.maptools.org/'. "
1493 "This is the application target namespace." ),
1494 QStringLiteral(
"http://ogr.maptools.org/" )
1498 QObject::tr(
"GML version to use." ),
1500 << QStringLiteral(
"GML2" )
1501 << QStringLiteral(
"GML3" )
1502 << QStringLiteral(
"GML3Deegree" )
1503 << QStringLiteral(
"GML3.2" ),
1504 QStringLiteral(
"GML3.2" )
1508 QObject::tr(
"Only valid when FORMAT=GML3/GML3Degree/GML3.2. Default to YES. "
1509 "If YES, SRS with EPSG authority will be written with the "
1510 "'urn:ogc:def:crs:EPSG::' prefix. In the case the SRS is a "
1511 "geographic SRS without explicit AXIS order, but that the same "
1512 "SRS authority code imported with ImportFromEPSGA() should be "
1513 "treated as lat/long, then the function will take care of coordinate "
1514 "order swapping. If set to NO, SRS with EPSG authority will be "
1515 "written with the 'EPSG:' prefix, even if they are in lat/long order." ),
1520 QObject::tr(
"only valid when FORMAT=GML3/GML3Degree/GML3.2) Default to YES. "
1521 "If set to NO, the <gml:boundedBy> element will not be written for "
1527 QObject::tr(
"Default to YES. If YES, the output will be indented with spaces "
1528 "for more readability, but at the expense of file size." ),
1533 driverMetadata.insert( QStringLiteral(
"GML" ),
1535 QStringLiteral(
"Geography Markup Language [GML]" ),
1536 QObject::tr(
"Geography Markup Language [GML]" ),
1537 QStringLiteral(
"*.gml" ),
1538 QStringLiteral(
"gml" ),
1541 QStringLiteral(
"UTF-8" )
1546 datasetOptions.clear();
1547 layerOptions.clear();
1550 QObject::tr(
"Human-readable identifier (e.g. short name) for the layer content" ),
1555 QObject::tr(
"Human-readable description for the layer content" ),
1560 QObject::tr(
"Name for the feature identifier column" ),
1561 QStringLiteral(
"fid" )
1565 QObject::tr(
"Name for the geometry column" ),
1566 QStringLiteral(
"geom" )
1570 QObject::tr(
"If a spatial index must be created." ),
1574 driverMetadata.insert( QStringLiteral(
"GPKG" ),
1576 QStringLiteral(
"GeoPackage" ),
1577 QObject::tr(
"GeoPackage" ),
1578#
if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,7,0)
1579 QStringLiteral(
"*.gpkg *.gpkg.zip" ),
1581 QStringLiteral(
"*.gpkg" ),
1583 QStringLiteral(
"gpkg" ),
1586 QStringLiteral(
"UTF-8" )
1591 datasetOptions.clear();
1592 layerOptions.clear();
1594 driverMetadata.insert( QStringLiteral(
"GMT" ),
1596 QStringLiteral(
"Generic Mapping Tools [GMT]" ),
1597 QObject::tr(
"Generic Mapping Tools [GMT]" ),
1598 QStringLiteral(
"*.gmt" ),
1599 QStringLiteral(
"gmt" ),
1606 datasetOptions.clear();
1607 layerOptions.clear();
1610 QObject::tr(
"By default when writing a layer whose features are of "
1611 "type wkbLineString, the GPX driver chooses to write "
1612 "them as routes. If FORCE_GPX_TRACK=YES is specified, "
1613 "they will be written as tracks." ),
1618 QObject::tr(
"By default when writing a layer whose features are of "
1619 "type wkbMultiLineString, the GPX driver chooses to write "
1620 "them as tracks. If FORCE_GPX_ROUTE=YES is specified, "
1621 "they will be written as routes, provided that the multilines "
1622 "are composed of only one single line." ),
1627 QObject::tr(
"If GPX_USE_EXTENSIONS=YES is specified, "
1628 "extra fields will be written inside the <extensions> tag." ),
1633 QObject::tr(
"Only used if GPX_USE_EXTENSIONS=YES and GPX_EXTENSIONS_NS_URL "
1634 "is set. The namespace value used for extension tags. By default, 'ogr'." ),
1635 QStringLiteral(
"ogr" )
1639 QObject::tr(
"Only used if GPX_USE_EXTENSIONS=YES and GPX_EXTENSIONS_NS "
1640 "is set. The namespace URI. By default, 'http://osgeo.org/gdal'." ),
1641 QStringLiteral(
"http://osgeo.org/gdal" )
1645 QObject::tr(
"By default files are created with the line termination "
1646 "conventions of the local platform (CR/LF on win32 or LF "
1647 "on all other systems). This may be overridden through use "
1648 "of the LINEFORMAT layer creation option which may have a value "
1649 "of CRLF (DOS format) or LF (Unix format)." ),
1651 << QStringLiteral(
"CRLF" )
1652 << QStringLiteral(
"LF" ),
1657 driverMetadata.insert( QStringLiteral(
"GPX" ),
1659 QStringLiteral(
"GPS eXchange Format [GPX]" ),
1660 QObject::tr(
"GPS eXchange Format [GPX]" ),
1661 QStringLiteral(
"*.gpx" ),
1662 QStringLiteral(
"gpx" ),
1665 QStringLiteral(
"UTF-8" )
1670 datasetOptions.clear();
1671 layerOptions.clear();
1673 driverMetadata.insert( QStringLiteral(
"Interlis 1" ),
1675 QStringLiteral(
"INTERLIS 1" ),
1676 QObject::tr(
"INTERLIS 1" ),
1677 QStringLiteral(
"*.itf *.xml *.ili" ),
1678 QStringLiteral(
"ili" ),
1685 datasetOptions.clear();
1686 layerOptions.clear();
1688 driverMetadata.insert( QStringLiteral(
"Interlis 2" ),
1690 QStringLiteral(
"INTERLIS 2" ),
1691 QObject::tr(
"INTERLIS 2" ),
1692 QStringLiteral(
"*.xtf *.xml *.ili" ),
1693 QStringLiteral(
"ili" ),
1700 datasetOptions.clear();
1701 layerOptions.clear();
1704 QObject::tr(
"Allows you to specify the field to use for the KML <name> element." ),
1705 QStringLiteral(
"Name" )
1709 QObject::tr(
"Allows you to specify the field to use for the KML <description> element." ),
1710 QStringLiteral(
"Description" )
1714 QObject::tr(
"Allows you to specify the AltitudeMode to use for KML geometries. "
1715 "This will only affect 3D geometries and must be one of the valid KML options." ),
1717 << QStringLiteral(
"clampToGround" )
1718 << QStringLiteral(
"relativeToGround" )
1719 << QStringLiteral(
"absolute" ),
1720 QStringLiteral(
"relativeToGround" )
1724 QObject::tr(
"The DOCUMENT_ID datasource creation option can be used to specified "
1725 "the id of the root <Document> node. The default value is root_doc." ),
1726 QStringLiteral(
"root_doc" )
1729 driverMetadata.insert( QStringLiteral(
"KML" ),
1731 QStringLiteral(
"Keyhole Markup Language [KML]" ),
1732 QObject::tr(
"Keyhole Markup Language [KML]" ),
1733 QStringLiteral(
"*.kml" ),
1734 QStringLiteral(
"kml" ),
1737 QStringLiteral(
"UTF-8" )
1742 datasetOptions.clear();
1743 layerOptions.clear();
1745 auto insertMapInfoOptions = []( QMap<QString, QgsVectorFileWriter::Option *> &datasetOptions, QMap<QString, QgsVectorFileWriter::Option *> &layerOptions )
1748 QObject::tr(
"Use this to turn on 'quick spatial index mode'. "
1749 "In this mode writing files can be about 5 times faster, "
1750 "but spatial queries can be up to 30 times slower." ),
1752 << QStringLiteral(
"QUICK" )
1753 << QStringLiteral(
"OPTIMIZED" ),
1754 QStringLiteral(
"QUICK" ),
1759 QObject::tr(
"(multiples of 512): Block size for .map files. Defaults "
1760 "to 512. MapInfo 15.2 and above creates .tab files with a "
1761 "blocksize of 16384 bytes. Any MapInfo version should be "
1762 "able to handle block sizes from 512 to 32256." ),
1766 QObject::tr(
"xmin,ymin,xmax,ymax: Define custom layer bounds to increase the "
1767 "accuracy of the coordinates. Note: the geometry of written "
1768 "features must be within the defined box." ),
1772 insertMapInfoOptions( datasetOptions, layerOptions );
1774 driverMetadata.insert( QStringLiteral(
"MapInfo File" ),
1776 QStringLiteral(
"Mapinfo" ),
1777 QObject::tr(
"Mapinfo TAB" ),
1778 QStringLiteral(
"*.tab" ),
1779 QStringLiteral(
"tab" ),
1784 datasetOptions.clear();
1785 layerOptions.clear();
1786 insertMapInfoOptions( datasetOptions, layerOptions );
1789 driverMetadata.insert( QStringLiteral(
"MapInfo MIF" ),
1791 QStringLiteral(
"Mapinfo" ),
1792 QObject::tr(
"Mapinfo MIF" ),
1793 QStringLiteral(
"*.mif" ),
1794 QStringLiteral(
"mif" ),
1801 datasetOptions.clear();
1802 layerOptions.clear();
1805 QObject::tr(
"Determine whether 2D (seed_2d.dgn) or 3D (seed_3d.dgn) "
1806 "seed file should be used. This option is ignored if the SEED option is provided." ),
1811 QObject::tr(
"Override the seed file to use." ),
1816 QObject::tr(
"Indicate whether the whole seed file should be copied. "
1817 "If not, only the first three elements will be copied." ),
1822 QObject::tr(
"Indicates whether the color table should be copied from the seed file." ),
1827 QObject::tr(
"Override the master unit name from the seed file with "
1828 "the provided one or two character unit name." ),
1833 QObject::tr(
"Override the sub unit name from the seed file with the provided "
1834 "one or two character unit name." ),
1839 QObject::tr(
"Override the number of subunits per master unit. "
1840 "By default the seed file value is used." ),
1845 QObject::tr(
"Override the number of UORs (Units of Resolution) "
1846 "per sub unit. By default the seed file value is used." ),
1851 QObject::tr(
"ORIGIN=x,y,z: Override the origin of the design plane. "
1852 "By default the origin from the seed file is used." ),
1856 driverMetadata.insert( QStringLiteral(
"DGN" ),
1858 QStringLiteral(
"Microstation DGN" ),
1859 QObject::tr(
"Microstation DGN" ),
1860 QStringLiteral(
"*.dgn" ),
1861 QStringLiteral(
"dgn" ),
1868 datasetOptions.clear();
1869 layerOptions.clear();
1872 QObject::tr(
"Should update files be incorporated into the base data on the fly." ),
1874 << QStringLiteral(
"APPLY" )
1875 << QStringLiteral(
"IGNORE" ),
1876 QStringLiteral(
"APPLY" )
1880 QObject::tr(
"Should multipoint soundings be split into many single point sounding features. "
1881 "Multipoint geometries are not well handled by many formats, "
1882 "so it can be convenient to split single sounding features with many points "
1883 "into many single point features." ),
1888 QObject::tr(
"Should a DEPTH attribute be added on SOUNDG features and assign the depth "
1889 "of the sounding. This should only be enabled when SPLIT_MULTIPOINT is "
1895 QObject::tr(
"Should all the low level geometry primitives be returned as special "
1896 "IsolatedNode, ConnectedNode, Edge and Face layers." ),
1901 QObject::tr(
"If enabled, numeric attributes assigned an empty string as a value will "
1902 "be preserved as a special numeric value. This option should not generally "
1903 "be needed, but may be useful when translated S-57 to S-57 losslessly." ),
1908 QObject::tr(
"Should LNAM and LNAM_REFS fields be attached to features capturing "
1909 "the feature to feature relationships in the FFPT group of the S-57 file." ),
1914 QObject::tr(
"Should additional attributes relating features to their underlying "
1915 "geometric primitives be attached. These are the values of the FSPT group, "
1916 "and are primarily needed when doing S-57 to S-57 translations." ),
1921 QObject::tr(
"Should attribute values be recoded to UTF-8 from the character encoding "
1922 "specified in the S57 DSSI record." ),
1928 driverMetadata.insert( QStringLiteral(
"S57" ),
1930 QStringLiteral(
"S-57 Base file" ),
1931 QObject::tr(
"S-57 Base file" ),
1932 QStringLiteral(
"*.000" ),
1933 QStringLiteral(
"000" ),
1940 datasetOptions.clear();
1941 layerOptions.clear();
1943 driverMetadata.insert( QStringLiteral(
"SDTS" ),
1945 QStringLiteral(
"Spatial Data Transfer Standard [SDTS]" ),
1946 QObject::tr(
"Spatial Data Transfer Standard [SDTS]" ),
1947 QStringLiteral(
"*catd.ddf" ),
1948 QStringLiteral(
"ddf" ),
1955 datasetOptions.clear();
1956 layerOptions.clear();
1959 QObject::tr(
"Can be used to avoid creating the geometry_columns and spatial_ref_sys "
1960 "tables in a new database. By default these metadata tables are created "
1961 "when a new database is created." ),
1967 QStringLiteral(
"NO" )
1972 QStringLiteral(
"NO" )
1976 QObject::tr(
"Controls the format used for the geometry column. Defaults to WKB. "
1977 "This is generally more space and processing efficient, but harder "
1978 "to inspect or use in simple applications than WKT (Well Known Text)." ),
1980 << QStringLiteral(
"WKB" )
1981 << QStringLiteral(
"WKT" ),
1982 QStringLiteral(
"WKB" )
1986 QObject::tr(
"Controls whether layer and field names will be laundered for easier use "
1987 "in SQLite. Laundered names will be converted to lower case and some special "
1988 "characters(' - #) will be changed to underscores." ),
1993 QStringLiteral(
"NO" )
1997 QStringLiteral(
"NO" )
2005 QObject::tr(
"column_name1[,column_name2, …] A list of (String) columns that "
2006 "must be compressed with ZLib DEFLATE algorithm. This might be beneficial "
2007 "for databases that have big string blobs. However, use with care, since "
2008 "the value of such columns will be seen as compressed binary content with "
2009 "other SQLite utilities (or previous OGR versions). With OGR, when inserting, "
2010 "modifying or querying compressed columns, compression/decompression is "
2011 "done transparently. However, such columns cannot be (easily) queried with "
2012 "an attribute filter or WHERE clause. Note: in table definition, such columns "
2013 "have the 'VARCHAR_deflate' declaration type." ),
2017 driverMetadata.insert( QStringLiteral(
"SQLite" ),
2019 QStringLiteral(
"SQLite" ),
2020 QObject::tr(
"SQLite" ),
2021 QStringLiteral(
"*.sqlite" ),
2022 QStringLiteral(
"sqlite" ),
2025 QStringLiteral(
"UTF-8" )
2030 datasetOptions.clear();
2031 layerOptions.clear();
2034 QObject::tr(
"Can be used to avoid creating the geometry_columns and spatial_ref_sys "
2035 "tables in a new database. By default these metadata tables are created "
2036 "when a new database is created." ),
2041 QStringLiteral(
"YES" )
2045 QObject::tr(
"Insert the content of the EPSG CSV files into the spatial_ref_sys table. "
2046 "Set to NO for regular SQLite databases." ),
2051 QStringLiteral(
"SPATIALITE" )
2055 QObject::tr(
"Controls whether layer and field names will be laundered for easier use "
2056 "in SQLite. Laundered names will be converted to lower case and some special "
2057 "characters(' - #) will be changed to underscores." ),
2062 QObject::tr(
"If the database is of the SpatiaLite flavor, and if OGR is linked "
2063 "against libspatialite, this option can be used to control if a spatial "
2064 "index must be created." ),
2069 QObject::tr(
"If the format of the geometry BLOB is of the SpatiaLite flavor, "
2070 "this option can be used to control if the compressed format for "
2071 "geometries (LINESTRINGs, POLYGONs) must be used." ),
2076 QObject::tr(
"Used to force the SRID number of the SRS associated with the layer. "
2077 "When this option isn't specified and that a SRS is associated with the "
2078 "layer, a search is made in the spatial_ref_sys to find a match for the "
2079 "SRS, and, if there is no match, a new entry is inserted for the SRS in "
2080 "the spatial_ref_sys table. When the SRID option is specified, this "
2081 "search (and the eventual insertion of a new entry) will not be done: "
2082 "the specified SRID is used as such." ),
2087 QObject::tr(
"column_name1[,column_name2, …] A list of (String) columns that "
2088 "must be compressed with ZLib DEFLATE algorithm. This might be beneficial "
2089 "for databases that have big string blobs. However, use with care, since "
2090 "the value of such columns will be seen as compressed binary content with "
2091 "other SQLite utilities (or previous OGR versions). With OGR, when inserting, "
2092 "modifying or queryings compressed columns, compression/decompression is "
2093 "done transparently. However, such columns cannot be (easily) queried with "
2094 "an attribute filter or WHERE clause. Note: in table definition, such columns "
2095 "have the 'VARCHAR_deflate' declaration type." ),
2099 driverMetadata.insert( QStringLiteral(
"SpatiaLite" ),
2101 QStringLiteral(
"SpatiaLite" ),
2102 QObject::tr(
"SpatiaLite" ),
2103 QStringLiteral(
"*.sqlite" ),
2104 QStringLiteral(
"sqlite" ),
2107 QStringLiteral(
"UTF-8" )
2111 datasetOptions.clear();
2112 layerOptions.clear();
2115 QObject::tr(
"Override the header file used - in place of header.dxf." ),
2120 QObject::tr(
"Override the trailer file used - in place of trailer.dxf." ),
2124 driverMetadata.insert( QStringLiteral(
"DXF" ),
2126 QStringLiteral(
"AutoCAD DXF" ),
2127 QObject::tr(
"AutoCAD DXF" ),
2128 QStringLiteral(
"*.dxf" ),
2129 QStringLiteral(
"dxf" ),
2136 datasetOptions.clear();
2137 layerOptions.clear();
2140 QObject::tr(
"Indicates the GeoConcept export file extension. "
2141 "TXT was used by earlier releases of GeoConcept. GXT is currently used." ),
2143 << QStringLiteral(
"GXT" )
2144 << QStringLiteral(
"TXT" ),
2145 QStringLiteral(
"GXT" )
2149 QObject::tr(
"Path to the GCT: the GCT file describes the GeoConcept types definitions: "
2150 "In this file, every line must start with //# followed by a keyword. "
2151 "Lines starting with // are comments." ),
2156 QObject::tr(
"Defines the feature to be created. The TYPE corresponds to one of the Name "
2157 "found in the GCT file for a type section. The SUBTYPE corresponds to one of "
2158 "the Name found in the GCT file for a sub-type section within the previous "
2163 driverMetadata.insert( QStringLiteral(
"Geoconcept" ),
2165 QStringLiteral(
"Geoconcept" ),
2166 QObject::tr(
"Geoconcept" ),
2167 QStringLiteral(
"*.gxt *.txt" ),
2168 QStringLiteral(
"gxt" ),
2175 datasetOptions.clear();
2176 layerOptions.clear();
2178#if GDAL_VERSION_NUM >= GDAL_COMPUTE_VERSION(3,9,0)
2180 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." ),
2182 << QStringLiteral(
"ALL" )
2183 << QStringLiteral(
"ARCGIS_PRO_3_2_OR_LATER" ),
2184 QStringLiteral(
"ALL" )
2189 QObject::tr(
"When this option is set, the new layer will be created inside the named "
2190 "FeatureDataset folder. If the folder does not already exist, it will be created." ),
2195 QObject::tr(
"Set layer name alias." ),
2200 QObject::tr(
"Set name of geometry column in new layer. Defaults to 'SHAPE'." ),
2201 QStringLiteral(
"SHAPE" )
2205 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'." ),
2210 QObject::tr(
"Name of the OID column to create. Defaults to 'OBJECTID'." ),
2211 QStringLiteral(
"OBJECTID" )
2227 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." ),
2232 QObject::tr(
"XML documentation for the layer." ),
2236 QObject::tr(
"Customize how data is stored. By default text in UTF-8 and data up to 1TB." ),
2237 {QStringLiteral(
"DEFAULTS" ), QStringLiteral(
"MAX_FILE_SIZE_4GB" ), QStringLiteral(
"MAX_FILE_SIZE_256TB" )},
2238 QStringLiteral(
"DEFAULTS" ),
2243 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." ),
2247 driverMetadata.insert( QStringLiteral(
"OpenFileGDB" ),
2249 QStringLiteral(
"ESRI File Geodatabase" ),
2250 QObject::tr(
"ESRI File Geodatabase" ),
2251 QStringLiteral(
"*.gdb" ),
2252 QStringLiteral(
"gdb" ),
2255 QStringLiteral(
"UTF-8" )
2259#if GDAL_VERSION_NUM < GDAL_COMPUTE_VERSION(3,11,0)
2261 datasetOptions.clear();
2262 layerOptions.clear();
2265 QObject::tr(
"When this option is set, the new layer will be created inside the named "
2266 "FeatureDataset folder. If the folder does not already exist, it will be created." ),
2271 QObject::tr(
"Set name of geometry column in new layer. Defaults to 'SHAPE'." ),
2272 QStringLiteral(
"SHAPE" )
2276 QObject::tr(
"Name of the OID column to create. Defaults to 'OBJECTID'." ),
2277 QStringLiteral(
"OBJECTID" )
2280 driverMetadata.insert( QStringLiteral(
"FileGDB" ),
2282 QStringLiteral(
"ESRI FileGDB" ),
2283 QObject::tr(
"ESRI FileGDB" ),
2284 QStringLiteral(
"*.gdb" ),
2285 QStringLiteral(
"gdb" ),
2288 QStringLiteral(
"UTF-8" )
2294 datasetOptions.clear();
2295 layerOptions.clear();
2298 QObject::tr(
"By default, the driver will try to detect the data type of fields. If set "
2299 "to STRING, all fields will be of String type." ),
2301 << QStringLiteral(
"AUTO" )
2302 << QStringLiteral(
"STRING" ),
2303 QStringLiteral(
"AUTO" ),
2308 QObject::tr(
"By default, the driver will read the first lines of each sheet to detect "
2309 "if the first line might be the name of columns. If set to FORCE, the driver "
2310 "will consider the first line as the header line. If set to "
2311 "DISABLE, it will be considered as the first feature. Otherwise "
2312 "auto-detection will occur." ),
2314 << QStringLiteral(
"FORCE" )
2315 << QStringLiteral(
"DISABLE" )
2316 << QStringLiteral(
"AUTO" ),
2317 QStringLiteral(
"AUTO" ),
2321 driverMetadata.insert( QStringLiteral(
"XLSX" ),
2323 QStringLiteral(
"MS Office Open XML spreadsheet" ),
2324 QObject::tr(
"MS Office Open XML spreadsheet [XLSX]" ),
2325 QStringLiteral(
"*.xlsx" ),
2326 QStringLiteral(
"xlsx" ),
2329 QStringLiteral(
"UTF-8" )
2334 datasetOptions.clear();
2335 layerOptions.clear();
2338 QObject::tr(
"By default, the driver will try to detect the data type of fields. If set "
2339 "to STRING, all fields will be of String type." ),
2341 << QStringLiteral(
"AUTO" )
2342 << QStringLiteral(
"STRING" ),
2343 QStringLiteral(
"AUTO" ),
2348 QObject::tr(
"By default, the driver will read the first lines of each sheet to detect "
2349 "if the first line might be the name of columns. If set to FORCE, the driver "
2350 "will consider the first line as the header line. If set to "
2351 "DISABLE, it will be considered as the first feature. Otherwise "
2352 "auto-detection will occur." ),
2354 << QStringLiteral(
"FORCE" )
2355 << QStringLiteral(
"DISABLE" )
2356 << QStringLiteral(
"AUTO" ),
2357 QStringLiteral(
"AUTO" ),
2361 driverMetadata.insert( QStringLiteral(
"ODS" ),
2363 QStringLiteral(
"Open Document Spreadsheet" ),
2364 QObject::tr(
"Open Document Spreadsheet [ODS]" ),
2365 QStringLiteral(
"*.ods" ),
2366 QStringLiteral(
"ods" ),
2369 QStringLiteral(
"UTF-8" )
2374 datasetOptions.clear();
2375 layerOptions.clear();
2378 QObject::tr(
"Compression method." ),
2380 << QStringLiteral(
"UNCOMPRESSED" )
2381 << QStringLiteral(
"SNAPPY" ),
2382 QStringLiteral(
"SNAPPY" ),
2387 QObject::tr(
"Geometry encoding." ),
2389 << QStringLiteral(
"WKB" )
2390 << QStringLiteral(
"WKT" )
2391 << QStringLiteral(
"GEOARROW" ),
2392 QStringLiteral(
"WKB" ),
2397 QObject::tr(
"Maximum number of rows per group." ),
2402 QObject::tr(
"Name for the feature identifier column" ),
2407 QObject::tr(
"Name for the geometry column" ),
2408 QStringLiteral(
"geometry" )
2412 QObject::tr(
"Name of the coordinate system for the edges." ),
2414 << QStringLiteral(
"PLANAR" )
2415 << QStringLiteral(
"SPHERICAL" ),
2416 QStringLiteral(
"PLANAR" ),
2420 driverMetadata.insert( QStringLiteral(
"Parquet" ),
2422 QStringLiteral(
"(Geo)Parquet" ),
2423 QObject::tr(
"(Geo)Parquet" ),
2424 QStringLiteral(
"*.parquet" ),
2425 QStringLiteral(
"parquet" ),
2428 QStringLiteral(
"UTF-8" )
2433 datasetOptions.clear();
2434 layerOptions.clear();
2437 QObject::tr(
"Line termination character sequence." ),
2439 << QStringLiteral(
"CRLF" )
2440 << QStringLiteral(
"LF" ),
2441 QStringLiteral(
"LF" ),
2447 QObject::tr(
"Format of geometry columns." ),
2449 << QStringLiteral(
"geometry" )
2450 << QStringLiteral(
"geography" ),
2451 QStringLiteral(
"geometry" ),
2456 QObject::tr(
"Controls whether layer and field names will be laundered for easier use. "
2457 "Laundered names will be converted to lower case and some special "
2458 "characters(' - #) will be changed to underscores." ),
2463 QObject::tr(
"Name for the geometry column. Defaults to wkb_geometry "
2464 "for GEOM_TYPE=geometry or the_geog for GEOM_TYPE=geography" ) ) );
2467 QObject::tr(
"Name of schema into which to create the new table" ) ) );
2470 QObject::tr(
"Whether to explicitly emit the CREATE SCHEMA statement to create the specified schema." ),
2475 QObject::tr(
"Whether to explicitly recreate the table if necessary." ),
2480 QObject::tr(
"Whether to explicitly destroy tables before recreating them." ),
2482 << QStringLiteral(
"YES" )
2483 << QStringLiteral(
"NO" )
2484 << QStringLiteral(
"IF_EXISTS" ),
2485 QStringLiteral(
"YES" ),
2490 QObject::tr(
"Used to force the SRID number of the SRS associated with the layer. "
2491 "When this option isn't specified and that a SRS is associated with the "
2492 "layer, a search is made in the spatial_ref_sys to find a match for the "
2493 "SRS, and, if there is no match, a new entry is inserted for the SRS in "
2494 "the spatial_ref_sys table. When the SRID option is specified, this "
2495 "search (and the eventual insertion of a new entry) will not be done: "
2496 "the specified SRID is used as such." ),
2501 QObject::tr(
"Can be set to 2.0 or 2.2 for PostGIS 2.0/2.2 compatibility. "
2502 "Important to set it correctly if using non-linear geometry types" ),
2503 QStringLiteral(
"2.2" )
2506 driverMetadata.insert( QStringLiteral(
"PGDUMP" ),
2508 QStringLiteral(
"PostgreSQL SQL dump" ),
2509 QObject::tr(
"PostgreSQL SQL dump" ),
2510 QStringLiteral(
"*.sql" ),
2511 QStringLiteral(
"sql" ),
2514 QStringLiteral(
"UTF-8" )
2520 QgsVectorFileWriterMetadataContainer(
const QgsVectorFileWriterMetadataContainer &other ) =
delete;
2521 QgsVectorFileWriterMetadataContainer &operator=(
const QgsVectorFileWriterMetadataContainer &other ) =
delete;
2522 ~QgsVectorFileWriterMetadataContainer()
2524 for (
auto it = driverMetadata.constBegin(); it != driverMetadata.constEnd(); ++it )
2526 for (
auto optionIt = it.value().driverOptions.constBegin(); optionIt != it.value().driverOptions.constEnd(); ++optionIt )
2527 delete optionIt.value();
2528 for (
auto optionIt = it.value().layerOptions.constBegin(); optionIt != it.value().layerOptions.constEnd(); ++optionIt )
2529 delete optionIt.value();
2533 QMap<QString, QgsVectorFileWriter::MetaData> driverMetadata;
2540 static QgsVectorFileWriterMetadataContainer sDriverMetadata;
2541 QMap<QString, MetaData>::ConstIterator it = sDriverMetadata.driverMetadata.constBegin();
2543 for ( ; it != sDriverMetadata.driverMetadata.constEnd(); ++it )
2545 if ( it.key() == QLatin1String(
"PGDUMP" ) &&
2546 driverName != QLatin1String(
"PGDUMP" ) &&
2547 driverName != QLatin1String(
"PostgreSQL SQL dump" ) )
2552 if ( it.key().startsWith( driverName ) || it.value().longName.startsWith( driverName ) )
2567 return QStringList();
2576 return QStringList();
2583 OGRwkbGeometryType ogrType =
static_cast<OGRwkbGeometryType
>( type );
2614 return mCapabilities;
2624 QgsFeatureList::iterator fIt = features.begin();
2626 for ( ; fIt != features.end(); ++fIt )
2651 QString styleString;
2652 QString currentStyle;
2654 QgsSymbolList::const_iterator symbolIt = symbols.constBegin();
2655 for ( ; symbolIt != symbols.constEnd(); ++symbolIt )
2657 int nSymbolLayers = ( *symbolIt )->symbolLayerCount();
2658 for (
int i = 0; i < nSymbolLayers; ++i )
2661 QMap< QgsSymbolLayer *, QString >::const_iterator it =
mSymbolLayerTable.find( ( *symbolIt )->symbolLayer( i ) );
2667 double mmsf = mmScaleFactor(
mSymbologyScale, ( *symbolIt )->outputUnit(), outputUnit );
2668 double musf = mapUnitScaleFactor(
mSymbologyScale, ( *symbolIt )->outputUnit(), outputUnit );
2670 currentStyle = ( *symbolIt )->symbolLayer( i )->ogrFeatureStyle( mmsf, musf );
2676 if ( symbolIt != symbols.constBegin() || i != 0 )
2678 styleString.append(
';' );
2680 styleString.append( currentStyle );
2685 OGR_F_SetStyleString( poFeature.get(), currentStyle.toLocal8Bit().constData() );
2686 if ( !writeFeature(
mLayer, poFeature.get() ) )
2698 OGR_F_SetStyleString( poFeature.get(), styleString.toLocal8Bit().constData() );
2706 if ( !writeFeature(
mLayer, poFeature.get() ) )
2730 int fldIdx = it.key();
2731 int ogrField = it.value();
2733 QVariant attrValue = feature.
attribute( fldIdx );
2738 OGR_F_UnsetField( poFeature.get(), ogrField );
2751 OGR_F_SetFieldNull( poFeature.get(), ogrField );
2766 mErrorMessage = QObject::tr(
"Error converting value (%1) for attribute field %2: %3" )
2767 .arg( feature.
attribute( fldIdx ).toString(),
2774 switch ( field.
type() )
2776 case QMetaType::Type::Int:
2777 OGR_F_SetFieldInteger( poFeature.get(), ogrField, attrValue.toInt() );
2779 case QMetaType::Type::LongLong:
2780 OGR_F_SetFieldInteger64( poFeature.get(), ogrField, attrValue.toLongLong() );
2782 case QMetaType::Type::Bool:
2783 OGR_F_SetFieldInteger( poFeature.get(), ogrField, attrValue.toInt() );
2785 case QMetaType::Type::QString:
2786 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( attrValue.toString() ).constData() );
2788 case QMetaType::Type::Double:
2789 OGR_F_SetFieldDouble( poFeature.get(), ogrField, attrValue.toDouble() );
2791 case QMetaType::Type::QDate:
2792 OGR_F_SetFieldDateTime( poFeature.get(), ogrField,
2793 attrValue.toDate().year(),
2794 attrValue.toDate().month(),
2795 attrValue.toDate().day(),
2798 case QMetaType::Type::QDateTime:
2801 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( attrValue.toDateTime().toString( QStringLiteral(
"yyyy/MM/dd hh:mm:ss.zzz" ) ) ).constData() );
2805 const QDateTime dt = attrValue.toDateTime();
2806 const QDate date = dt.date();
2807 const QTime time = dt.time();
2808 OGR_F_SetFieldDateTimeEx( poFeature.get(), ogrField,
2814 static_cast<float>( time.second() +
static_cast< double >( time.msec() ) / 1000 ),
2818 case QMetaType::Type::QTime:
2821 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( attrValue.toString() ).constData() );
2825 const QTime time = attrValue.toTime();
2826 OGR_F_SetFieldDateTimeEx( poFeature.get(), ogrField,
2830 static_cast<float>( time.second() +
static_cast< double >( time.msec() ) / 1000 ),
2835 case QMetaType::Type::QByteArray:
2837 const QByteArray ba = attrValue.toByteArray();
2838 OGR_F_SetFieldBinary( poFeature.get(), ogrField, ba.size(),
const_cast< GByte *
>(
reinterpret_cast< const GByte *
>( ba.data() ) ) );
2842 case QMetaType::Type::UnknownType:
2845 case QMetaType::Type::QStringList:
2850 const QJsonDocument doc = QJsonDocument::fromVariant( attrValue );
2852 if ( !doc.isNull() )
2854 jsonString = QString::fromUtf8( doc.toJson( QJsonDocument::Compact ).constData() );
2856 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( jsonString.constData() ) );
2860 QStringList list = attrValue.toStringList();
2861 if ( mSupportedListSubTypes.contains( QMetaType::Type::QString ) )
2863 int count = list.count();
2864 char **lst =
new char *[count + 1];
2868 for (
const QString &
string : list )
2870 lst[pos] = CPLStrdup(
mCodec->fromUnicode(
string ).data() );
2874 lst[count] =
nullptr;
2875 OGR_F_SetFieldStringList( poFeature.get(), ogrField, lst );
2880 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( list.join(
',' ) ).constData() );
2885 case QMetaType::Type::QVariantList:
2889 const QJsonDocument doc = QJsonDocument::fromVariant( attrValue );
2891 if ( !doc.isNull() )
2893 jsonString = QString::fromUtf8( doc.toJson( QJsonDocument::Compact ).data() );
2895 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( jsonString.constData() ) );
2900 if ( field.
subType() == QMetaType::Type::QString )
2902 QStringList list = attrValue.toStringList();
2903 if ( mSupportedListSubTypes.contains( QMetaType::Type::QString ) )
2905 int count = list.count();
2906 char **lst =
new char *[count + 1];
2910 for (
const QString &
string : list )
2912 lst[pos] = CPLStrdup(
mCodec->fromUnicode(
string ).data() );
2916 lst[count] =
nullptr;
2917 OGR_F_SetFieldStringList( poFeature.get(), ogrField, lst );
2922 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( list.join(
',' ) ).constData() );
2926 else if ( field.
subType() == QMetaType::Type::Int )
2928 const QVariantList list = attrValue.toList();
2929 if ( mSupportedListSubTypes.contains( QMetaType::Type::Int ) )
2931 const int count = list.count();
2932 int *lst =
new int[count];
2936 for (
const QVariant &value : list )
2938 lst[pos] = value.toInt();
2942 OGR_F_SetFieldIntegerList( poFeature.get(), ogrField, count, lst );
2947 QStringList strings;
2948 strings.reserve( list.size() );
2949 for (
const QVariant &value : list )
2951 strings << QString::number( value.toInt() );
2953 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( strings.join(
',' ) ).constData() );
2957 else if ( field.
subType() == QMetaType::Type::Double )
2959 const QVariantList list = attrValue.toList();
2960 if ( mSupportedListSubTypes.contains( QMetaType::Type::Double ) )
2962 const int count = list.count();
2963 double *lst =
new double[count];
2967 for (
const QVariant &value : list )
2969 lst[pos] = value.toDouble();
2973 OGR_F_SetFieldDoubleList( poFeature.get(), ogrField, count, lst );
2978 QStringList strings;
2979 strings.reserve( list.size() );
2980 for (
const QVariant &value : list )
2982 strings << QString::number( value.toDouble() );
2984 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( strings.join(
',' ) ).constData() );
2988 else if ( field.
subType() == QMetaType::Type::LongLong )
2990 const QVariantList list = attrValue.toList();
2991 if ( mSupportedListSubTypes.contains( QMetaType::Type::LongLong ) )
2993 const int count = list.count();
2994 long long *lst =
new long long[count];
2998 for (
const QVariant &value : list )
3000 lst[pos] = value.toLongLong();
3004 OGR_F_SetFieldInteger64List( poFeature.get(), ogrField, count, lst );
3009 QStringList strings;
3010 strings.reserve( list.size() );
3011 for (
const QVariant &value : list )
3013 strings << QString::number( value.toLongLong() );
3015 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( strings.join(
',' ) ).constData() );
3022 case QMetaType::Type::QVariantMap:
3025 const char *pszDataSubTypes = GDALGetMetadataItem( OGRGetDriverByName(
mOgrDriverName.toLocal8Bit().constData() ), GDAL_DMD_CREATIONFIELDDATASUBTYPES,
nullptr );
3026 if ( pszDataSubTypes && strstr( pszDataSubTypes,
"JSON" ) )
3028 const QJsonDocument doc = QJsonDocument::fromVariant( attrValue );
3030 if ( !doc.isNull() )
3032 const QByteArray json { doc.toJson( QJsonDocument::Compact ) };
3033 jsonString = QString::fromUtf8( json.data() );
3035 OGR_F_SetFieldString( poFeature.get(), ogrField,
mCodec->fromUnicode( jsonString.constData() ) );
3045 mErrorMessage = QObject::tr(
"Invalid variant type for field %1[%2]: received %3 with type %4" )
3048 .arg( attrValue.typeName(),
3049 attrValue.toString() );
3062 if ( mCoordinateTransform )
3067 geom.
transform( *mCoordinateTransform );
3085 OGRGeometryH mGeom2 =
nullptr;
3114 geom.
get()->
addZValue( std::numeric_limits<double>::quiet_NaN() );
3121 geom.
get()->
addMValue( std::numeric_limits<double>::quiet_NaN() );
3141 mErrorMessage = QObject::tr(
"Feature geometry not imported (OGR error: %1)" )
3142 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3152 QByteArray wkb( geom.
asWkb( wkbFlags ) );
3153 OGRErr err = OGR_G_ImportFromWkb( mGeom2,
reinterpret_cast<unsigned char *
>(
const_cast<char *
>( wkb.constData() ) ), wkb.length() );
3154 if ( err != OGRERR_NONE )
3156 mErrorMessage = QObject::tr(
"Feature geometry not imported (OGR error: %1)" )
3157 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3164 OGR_F_SetGeometryDirectly( poFeature.get(), mGeom2 );
3172 QByteArray wkb( geom.
asWkb( wkbFlags ) );
3174 OGRErr err = OGR_G_ImportFromWkb( ogrGeom,
reinterpret_cast<unsigned char *
>(
const_cast<char *
>( wkb.constData() ) ), wkb.length() );
3175 if ( err != OGRERR_NONE )
3177 mErrorMessage = QObject::tr(
"Feature geometry not imported (OGR error: %1)" )
3178 .arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3185 OGR_F_SetGeometryDirectly( poFeature.get(), ogrGeom );
3200 for (
int i = 0; i < attributes.size(); i++ )
3202 if ( omap.find( i ) != omap.end() )
3207bool QgsVectorFileWriter::writeFeature( OGRLayerH layer, OGRFeatureH feature )
3209 if ( OGR_L_CreateFeature( layer, feature ) != OGRERR_NONE )
3211 mErrorMessage = QObject::tr(
"Feature creation error (OGR error: %1)" ).arg( QString::fromUtf8( CPLGetLastErrorMsg() ) );
3221 if ( mUsingTransaction )
3223 if ( OGRERR_NONE != OGR_L_CommitTransaction(
mLayer ) )
3225 QgsDebugError( QStringLiteral(
"Error while committing transaction on OGRLayer." ) );
3238 const QString &fileName,
3239 const QString &fileEncoding,
3241 const QString &driverName,
3243 QString *errorMessage,
3244 const QStringList &datasourceOptions,
3245 const QStringList &layerOptions,
3246 bool skipAttributeCreation,
3247 QString *newFilename,
3249 double symbologyScale,
3259 if ( destCRS.
isValid() && layer )
3285 const QString &fileName,
3286 const QString &fileEncoding,
3288 const QString &driverName,
3290 QString *errorMessage,
3291 const QStringList &datasourceOptions,
3292 const QStringList &layerOptions,
3293 bool skipAttributeCreation,
3294 QString *newFilename,
3296 double symbologyScale,
3327 : driverName( QStringLiteral(
"GPKG" ) )
3335 if ( !layer || !layer->
isValid() )
3342 details.sourceCrs = layer->
crs();
3343 details.sourceWkbType = layer->
wkbType();
3344 details.sourceFields = layer->
fields();
3353 if ( details.storageType == QLatin1String(
"ESRI Shapefile" ) )
3361 details.geometryTypeScanIterator = layer->
getFeatures( req );
3365 details.renderContext.setExpressionContext( details.expressionContext );
3366 details.renderContext.setRendererScale( options.
symbologyScale );
3368 details.shallTransform =
false;
3373 details.shallTransform =
true;
3378 details.outputCrs = details.sourceCrs;
3381 details.destWkbType = details.sourceWkbType;
3395 details.attributes.clear();
3396 else if ( details.attributes.isEmpty() )
3398 const QgsAttributeList allAttributes = details.sourceFields.allAttributesList();
3399 for (
int idx : allAttributes )
3401 QgsField fld = details.sourceFields.at( idx );
3402 if ( details.providerType == QLatin1String(
"oracle" ) && fld.
typeName().contains( QLatin1String(
"SDO_GEOMETRY" ) ) )
3404 details.attributes.append( idx );
3408 if ( !details.attributes.isEmpty() )
3410 for (
int attrIdx : std::as_const( details.attributes ) )
3412 if ( details.sourceFields.exists( attrIdx ) )
3414 QgsField field = details.sourceFields.at( attrIdx );
3416 details.outputFields.append( field );
3420 QgsDebugError( QStringLiteral(
"No such source field with index '%1' available." ).arg( attrIdx ) );
3427 if ( details.providerType == QLatin1String(
"spatialite" ) )
3429 for (
int i = 0; i < details.outputFields.size(); i++ )
3431 if ( details.outputFields.at( i ).type() == QMetaType::Type::LongLong )
3436 if ( std::max( std::llabs( min.toLongLong() ), std::llabs( max.toLongLong() ) ) < std::numeric_limits<int>::max() )
3438 details.outputFields[i].setType( QMetaType::Type::Int );
3446 addRendererAttributes( details.renderer.get(), details.renderContext, details.sourceFields, details.attributes );
3456 bool useFilterRect =
true;
3457 if ( details.shallTransform )
3468 useFilterRect =
false;
3471 if ( useFilterRect )
3477 details.filterRectEngine->prepareGeometry();
3479 details.sourceFeatureIterator = layer->
getFeatures( req );
3498 int lastProgressReport = 0;
3499 long long total = details.featureCount;
3502 if ( details.providerType == QLatin1String(
"ogr" ) && !details.dataSourceUri.isEmpty() )
3504 QString srcFileName( details.providerUriParams.value( QStringLiteral(
"path" ) ).toString() );
3505 if ( QFile::exists( srcFileName ) && QFileInfo( fileName ).canonicalFilePath() == QFileInfo( srcFileName ).canonicalFilePath() )
3509 if ( !( ( options.
driverName == QLatin1String(
"GPKG" ) ||
3510 options.
driverName == QLatin1String(
"SpatiaLite" ) ||
3511 options.
driverName == QLatin1String(
"SQLite" ) ) &&
3512 options.
layerName != details.providerUriParams.value( QStringLiteral(
"layerName" ) ) ) )
3515 *
errorMessage = QObject::tr(
"Cannot overwrite an OGR layer in place" );
3535 int newProgress =
static_cast<int>( ( 5.0 * scanned ) / total );
3536 if ( newProgress != lastProgressReport )
3538 lastProgressReport = newProgress;
3553 QString tempNewFilename;
3554 QString tempNewLayer;
3562 std::unique_ptr< QgsVectorFileWriter > writer(
create( fileName, details.outputFields, destWkbType, details.outputCrs, transformContext, newOptions, sinkFlags, &tempNewFilename, &tempNewLayer ) );
3566 *newFilename = tempNewFilename;
3569 *newLayer = tempNewLayer;
3598 switch ( writer->symbologyExport() )
3616 int n = 0, errors = 0;
3625 writer->startRender( details.renderer.get(), details.sourceFields );
3627 writer->resetMap( details.attributes );
3629 writer->mFields = details.sourceFields;
3633 int initialProgress = lastProgressReport;
3634 while ( details.sourceFeatureIterator.nextFeature( fet ) )
3645 int newProgress =
static_cast<int>( initialProgress + ( ( 100.0 - initialProgress ) * saved ) / total );
3646 if ( newProgress < 100 && newProgress != lastProgressReport )
3648 lastProgressReport = newProgress;
3653 if ( details.shallTransform )
3666 const QString msg = QObject::tr(
"Failed to transform feature with ID '%1'. Writing stopped. (Exception: %2)" )
3667 .arg( fet.
id() ).arg( e.
what() );
3684 if ( !writer->addFeatureWithStyle( fet, writer->mRenderer.get(), mapUnits ) )
3691 *
errorMessage = QObject::tr(
"Feature write errors:" );
3697 if ( errors > 1000 )
3701 *
errorMessage += QObject::tr(
"Stopping after %n error(s)",
nullptr, errors );
3711 writer->stopRender();
3715 *
errorMessage += QObject::tr(
"\nOnly %1 of %2 features written." ).arg( n - errors ).arg( n );
3720 bool metadataFailure =
false;
3725 {QStringLiteral(
"path" ), tempNewFilename },
3726 {QStringLiteral(
"layerName" ), tempNewLayer }
3740 metadataFailure =
true;
3751 metadataFailure =
true;
3759 const QString &fileName,
3761 QString *newFilename,
3765 QgsVectorFileWriter::PreparedWriterDetails details;
3766 WriterError err = prepareWriteAsVectorFormat( layer, options, details );
3774 const QString &fileName,
3777 QString *newFilename,
3781 QgsVectorFileWriter::PreparedWriterDetails details;
3782 WriterError err = prepareWriteAsVectorFormat( layer, options, details );
3791 QgsVectorFileWriter::PreparedWriterDetails details;
3792 WriterError err = prepareWriteAsVectorFormat( layer, options, details );
3801 QFileInfo fi( fileName );
3802 QDir dir = fi.dir();
3805 for (
const char *suffix : {
".shp",
".shx",
".dbf",
".prj",
".qix",
".qpj",
".cpg",
".sbn",
".sbx",
".idm",
".ind" } )
3807 filter << fi.completeBaseName() + suffix;
3811 const auto constEntryList = dir.entryList( filter );
3812 for (
const QString &file : constEntryList )
3814 QFile f( dir.canonicalPath() +
'/' + file );
3817 QgsDebugError( QStringLiteral(
"Removing file %1 failed: %2" ).arg( file, f.errorString() ) );
3833 QStringList driverNames;
3836 for (
int i = 0; i < GDALGetDriverCount(); ++i )
3838 GDALDriverH
driver = GDALGetDriver( i );
3845 const QString driverExtensions = GDALGetMetadataItem(
driver, GDAL_DMD_EXTENSIONS,
"" );
3846 if ( driverExtensions.isEmpty() )
3849 const QSet< QString > splitExtensions = qgis::listToSet( driverExtensions.split(
' ', Qt::SkipEmptyParts ) );
3850 if ( splitExtensions.intersects( multiLayerExtensions ) )
3852 driverNames << GDALGetDescription(
driver );
3860 static QReadWriteLock sFilterLock;
3861 static QMap< VectorFormatOptions, QList< QgsVectorFileWriter::FilterFormatDetails > > sFilters;
3865 const auto it = sFilters.constFind( options );
3866 if ( it != sFilters.constEnd() )
3870 QList< QgsVectorFileWriter::FilterFormatDetails > results;
3873 int const drvCount = OGRGetDriverCount();
3877 for (
int i = 0; i < drvCount; ++i )
3879 OGRSFDriverH drv = OGRGetDriver( i );
3882 const QString drvName = GDALGetDescription( drv );
3886 if ( !multiLayerDrivers.contains( drvName ) )
3890 GDALDriverH gdalDriver = GDALGetDriverByName( drvName.toLocal8Bit().constData() );
3891 bool nonSpatialFormat =
false;
3894 nonSpatialFormat = GDALGetMetadataItem( gdalDriver, GDAL_DCAP_NONSPATIAL,
nullptr );
3897 if ( OGR_Dr_TestCapability( drv,
"CreateDataSource" ) != 0 )
3902 if ( nonSpatialFormat )
3907 if ( filterString.isEmpty() )
3914 globs = metadata.
glob.toLower().split(
' ' );
3920 details.
globs = globs;
3929 if ( options & SortRecommended )
3931 if ( a.driverName == QLatin1String(
"GPKG" ) )
3933 else if ( b.driverName == QLatin1String(
"GPKG" ) )
3935 else if ( a.driverName == QLatin1String(
"ESRI Shapefile" ) )
3937 else if ( b.driverName == QLatin1String(
"ESRI Shapefile" ) )
3944 sFilters.insert( options, results );
3951 QSet< QString > extensions;
3953 const thread_local QRegularExpression rx( QStringLiteral(
"\\*\\.(.*)$" ) );
3957 for (
const QString &glob : format.globs )
3959 const QRegularExpressionMatch match = rx.match( glob );
3960 if ( !match.hasMatch() )
3963 const QString matched = match.captured( 1 );
3964 extensions.insert( matched );
3968 QStringList extensionList( extensions.constBegin(), extensions.constEnd() );
3970 std::sort( extensionList.begin(), extensionList.end(), [options](
const QString & a,
const QString & b ) ->
bool
3972 if ( options & SortRecommended )
3974 if ( a == QLatin1String(
"gpkg" ) )
3976 else if ( b == QLatin1String(
"gpkg" ) )
3978 else if ( a == QLatin1String(
"shp" ) )
3980 else if ( b == QLatin1String(
"shp" ) )
3984 return a.toLower().localeAwareCompare( b.toLower() ) < 0;
3987 return extensionList;
3992 QList< QgsVectorFileWriter::DriverDetails > results;
3995 const int drvCount = OGRGetDriverCount();
3999 QStringList writableDrivers;
4000 for (
int i = 0; i < drvCount; ++i )
4002 OGRSFDriverH drv = OGRGetDriver( i );
4005 const QString drvName = GDALGetDescription( drv );
4009 if ( !multiLayerDrivers.contains( drvName ) )
4017 if ( drvName == QLatin1String(
"ODS" ) || drvName == QLatin1String(
"XLSX" ) || drvName == QLatin1String(
"XLS" ) )
4021 if ( drvName == QLatin1String(
"ESRI Shapefile" ) )
4023 writableDrivers << QStringLiteral(
"DBF file" );
4025 if ( OGR_Dr_TestCapability( drv,
"CreateDataSource" ) != 0 )
4028 if ( drvName == QLatin1String(
"MapInfo File" ) )
4030 writableDrivers << QStringLiteral(
"MapInfo MIF" );
4032 else if ( drvName == QLatin1String(
"SQLite" ) )
4039 QString option = QStringLiteral(
"SPATIALITE=YES" );
4040 char *options[2] = { CPLStrdup( option.toLocal8Bit().constData() ),
nullptr };
4041 OGRSFDriverH poDriver;
4043 poDriver = OGRGetDriverByName( drvName.toLocal8Bit().constData() );
4046 gdal::ogr_datasource_unique_ptr ds( OGR_Dr_CreateDataSource( poDriver, QStringLiteral(
"/vsimem/spatialitetest.sqlite" ).toUtf8().constData(), options ) );
4049 writableDrivers << QStringLiteral(
"SpatiaLite" );
4050 OGR_Dr_DeleteDataSource( poDriver, QStringLiteral(
"/vsimem/spatialitetest.sqlite" ).toUtf8().constData() );
4053 CPLFree( options[0] );
4055 writableDrivers << drvName;
4060 results.reserve( writableDrivers.count() );
4061 for (
const QString &drvName : std::as_const( writableDrivers ) )
4075 if ( options & SortRecommended )
4077 if ( a.driverName == QLatin1String(
"GPKG" ) )
4079 else if ( b.driverName == QLatin1String(
"GPKG" ) )
4081 else if ( a.driverName == QLatin1String(
"ESRI Shapefile" ) )
4083 else if ( b.driverName == QLatin1String(
"ESRI Shapefile" ) )
4087 return a.
longName.toLower().localeAwareCompare( b.
longName.toLower() ) < 0;
4094 QString ext = extension.trimmed();
4095 if ( ext.isEmpty() )
4098 if ( ext.startsWith(
'.' ) )
4102 int const drvCount = GDALGetDriverCount();
4104 for (
int i = 0; i < drvCount; ++i )
4106 GDALDriverH drv = GDALGetDriver( i );
4112 QString drvName = GDALGetDriverShortName( drv );
4113 QStringList driverExtensions = QString( GDALGetMetadataItem( drv, GDAL_DMD_EXTENSIONS,
nullptr ) ).split(
' ' );
4115 const auto constDriverExtensions = driverExtensions;
4116 for (
const QString &
driver : constDriverExtensions )
4118 if (
driver.compare( ext, Qt::CaseInsensitive ) == 0 )
4129 QString filterString;
4133 if ( !filterString.isEmpty() )
4134 filterString += QLatin1String(
";;" );
4136 filterString += details.filterString;
4138 return filterString;
4147 return QStringLiteral(
"%1 (%2 %3)" ).arg( metadata.
trLongName,
4148 metadata.
glob.toLower(),
4149 metadata.
glob.toUpper() );
4154 if ( codecName == QLatin1String(
"System" ) )
4155 return QStringLiteral(
"LDID/0" );
4157 const thread_local QRegularExpression re( QRegularExpression::anchoredPattern( QString(
"(CP|windows-|ISO[ -])(.+)" ) ), QRegularExpression::CaseInsensitiveOption );
4158 const QRegularExpressionMatch match = re.match( codecName );
4159 if ( match.hasMatch() )
4161 QString
c = match.captured( 2 ).remove(
'-' );
4163 ( void )
c.toInt( &isNumber );
4191 OGRStyleTableH ogrStyleTable = OGR_STBL_Create();
4192 OGRStyleMgrH styleManager = OGR_SM_Create( ogrStyleTable );
4195 int nTotalLevels = 0;
4197 QgsSymbolList::iterator symbolIt = symbolList.begin();
4198 for ( ; symbolIt != symbolList.end(); ++symbolIt )
4200 double mmsf = mmScaleFactor(
mSymbologyScale, ( *symbolIt )->outputUnit(), mapUnits );
4201 double musf = mapUnitScaleFactor(
mSymbologyScale, ( *symbolIt )->outputUnit(), mapUnits );
4203 int nLevels = ( *symbolIt )->symbolLayerCount();
4204 for (
int i = 0; i < nLevels; ++i )
4206 mSymbolLayerTable.insert( ( *symbolIt )->symbolLayer( i ), QString::number( nTotalLevels ) );
4207 OGR_SM_AddStyle( styleManager, QString::number( nTotalLevels ).toLocal8Bit(),
4208 ( *symbolIt )->symbolLayer( i )->ogrFeatureStyle( mmsf, musf ).toLocal8Bit() );
4212 OGR_DS_SetStyleTableDirectly( ds, ogrStyleTable );
4218 if ( !details.renderer )
4223 QHash< QgsSymbol *, QList<QgsFeature> > features;
4232 startRender( details.renderer.get(), details.sourceFields );
4252 QString msg = QObject::tr(
"Failed to transform, writing stopped. (Exception: %1)" )
4263 featureSymbol = mRenderer->symbolForFeature( fet, mRenderContext );
4264 if ( !featureSymbol )
4269 QHash< QgsSymbol *, QList<QgsFeature> >::iterator it = features.find( featureSymbol );
4270 if ( it == features.end() )
4272 it = features.insert( featureSymbol, QList<QgsFeature>() );
4274 it.value().append( fet );
4279 QgsSymbolList symbols = mRenderer->symbols( mRenderContext );
4280 for (
int i = 0; i < symbols.count(); i++ )
4286 if ( level < 0 || level >= 1000 )
4289 while ( level >= levels.count() )
4291 levels[level].append( item );
4296 int nTotalFeatures = 0;
4299 for (
int l = 0; l < levels.count(); l++ )
4302 for (
int i = 0; i < level.count(); i++ )
4305 QHash< QgsSymbol *, QList<QgsFeature> >::iterator levelIt = features.find( item.
symbol() );
4306 if ( levelIt == features.end() )
4312 double mmsf = mmScaleFactor(
mSymbologyScale, levelIt.key()->outputUnit(), mapUnits );
4313 double musf = mapUnitScaleFactor(
mSymbologyScale, levelIt.key()->outputUnit(), mapUnits );
4315 int llayer = item.
layer();
4316 QList<QgsFeature> &featureList = levelIt.value();
4317 QList<QgsFeature>::iterator featureIt = featureList.begin();
4318 for ( ; featureIt != featureList.end(); ++featureIt )
4328 QString styleString = levelIt.key()->symbolLayer( llayer )->ogrFeatureStyle( mmsf, musf );
4329 if ( !styleString.isEmpty() )
4331 OGR_F_SetStyleString( ogrFeature.get(), styleString.toLocal8Bit().constData() );
4332 if ( !writeFeature(
mLayer, ogrFeature.get() ) )
4345 *
errorMessage += QObject::tr(
"\nOnly %1 of %2 features written." ).arg( nTotalFeatures - nErrors ).arg( nTotalFeatures );
4362 return 1000 / scale;
4379 return scale / 1000;
4387 mRenderer = createSymbologyRenderer( sourceRenderer );
4393 mRenderer->startRender( mRenderContext, fields );
4396void QgsVectorFileWriter::stopRender()
4403 mRenderer->stopRender( mRenderContext );
4406std::unique_ptr<QgsFeatureRenderer> QgsVectorFileWriter::createSymbologyRenderer(
QgsFeatureRenderer *sourceRenderer )
const
4419 if ( !sourceRenderer )
4424 return std::unique_ptr< QgsFeatureRenderer >( sourceRenderer->
clone() );
4431 const QSet<QString> rendererAttributes = renderer->
usedAttributes( context );
4432 for (
const QString &attr : rendererAttributes )
4437 attList.append( index );
4443QStringList QgsVectorFileWriter::concatenateOptions(
const QMap<QString, QgsVectorFileWriter::Option *> &options )
4446 QMap<QString, QgsVectorFileWriter::Option *>::ConstIterator it;
4448 for ( it = options.constBegin(); it != options.constEnd(); ++it )
4451 switch ( option->
type )
4458 list.append( QStringLiteral(
"%1=%2" ).arg( it.key() ).arg( opt->
defaultValue ) );
4468 list.append( QStringLiteral(
"%1=%2" ).arg( it.key(), opt->
defaultValue ) );
4478 list.append( QStringLiteral(
"%1=%2" ).arg( it.key(), opt->
defaultValue ) );
4485 if ( opt && !opt->
mValue.isEmpty() )
4487 list.append( QStringLiteral(
"%1=%2" ).arg( it.key(), opt->
mValue ) );
4498 OGRSFDriverH hDriver =
nullptr;
4502 const QString drvName = GDALGetDescription( hDriver );
4504 if ( OGR_DS_TestCapability( hDS.get(), ODsCCreateLayer ) )
4509 if ( !( drvName == QLatin1String(
"ESRI Shapefile" ) && QFile::exists( datasetName ) ) )
4512 if ( OGR_DS_TestCapability( hDS.get(), ODsCDeleteLayer ) )
4516 int layer_count = OGR_DS_GetLayerCount( hDS.get() );
4519 OGRLayerH hLayer = OGR_DS_GetLayer( hDS.get(), 0 );
4522 if ( OGR_L_TestCapability( hLayer, OLCSequentialWrite ) )
4525 if ( OGR_L_TestCapability( hLayer, OLCCreateField ) )
4536 const QString &layerNameIn )
4538 OGRSFDriverH hDriver =
nullptr;
4543 QString layerName( layerNameIn );
4544 if ( layerName.isEmpty() )
4545 layerName = QFileInfo( datasetName ).baseName();
4547 return OGR_DS_GetLayerByName( hDS.get(), layerName.toUtf8().constData() );
4552 const QString &layerName,
4556 OGRSFDriverH hDriver =
nullptr;
4560 OGRLayerH hLayer = OGR_DS_GetLayerByName( hDS.get(), layerName.toUtf8().constData() );
4566 OGRFeatureDefnH defn = OGR_L_GetLayerDefn( hLayer );
4567 const auto constAttributes = attributes;
4568 for (
int idx : constAttributes )
4571 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)
Provides common functionality for database based connections.
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.
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.
Stores the component parts of a 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.
Wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFilterFids(const QgsFeatureIds &fids)
Sets the feature IDs that should be fetched.
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
QgsFeatureRequest & setNoAttributes()
Set that no attributes will be fetched.
QgsFeatureRequest & setFilterRect(const QgsRectangle &rectangle)
Sets the rectangle from which features will be taken.
QFlags< SinkFlag > SinkFlags
@ RegeneratePrimaryKey
This flag indicates, that a primary key field cannot be guaranteed to be unique and the sink should i...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
void initAttributes(int fieldCount)
Initialize this feature with the given number of fields.
bool hasGeometry() const
Returns true if the feature has an associated geometry.
bool isUnsetValue(int fieldIdx) const
Returns true if the attribute at the specified index is an unset value.
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
bool isCanceled() const
Tells whether the operation has been canceled already.
void setProgress(double progress)
Sets the current progress for the feedback object.
QString domainName() const
Returns the associated field domain name, for providers which support field domains.
@ ConstraintNotNull
Field may not be null.
@ ConstraintUnique
Field must have a unique value.
Encapsulate a field in an attribute table or data source.
QString typeName() const
Gets the field type.
bool convertCompatible(QVariant &v, QString *errorMessage=nullptr) const
Converts the provided variant to a compatible format.
void setName(const QString &name)
Set the field name.
QMetaType::Type subType() const
If the field is a collection, gets its element's type.
QgsFieldConstraints constraints
Container of fields for a vector layer.
int size() const
Returns number of items.
void clear()
Removes all fields.
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
static QStringList multiLayerFileExtensions()
Returns a list of file extensions which potentially contain multiple layers representing GDAL raster ...
A geometry is the spatial representation of a feature.
static QgsGeometry fromRect(const QgsRectangle &rect)
Creates a new geometry from a QgsRectangle.
Qgis::GeometryOperationResult transform(const QgsCoordinateTransform &ct, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward, bool transformZ=false)
Transforms this geometry as described by the coordinate transform ct.
QgsAbstractGeometry * get()
Returns a modifiable (non-const) reference to the underlying abstract geometry primitive.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
bool convertToMultiType()
Converts single type geometry into multitype geometry e.g.
QByteArray asWkb(QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const
Export the geometry to WKB.
Qgis::WkbType wkbType() const
Returns type of the geometry as a WKB type (point / linestring / polygon etc.)
static QgsGeometryEngine * createGeometryEngine(const QgsAbstractGeometry *geometry, double precision=0.0, Qgis::GeosCreationFlags flags=Qgis::GeosCreationFlag::SkipEmptyInteriorRings)
Creates and returns a new geometry engine representing the specified geometry using precision on a gr...
Sets the current locale to the c locale for the lifetime of the object.
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, const char *file=__builtin_FILE(), const char *function=__builtin_FUNCTION(), int line=__builtin_LINE())
Adds a message to the log instance (and creates it if necessary).
Custom exception class which is raised when an operation is not supported.
static OGRSpatialReferenceH crsToOGRSpatialReference(const QgsCoordinateReferenceSystem &crs)
Returns a OGRSpatialReferenceH corresponding to the specified crs object.
static std::unique_ptr< QgsFieldDomain > convertFieldDomain(OGRFieldDomainH domain)
Converts an OGR field domain definition to a QgsFieldDomain equivalent.
static int OGRTZFlagFromQt(const QDateTime &datetime)
Gets the value of OGRField::Date::TZFlag from the timezone of a QDateTime.
Custom exception class for provider connection related exceptions.
QVariantMap decodeUri(const QString &providerKey, const QString &uri)
Breaks a provider data source URI into its component paths (e.g.
static QgsProviderRegistry * instance(const QString &pluginPath=QString())
Means of accessing canonical single instance.
QString encodeUri(const QString &providerKey, const QVariantMap &parts)
Reassembles a provider data source URI from its component paths (e.g.
bool saveLayerMetadata(const QString &providerKey, const QString &uri, const QgsLayerMetadata &metadata, QString &errorMessage)
Saves metadata to the layer corresponding to the specified uri.
A convenience class that simplifies locking and unlocking QReadWriteLocks.
void changeMode(Mode mode)
Change the mode of the lock to mode.
A rectangle specified with double values.
Contains information about the context of a rendering operation.
QgsExpressionContext & expressionContext()
Gets the expression context.
void setRendererScale(double scale)
Sets the renderer map scale.
Stores settings for use within QGIS.
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
int renderingPass() const
Specifies the rendering pass in which this symbol layer should be rendered.
Represents a symbol level during vector rendering operations.
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.
An available option for configuring file writing for a particular output format, presenting an boolea...
Interface to convert raw field values to their user-friendly values.
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.
A hidden option for file writing for a particular output format.
An available option for configuring file writing for a particular output format, presenting an intege...
Describes an available option for configuring file writing for a particular output format.
QgsVectorFileWriter::OptionType type
Options to pass to QgsVectorFileWriter::writeAsVectorFormat().
QString fileEncoding
Encoding to use.
bool forceMulti
Sets to true to force creation of multi* geometries.
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.
QgsVectorFileWriter::FieldNameSource fieldNameSource
Source for exported field names.
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.
An available option for configuring file writing for a particular output format, presenting a choice ...
An available option for configuring file writing for a particular output format, presenting a freefor...
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 dataset.
long long featureCount(const QString &legendKey) const
Number of features rendered with specified legend key.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
int selectedFeatureCount() const
Returns the number of features that are selected in this layer.
Q_INVOKABLE const QgsFeatureIds & selectedFeatureIds() const
Returns a list of the selected features IDs in this layer.
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.