| 1 |
/****************************************************************************** |
| 2 |
* |
| 3 |
* Project: MongoDB Translator |
| 4 |
* Purpose: Implements OGRMongoDBDriver. |
| 5 |
* Author: Even Rouault, even.rouault at spatialys.com |
| 6 |
* |
| 7 |
****************************************************************************** |
| 8 |
* Copyright (c) 2014-2019, Even Rouault <even dot rouault at spatialys dot com> |
| 9 |
* |
| 10 |
* SPDX-License-Identifier: MIT |
| 11 |
****************************************************************************/ |
| 12 |
|
| 13 |
#include "gdal_frmts.h" |
| 14 |
#include "gdalplugindriverproxy.h" |
| 15 |
|
| 16 |
#include "ogrsf_frmts.h" |
| 17 |
|
| 18 |
#include "ogrmongodbv3drivercore.h" |
| 19 |
|
| 20 |
/************************************************************************/ |
| 21 |
/* OGRMongoDBv3DriverIdentify() */ |
| 22 |
/************************************************************************/ |
| 23 |
|
| 24 |
int OGRMongoDBv3DriverIdentify(GDALOpenInfo *poOpenInfo) |
| 25 |
|
| 26 |
{ |
| 27 |
return STARTS_WITH_CI(poOpenInfo->pszFilename, "MongoDBv3:") || |
| 28 |
STARTS_WITH_CI(poOpenInfo->pszFilename, "mongodb+srv:") || |
| 29 |
STARTS_WITH_CI(poOpenInfo->pszFilename, "mongodb:"); |
| 30 |
} |
| 31 |
|
| 32 |
/************************************************************************/ |
| 33 |
/* OGRMongoDBv3DriverSetCommonMetadata() */ |
| 34 |
/************************************************************************/ |
| 35 |
|
| 36 |
void OGRMongoDBv3DriverSetCommonMetadata(GDALDriver *poDriver) |
| 37 |
{ |
| 38 |
poDriver->SetDescription(DRIVER_NAME); |
| 39 |
poDriver->SetMetadataItem(GDAL_DCAP_VECTOR, "YES"); |
| 40 |
poDriver->SetMetadataItem(GDAL_DCAP_CREATE_LAYER, "YES"); |
| 41 |
poDriver->SetMetadataItem(GDAL_DCAP_DELETE_LAYER, "YES"); |
| 42 |
poDriver->SetMetadataItem(GDAL_DCAP_CREATE_FIELD, "YES"); |
| 43 |
poDriver->SetMetadataItem(GDAL_DMD_LONGNAME, |
| 44 |
"MongoDB (using libmongocxx v3 client)"); |
| 45 |
poDriver->SetMetadataItem(GDAL_DMD_HELPTOPIC, |
| 46 |
"drivers/vector/mongodbv3.html"); |
| 47 |
poDriver->SetMetadataItem(GDAL_DMD_SUPPORTED_SQL_DIALECTS, |
| 48 |
"OGRSQL SQLITE MongoDB"); |
| 49 |
poDriver->SetMetadataItem(GDAL_DCAP_UPSERT, "YES"); |
| 50 |
|
| 51 |
poDriver->SetMetadataItem(GDAL_DMD_CONNECTION_PREFIX, "MongoDBv3:"); |
| 52 |
|
| 53 |
poDriver->SetMetadataItem( |
| 54 |
GDAL_DS_LAYER_CREATIONOPTIONLIST, |
| 55 |
"<LayerCreationOptionList>" |
| 56 |
" <Option name='OVERWRITE' type='boolean' description='Whether to " |
| 57 |
"overwrite an existing collection with the layer name to be created' " |
| 58 |
"default='NO'/>" |
| 59 |
" <Option name='GEOMETRY_NAME' type='string' description='Name of " |
| 60 |
"geometry column.' default='geometry'/>" |
| 61 |
" <Option name='SPATIAL_INDEX' type='boolean' description='Whether to " |
| 62 |
"create a spatial index' default='YES'/>" |
| 63 |
" <Option name='FID' type='string' description='Field name, with " |
| 64 |
"integer values, to use as FID' default='ogc_fid'/>" |
| 65 |
" <Option name='WRITE_OGR_METADATA' type='boolean' " |
| 66 |
"description='Whether to create a description of layer fields in the " |
| 67 |
"_ogr_metadata collection' default='YES'/>" |
| 68 |
" <Option name='DOT_AS_NESTED_FIELD' type='boolean' " |
| 69 |
"description='Whether to consider dot character in field name as " |
| 70 |
"sub-document' default='YES'/>" |
| 71 |
" <Option name='IGNORE_SOURCE_ID' type='boolean' description='Whether " |
| 72 |
"to ignore _id field in features passed to CreateFeature()' " |
| 73 |
"default='NO'/>" |
| 74 |
"</LayerCreationOptionList>"); |
| 75 |
|
| 76 |
poDriver->SetMetadataItem( |
| 77 |
GDAL_DMD_OPENOPTIONLIST, |
| 78 |
"<OpenOptionList>" |
| 79 |
" <Option name='URI' type='string' description='Connection URI' />" |
| 80 |
" <Option name='HOST' type='string' description='Server hostname' />" |
| 81 |
" <Option name='PORT' type='integer' description='Server port' />" |
| 82 |
" <Option name='DBNAME' type='string' description='Database name' />" |
| 83 |
" <Option name='USER' type='string' description='User name' />" |
| 84 |
" <Option name='PASSWORD' type='string' description='User password' />" |
| 85 |
" <Option name='SSL_PEM_KEY_FILE' type='string' description='SSL PEM " |
| 86 |
"certificate/key filename' />" |
| 87 |
" <Option name='SSL_PEM_KEY_PASSWORD' type='string' description='SSL " |
| 88 |
"PEM key password' />" |
| 89 |
" <Option name='SSL_CA_FILE' type='string' description='SSL " |
| 90 |
"Certification Authority filename' />" |
| 91 |
" <Option name='SSL_CRL_FILE' type='string' description='SSL " |
| 92 |
"Certification Revocation List filename' />" |
| 93 |
" <Option name='SSL_ALLOW_INVALID_CERTIFICATES' type='boolean' " |
| 94 |
"description='Whether to allow connections to servers with invalid " |
| 95 |
"certificates' default='NO'/>" |
| 96 |
" <Option name='BATCH_SIZE' type='integer' description='Number of " |
| 97 |
"features to retrieve per batch'/>" |
| 98 |
" <Option name='FEATURE_COUNT_TO_ESTABLISH_FEATURE_DEFN' " |
| 99 |
"type='integer' description='Number of features to retrieve to " |
| 100 |
"establish feature definition. -1 = unlimited' default='100'/>" |
| 101 |
" <Option name='JSON_FIELD' type='boolean' description='Whether to " |
| 102 |
"include a field with the full document as JSON' default='NO'/>" |
| 103 |
" <Option name='FLATTEN_NESTED_ATTRIBUTES' type='boolean' " |
| 104 |
"description='Whether to recursively explore nested objects and " |
| 105 |
"produce flatten OGR attributes' default='YES'/>" |
| 106 |
" <Option name='FID' type='string' description='Field name, with " |
| 107 |
"integer values, to use as FID' default='ogc_fid'/>" |
| 108 |
" <Option name='USE_OGR_METADATA' type='boolean' description='Whether " |
| 109 |
"to use the _ogr_metadata collection to read layer metadata' " |
| 110 |
"default='YES'/>" |
| 111 |
" <Option name='BULK_INSERT' type='boolean' description='Whether to " |
| 112 |
"use bulk insert for feature creation' default='YES'/>" |
| 113 |
"</OpenOptionList>"); |
| 114 |
|
| 115 |
poDriver->SetMetadataItem( |
| 116 |
GDAL_DMD_CREATIONFIELDDATATYPES, |
| 117 |
"Integer Integer64 Real String Date DateTime Time IntegerList " |
| 118 |
"Integer64List RealList StringList Binary"); |
| 119 |
poDriver->SetMetadataItem(GDAL_DMD_CREATIONFIELDDATASUBTYPES, "Boolean"); |
| 120 |
poDriver->SetMetadataItem(GDAL_DCAP_MULTIPLE_VECTOR_LAYERS, "YES"); |
| 121 |
|
| 122 |
poDriver->pfnIdentify = OGRMongoDBv3DriverIdentify; |
| 123 |
poDriver->SetMetadataItem(GDAL_DCAP_OPEN, "YES"); |
| 124 |
|
| 125 |
poDriver->SetMetadataItem(GDAL_DCAP_UPDATE, "YES"); |
| 126 |
poDriver->SetMetadataItem(GDAL_DMD_UPDATE_ITEMS, "Features"); |
| 127 |
} |
| 128 |
|
| 129 |
/************************************************************************/ |
| 130 |
/* DeclareDeferredOGRMongoDBv3Plugin() */ |
| 131 |
/************************************************************************/ |
| 132 |
|
| 133 |
#ifdef PLUGIN_FILENAME |
| 134 |
void DeclareDeferredOGRMongoDBv3Plugin() |
| 135 |
{ |
| 136 |
if (GDALGetDriverByName(DRIVER_NAME) != nullptr) |
| 137 |
{ |
| 138 |
return; |
| 139 |
} |
| 140 |
auto poDriver = new GDALPluginDriverProxy(PLUGIN_FILENAME); |
| 141 |
#ifdef PLUGIN_INSTALLATION_MESSAGE |
| 142 |
poDriver->SetMetadataItem(GDAL_DMD_PLUGIN_INSTALLATION_MESSAGE, |
| 143 |
PLUGIN_INSTALLATION_MESSAGE); |
| 144 |
#endif |
| 145 |
OGRMongoDBv3DriverSetCommonMetadata(poDriver); |
| 146 |
GetGDALDriverManager()->DeclareDeferredPluginDriver(poDriver); |
| 147 |
} |
| 148 |
#endif |