Bridge Specifications
| Vendor | MongoDB |
| Tool Name | NoSQL Database |
| Tool Version | 3.2 |
| Tool Web Site | https://www.mongodb.org/ |
| Supported Methodology | [NoSQL Database] Multi-Model, Data Store (NoSQL / Hierarchical, Physical Data Model) via Java API |
SPECIFICATIONS
Tool: MongoDB / NoSQL Database version 3.2 via Java API
See https://www.mongodb.org/
Metadata: [NoSQL Database] Multi-Model, Data Store (NoSQL / Hierarchical, Physical Data Model)
Component: MongoDB version 11.2.0
DISCLAIMER
This import bridge requires internet access to download third-party libraries:
- such as https://repo.maven.apache.org/maven2/ to download open source third-party libraries,
- and more sites for other third-party software such as database specific JDBC drivers.
The downloaded third-party libraries are stored into $HOME/data/download/MIMB/
- If HTTPS fails, the import bridge then tries with HTTP.
- If a proxy is used to access internet, you must configure that proxy in the JRE (see the -j option in the Miscellaneous parameter).
- If the import bridge does not have full access to internet, that $HOME/data/download/MIMB/ directory can be copied from another server with internet access where the command $HOME/bin/MIMB.sh (or .bat) -d can be used to download all third-party libraries used by all bridges at once.
By running this import bridge, you hereby acknowledge responsibility for the license terms and any potential security vulnerabilities from these downloaded third-party software libraries.
OVERVIEW
This import bridge establishes a connection to the MongoDB server using native Java driver in order to extract the physical metadata.
REQUIREMENTS
Bridge will assign a data type for each JSON attribute according to following samples:
'_id'
{ "$oid": "50a9c951300493f64fbffdb6" } STRING (SQL_VARCHAR)
'dateExample'
{ "$date" : "2014-01-01T05:00:00.000Z"} DATE_8 (SQL_DATE)
'isoDateExample'
{ "$date" : 1491461103897 } DATE_8 (SQL_DATE)
'timestampExample'
{ "$timestamp" : { "t" : 1412180887, "i" : 1 } } TIMESTAMP (SQL_TIMESTAMP)
'stringDateExample'
"Thu Apr 06 2017 09:41:51 GMT+0300 (FLE Standard Time)" STRING (SQL_VARCHAR)
'numberLongExample'
{ "$numberLong": "7494814965" } LONG_8 (SQL_BIGINT)
'booleanSample'
true BOOLEAN_1 (SQL_BOOLEAN)
'stringSample'
"some text" STRING (SQL_VARCHAR)
'expNumberSample'
2.99792458e8 DOUBLE_10_5 (SQL_DOUBLE)
'smallNumberSample'
-1 LONG_8 (SQL_BIGINT)
'numberSample'
3 LONG_8 (SQL_BIGINT)
'floatSample'
3.141592653589793238462643383279 DOUBLE_10_5 (SQL_DOUBLE)
'rfc7493bignumber'
"9007199254740992" STRING (SQL_VARCHAR)
'expStringSample'
"2.99792458e8" STRING (SQL_VARCHAR)
'arraySample'
[1, 2, 3] array (SQL_ARRAY)
'objectEmptySample'
{} STRING (SQL_VARCHAR)
'nullSample'
null undefined
'nullStringSample'
"null" STRING (SQL_VARCHAR)
FREQUENTLY ASKED QUESTIONS
n/a
LIMITATIONS
Refer to the current general known limitations at https://metaintegration.com/Products/MIMB/Help/#!Documents/mimbknownlimitations.html
SUPPORT
Provide a troubleshooting package with:
- the debug log (can be set in the UI or in conf/conf.properties with MIR_LOG_LEVEL=6)
- the metadata backup if available (can be set in the Miscellaneous parameter with -backup option, although this common option is not implemented on all bridges for technical reasons).
Bridge Parameters
| Parameter Name | Description | Type | Values | Default | Scope |
| Connection string | This parameter overrides all other connection settings. It works in conjunction with the password parameter. Five stars in a row (*****) are used as a placeholder for the password, the actual password will be provided to the driver under the hood. Example: mongodb+srv://testuser:*****@gettingstarted.kyuw2.azure.mongodb.net/admin Please consult with the documentation here https://docs.mongodb.com/manual/reference/connection-string/ |
STRING | |||
| Host | Server URIs separated by commas. If port is not specified with a colon the default port assumed. You can specify type of connection - either mongodb:// or mongodb+srv://. By default, bridge trying to connect with mongodb:// protocol first. - Examples: lolly.jess:3999,lolly-backup localhost:8887 mongodb+srv://testhost mongodb://testhost:27017 |
STRING | |||
| User | The MongoDB user name on whose behalf the connection is being made. If not specified, anonymous will be used. |
STRING | |||
| Password | The MongoDB user's password on whose behalf the connection is being made. | PASSWORD | |||
| Replica Set | Replica Set name. | STRING | |||
| Authentication database | Specify user authentication database. | STRING | admin | ||
| Databases | Specify a list of MongoDB databases to be imported. The list can have one or more database names separated by semicolons, e.g. database1; database2 When value is "*" all accessible databases are imported. Database name with special characters: - If there is single quote in entity name, make sure escape it with another single quote: data'base -> data''base - If there is one of special characters [ * , ; . ] in entity name or space, make sure to put name in single quotes: data;base -> 'data;base' data*base -> 'data*base' data.base -> 'data.base' database -> ' database ' All characters that are in single quotes will be recognized literally. |
REPOSITORY_SUBSET | |||
| Collections | The subset of collections to import expressed as a semicolon separated list of collections. To specify a single database in "Databases" parameter, input a set of collections without specifying a database name, e.g. collection1;collection2 To specify multiple databases, the fully qualified collection name must be specified, e.g. database1.collection1;database2.collection2;database1.collection2 When value is "*" all accessible collections are imported. Schema name patterns using the syntax rules used by the LIKE operator in SQL: - Inclusion syntax: using %, e.g. A%; %B; %C%; D - start with A or - end with B or - contain C or - equal D - Exclusion syntax: using NOT, e.g. A%; %B; NOT %SYS; NOT 'SYS%' - WHERE (name like A% or name like %B) - and (name NOT like %SYS) - and (name NOT like 'SYS%') - Special characters: using single quote, e.g. OneWord%; 'Two Words%' - If there is percent-mark in collection name, please escape it: name%name = name%%name Schema name with special characters: - If there is single quote in entity name, make sure escape it with another single quote: col'lection -> col''lection - If there is one of special characters [ * , ; . ] in entity name or space, make sure to put name in single quotes: col;lection -> 'col;lection' database.col*lection -> database.'col*lection' data,base. collection ->'data,base'.' collection ' All characters that are in single quotes will be recognized literally. - Start-expression means import ALL from current embeddedness level: db.* means that all collections from db will be imported. *.coll means that all collections named "coll" will be imported from all databases. |
REPOSITORY_SUBSET | |||
| Number of sample documents | Number of sample documents to be randomly drawn from each collection. The default value is 10. | NUMERIC | 10 | ||
| Miscellaneous | INTRODUCTION Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g. -connection.cast MyDatabase1="MICROSOFT SQL SERVER" Some options can be used multiple times if applicable, e.g. -connection.rename NewConnection1=OldConnection1 -connection.rename NewConnection2=OldConnection2; As the list of options can become a long string, it is possible to load it from a file which must be located in ${MODEL_BRIDGE_HOME}\data\MIMB\parameters and have the extension .txt. In such case, all options must be defined within that file as the only value of this parameter, e.g. ETL/Miscellaneous.txt JAVA ENVIRONMENT OPTIONS -java.memory <Java Memory's maximum size> (previously -m) 1G by default on 64bits JRE or as set in conf/conf.properties, e.g. -java.memory 8G -java.memory 8000M -java.parameters <Java Runtime Environment command line options> (previously -j) This option must be the last one in the Miscellaneous parameter as all the text after -java.parameters is passed "as is" to the JRE, e.g. -java.parameters -Dname=value -Xms1G The following option must be set when a proxy is used to access internet (this is critical to access https://repo.maven.apache.org/maven2/ and exceptionally a few other tool sites) in order to download the necessary third-party software libraries. Note: The majority of proxies are concerned with encrypting (HTTPS) the outside (of the company) traffic and trust the inside traffic that can access proxy over HTTP. In this case, an HTTPS request reaches the proxy over HTTP where the proxy HTTPS-encrypts it. -java.parameters -java.parameters -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass MODEL IMPORT OPTIONS -model.name <model name> Override the model name, e.g. -model.name "My Model Name" -prescript <script name> This option allows running a script before the bridge execution. The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), and have .bat or .sh extension. The script path must not include any parent directory symbol (..). The script should return exit code 0 to indicate success, or another value to indicate failure. For example: -prescript "script.bat arg1 arg2" -postscript <script name> This option allows running a script after successful execution of the bridge. The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), and have .bat or .sh extension. The script path must not include any parent directory symbol (..). The script should return exit code 0 to indicate success, or another value to indicate failure. For example: -postscript "script.bat arg1 arg2" -cache.clear Clears the cache before the import, and therefore will run a full import without incremental harvesting. If the model was not changed and the -cache.clear parameter is not used (incremental harvesting), then a new version will not be created. If the model was not changed and the -cache.clear parameter is set (full source import instead of incremental), then a new version will be created. -backup <directory> Allows to save the input metadata for further troubleshooting. The provided <directory> must be empty. -restore <directory> Specify the backup <directory> to be restored. DATA CONNECTION OPTIONS Data Connections are produced by the import bridges typically from ETL/DI and BI tools to refer to the source and target data stores they use. These data connections are then used by metadata management tools to connect them (metadata stitching) to their actual data stores (e.g. databases, file system, etc.) in order to produce the full end to end data flow lineage and impact analysis. The name of each data connection is unique by import model. The data connection names used within DI/BI design tools are used when possible, otherwise connection names are generated to be short but meaningful such as the database / schema name, the file system path, or Uniform Resource Identifier (URI). The following option allows to manipulate connections. These options replaces the legacy options -c, -cd, and -cs. -connection.cast ConnectionName=ConnectionType Casts a generic database connection (e.g. ODBC/JDBC) to a precise database type (e.g. ORACLE) for SQL Parsing, e.g. -connection.cast "My Database"="MICROSOFT SQL SERVER". The list of supported data store connection types includes: ACCESS APACHE CASSANDRA DB2/UDB DENODO GOOGLE BIGQUERY HIVE MYSQL NETEZZA ORACLE POSTGRESQL PRESTO REDSHIFT SALESFORCE SAP HANA SNOWFLAKE MICROSOFT SQL AZURE MICROSOFT SQL SERVER SYBASE SQL SERVER SYBASE AS ENTERPRISE TERADATA VECTORWISE HP VERTICA -connection.rename OldConnection=NewConnection Renames an existing connection to a new name, e.g. -connection.rename OldConnectionName=NewConnectionName Multiple existing database connections can be renamed and merged into one new database connection, e.g. -connection.rename MySchema1=MyDatabase -connection.rename MySchema2=MyDatabase -connection.split oldConnection.Schema1=newConnection Splits a database connection into one or multiple database connections. A single database connection can be split into one connection per schema, e.g. -connection.split MyDatabase All database connections can be split into one connection per schema, e.g. -connection.split * A database connection can be explicitly split creating a new database connection by appending a schema name to a database, e.g. -connection.split MyDatabase.schema1=MySchema1 -connection.map SourcePath=DestinationPath Maps a source path to destination path. This is useful for file system connections when different paths points to the same object (directory or file). On Hadoop, a process can write into a CSV file specified with the HDFS full path, but another process reads from a Hive table implemented (external) by the same file specified using a relative path with default file name and extension, e.g. -connection.map /user1/folder=hdfs://host:8020/users/user1/folder/file.csv On Linux, a given directory (or file) like /data can be referred to by multiple symbolic links like /users/john and /users/paul, e.g. -connection.map /data=/users/John -connection.map /data=/users/paul On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g. -connection.map C:\data=M:\ -connection.map C:\data=N:\ -connection.casesensitive ConnectionName... Overrides the default case insensitive matching rules for the object identifiers inside the specified connection, provided the detected type of the data store by itself supports this configuration (e.g. Microsoft SQL Server, MySql etc.), e.g. -connection.casesensitive "My Database" -connection.caseinsensitive ConnectionName... Overrides the default case sensitive matching rules for the object identifiers inside the specified connection, provided the detected type of the data store by itself supports this configuration (e.g. Microsoft SQL Server, MySql etc.), e.g. -connection.caseinsensitive "My Database" -connection.level AggregationLevel Specifies the aggregation level for the external connections, e.g.-connection.level catalog The list of the supported values: server catalog schema (default) MONGODB OPTIONS -samples.number <number>[:even|order|top] Number of sample documents to be randomly drawn from each collection. The default value for samples number is 10. The default mode is 'top'. For more information about import modes, please read the '-samples' options documentation. Usage: 1. -samples.number 15 Bridge will import 15 samples from each collection. 2. -samples.number 15:order Bridge will import 15 samples from each collection using 'order' mode. -samples.mode <even|order|top> Import mode. Default value is 'top'. Supports three import modes: - Top Algorithm * Description: The top algorithm selects the first N documents from the collection, where N is the number of requested samples. * Note: First documents in database are not always the newest. - Even Algorithm * Description: This algorithm divides the total number of documents in the collection by the desired number of samples to determine even intervals for sample selection. For example, if there are 100 documents and 10 samples are requested, the algorithm selects every tenth document (positions 1, 10, 20, etc.). * Performance Note: This method requires the database to count all documents in the collection, which can be time-consuming, especially for large collections - Order Algorithm * Description: This algorithm selects documents at exponentially increasing positions to accommodate collections of varying sizes. For example, it might attempt to select documents at positions 10, 100, 1000, etc. If a requested position exceeds the number of documents in the collection (e.g., 1000th document in a collection of 999), the algorithm will halve the step recursively (10, 5, etc.) until it achieves the desired sample count. * Error Handling: The algorithm automatically adjusts when the computed positions are out of range, ensuring the final sample does not exceed the number of available documents. * Performance Note: Works better with big collections. -zip <filepath> Folder to store MongoDb documents as Json files. -hadoop key1=val1;key2=val2 to manualy set hadoop configuration options. -mask Use it when do not want to provide data values, but metadata only. -validator.description Capture the fixed schema model based on the structure of a collection validator with field descriptions. Starting from version 3.6, MongoDB supports the JSON Schema Validator. It will consist of a fixed schema and validation rules used for validation. The default behavior is to ignore validators. -validator.all Capture the fixed schema model based on the structure of a collection validator with the complete metadata provided (not just the field descriptions). Starting from version 3.6, MongoDB supports the JSON Schema Validator. It will consist of a fixed schema and validation rules used for validation. The default behavior is to ignore validators. -validator.collectiondescription Capture the validator field descriptions from the validator to the JSON collection of descriptions. Starting from version 3.6, MongoDB supports the JSON Schema Validator. It will consist of a fixed schema and validation rules used for validation. The default behavior is to ignore validators. -debug.usesystem Imports system collections. MongoDB stores system information in collections that use the <database>.system.* namespace, which MongoDB reserves for internal use. By default these collections, the local database and the config database are ignored. -connection.retries <value> Number of retries when connecting to server. -backup.data Saves json file with imported data to backup folder. |
STRING |
Bridge Mapping
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"MongoDB NoSQL Database" Metamodel File System (JSON Database) |
Mapping Comments |
| DirectoryStructureModel | Server | |
| Name | Name | |
| SystemType | Type | |
| Folder | Scope, Bucket, Database, Folder | |
| Name | Name | |
| StoreContent | Container, Documents, Collection, File, View | |
| Name | Name | |
| NativeType | Type |
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"MongoDB NoSQL Database" Metamodel File System (JSON File) |
Mapping Comments |
| Attribute | Array, Object, Property | |
| Description | Description | |
| Name | Name | |
| StoreModel | Json File | |
| Name | Name | |
| NativeType | File Type |