MongoDB NoSQL Database (JSON) - Import - Cloud

Talend Cloud Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend Data Catalog

Bridge Requirements

This bridge:
  • requires Internet access to https://repo.maven.apache.org/maven2/ and/or other tool sites to download drivers into <TDC_HOME>/data/download/MIMB/.

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 JDBC API
Data Profiling
Remote Repository Browsing for Model Selection
Multi-Model Harvesting
Incremental Harvesting

SPECIFICATIONS
Tool: MongoDB / NoSQL Database version 3.2 via JDBC API
See https://www.mongodb.org/
Metadata: [NoSQL Database] Multi-Model, Data Store (NoSQL / Hierarchical, Physical Data Model)
Component: MongoDB version 11.0.0

DISCLAIMER
This bridge requires internet access to https://repo.maven.apache.org/maven2/ (and exceptionally a few other tool sites)
in order to download the necessary third party software libraries into $HOME/data/download/MIMB/
- If https fails, the 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 bridge does not have access to internet, that directory can be copied from another server with internet access.
By running this bridge, you hereby acknowledge responsibility for the license terms and any potential security vulnerabilities from these downloaded third party software libraries.

OVERVIEW
This 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 http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html

SUPPORT
Provide a trouble shooting 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 option -backup)


Bridge Parameters

Parameter Name Description Type Values Default Scope
Driver version Choose driver version according to database server requirements. ENUMERATED
3.12.3
3.6.3
3.2.0
3.12.3  
Host Name or IP address of MongoDB server host. STRING      
Port MongoDB service port. NUMERIC   27017  
Authentication Mode Specify Authentication Mode. ENUMERATED
None
Basic (MONGODB-CR or SCRAM-SHA-1)
None  
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      
Authentication Database Specify user authentication database. STRING   admin Mandatory
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 the list is empty - all accessible databases are imported.
REPOSITORY_SUBSET     Mandatory
Collections The subset of collections to import expressed as a semicolon separated list of collections, e.g.
collection1; collection2

All Collections are imported if that list is empty.

Collection name patterns using a SQL like expression syntax:

- 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%'
REPOSITORY_SUBSET      
Number of sample documents Number of sample documents to be analyzed. NUMERIC      
Use SSL protocol to connect Set this parameter to True when the MongoDB server uses TLS/SSL to encrypt MongoDB's network traffic.

MongoDB uses SSL to encrypt connections between the server and clients. It does not use it for authenticating and authorizing clients. It is the responsibility of the server to employ a valid certificate. The bridge accepts any server SSL certificate.

If you need to ensure that the bridge is able to validate the SSL certificate presented by the server you need to set several JVM system properties using the -j option in the Miscellaneous parameter according to:
http://mongodb.github.io/mongo-java-driver/3.0/driver/reference/connecting/ssl/
BOOLEAN
False
True
False  
Miscellaneous INTRODUCTION
Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g.
-connection.cast MyDatabase1="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
-m <Java Memory's maximum size>
1G by default on 64bits JRE or as set in conf/conf.properties, e.g.
-m 8G
-m 8000M

-j <Java Runtime Environment command line options>
This option must be the last one in the Miscellaneous parameter as all the text after -j is passed "as is" to the JRE, e.g.
-j -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.
-j -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass -Dhttps.proxyUser=user -Dhttps.proxyPassword=pass

-jre <Java Runtime Environment full path name>
It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-jre "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-v <Environment variable value>
None by default, e.g.
-v var1=value1 -v var2="value2 with spaces"

MODEL IMPORT OPTIONS
-model.name <model name>
Override the model name, e.g.
-model.name "My Model Name"

-prescript <script name>
The script must be located in the bin directory, 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"

-cache.clear
Clears the cache before the import, and therefore will run a full import without incremental harvesting.
Warning: this is a system option managed by the application calling the bridge and should not be set by users.

-backup <directory>
Full path of an empty directory to save the metadata input files for further troubleshooting.

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 options 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"="SQL SERVER".
The list of supported data store connection types includes:
ACCESS
CASSANDRA
DB2
DENODO
HIVE
MYSQL
NETEZZA
ORACLE
POSTGRESQL
PRESTO
REDSHIFT
SALESFORCE
SAP HANA
SNOWFLAKE
SQL SERVER
SYBASE
TERADATA
VECTORWISE
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 DestinationPath=SourcePath
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 hdfs://host:8020/users/user1/folder/file.csv=/user1/folder
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 /users/John=/data -connection.map /users/paul=/data
On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g.
-connection.map M:\=C:\data -connection.map N:\=C:\data

-pppd
Create the connections and connection data sets in DI/ETL design models. This feature should only be used when intending to export to another DI/ETL tool.

MONGODB OPTIONS
-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.
STRING      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"MongoDB NoSQL Database (JSON)"
Metamodel
MongoDB (Database)
Mapping Comments
     
Attribute Column, Partition Column Columns which are part of the partition on the table.
Comment Comment  
Description Description  
ExtraConstraint Constraint  
InitialValue Initial Value  
Name Name  
NativeId Native Id  
Optional Nullable  
Position Position  
CandidateKey Object Identifier  
Description Description  
Name Name  
Class Document  
Comment Comment  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
ClassDiagram Diagram  
Description Description  
Name Name  
ClassType Reference  
Description Description  
Name Name  
DatabaseSchema Connection  
Description Description  
Name Name  
DesignPackage Subject Area, Collection  
Comment Comment  
Description Description  
Name Name  
NativeId Native Id  
Index Index  
Description Description  
Name Name  
Join Logical Relationship  
Description Description  
Name Name  
StoreModel MongoDB Model  
Author Author  
Comment Comment  
CreationTime Creation Time  
Description Description  
ModificationTime Modification Time  
Modifier Modifier  
Name Name  
NativeId Native Id  
StoreType Store Type  
SystemMajorVersion System Major Version  
SystemMinorVersion System Minor Version  
SystemReleaseVersion System Release Version  
SystemType System Type  
SystemTypeOld System Type Old