Databricks Delta Lake Hadoop Hive Database SQL DML (DI/ETL) Script (HiveQL) - Import
Availability-note
AWS
AWS-only features are available at any of the following URLs: us.cloud.talend.com, eu.cloud.talend.com, ap.cloud.talend.com
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 | Databricks |
| Tool Name | Delta Lake Hadoop Hive Database |
| Tool Version | Hive 2.x to 3.x - Azure Databricks 8.x to 9.x |
| Tool Web Site | https://databricks.com/product/delta-lake-on-databricks |
| Supported Methodology | [Data Integration] Multi-Model, Data Store (Physical Data Model), (Source and Target Data Stores, Transformation Lineage, Expression Parsing) via SQL TXT File |
| Data Profiling |  |
| Incremental Harvesting |  |
| Multi-Model Harvesting | |
| Remote Repository Browsing for Model Selection | |
SPECIFICATIONS
Tool: Databricks / Delta Lake Hadoop Hive Database version Hive 2.x to 3.x - Azure Databricks 8.x to 9.x via SQL TXT File
See https://databricks.com/product/delta-lake-on-databricks
Metadata: [Data Integration] Multi-Model, Data Store (Physical Data Model), (Source and Target Data Stores, Transformation Lineage, Expression Parsing)
Component: SqlScriptApacheHiveQLImport.Databricks 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 parses a directory of Hive database SQL Data Manipulation Language (SQL DML) "HiveQL" scripts to extract the data models of their source and target data stores (e.g. database schema, tables, columns) as well as the Data Integration (DI/ETL/ELT) models for the data flow lineage between these data stores.
REQUIREMENTS
- DML vs DDL:
This import bridge parses the full SQL Data Manipulation Language (DML) including statements to insert, update, delete data in tables, therefore creating a Data Integration (DI/ETL/ELT) model. If the SQL scripts only contain statements to create schema, tables, views, stored procedures, etc., then you must use the import bridge importing from the SQL Data Definition Language (DDL) which only creates a data model of the database.
- DML vs JDBC:
As explained above, if the SQL DML scripts turned out to be just SQL DDL scripts (which are usually compiled in the database). Such SQL DDL scripts may be incomplete, and may not be in sync with the actual database. Therefore, always prefer the import bridge importing metadata from the live database via JDBC, instead of this import bridge parsing SQL DDL (see limitations below).
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 |
| Directory | The directory of SQL DML scripts to import. | STRING | Mandatory | ||
| Include filter | The include folder and file filter pattern relative to the root directory, based on the extended Unix glob case-sensitive expression syntax, e.g. *.* - include any file at the root level *.sql - include only SQL files at the root level **.sql -include only SQL files at any level *.{sql,gz} include only SQL or GZ files at the root level dir/*.sql - include only SQL files in the 'dir' folder dir/**.sql - include only SQL files under 'dir' folder at any level dir/**.* - include any file under 'dir' folder at any level f.sql - include only f.sql under root level **/f.sql - include only f.sql at any level **dir/** - include all files under any 'dir' folder at any level **dir1/dir2/** - include all files under any 'dir2' folder under any 'dir1' folder at any level If both the include and exclude filters are empty, then all folders and files under the root directory are included. |
STRING | |||
| Exclude filter | The exclude folder and file filter pattern relative to the root directory, expressed using the extended Unix glob case-sensitive expression syntax, e.g. *.* - exclude any file at the root level *.txt - exclude only TXT files at the root level **.txt -exclude only TXT files at any level *.{txt,gz} exclude only TXT or GZ files at the root level dir/*.txt - exclude only TXT files in the 'dir' folder dir/**.txt - exclude only TXT files under 'dir' folder at any level dir/**.* - exclude any file under 'dir' folder at any level f.txt - exclude only f.txt under root level **/f.txt - exclude only f.txt at any level **dir/** - exclude all files under any 'dir' folder at any level **dir1/dir2/** - exclude all files under any 'dir2' folder under any 'dir1' folder at any level If the include filter is empty and the exclude filter is not, then any folders and files under the root directory are included except the ones matching this exclude filter. If both the include and exclude filters are empty, then all folders and files under the root directory are included. |
STRING | |||
| Hadoop configuration directory | The Hadoop configuration directory containing copies of core-site.xml and hdfs-site.xml files from compatible with the remote cluster you are trying to access. | DIRECTORY | |||
| 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) ETL OPTIONS These options are available on all ETL/DI tools and scripting import bridges in order to: - Process all SQL parsing - Build runtime models from design models and runtime variables - Calculate runtime summary lineage -etl.summary.add.ultimate (previously -ppus) Adds the ultimate runtime lineage summary (may generate a very large model). -etl.summary.only.ultimate (previously -ppsp) Only produces the ultimate runtime lineage summary (may generate a very large model). -etl.connections.add.internal.design (previously -pppd) Adds the internal ETL design data connectors (needed for ETL conversion). -etl.connections.remove.input (previously -ri) Removes all input (source) data connections (to reduce the size of the generated model). -etl.transformations.enable.xml This option enables the parsing and support of XML transformations in DI/ETL import bridges such as Informatica PowerCenter, Informatica Developer, Microsoft SSIS, IBM DataStage, and Talend Data Integration. In case of Informatica, such XML transformations corresponds to the following PowerCenter features https://docs.informatica.com/data-integration/powercenter/10-5/xml-guide/midstream-xml-transformations.html https://docs.informatica.com/data-integration/powercenter/10-5/xml-guide/xml-source-qualifier-transformation.html Note that this option may significantly slow down the import. SCRIPT OPTIONS -parameter.file <filepath> (previously -s) Path to a file that resolves Shell parameters in either Windows (%param%) or in Linux (${param}, $1) format. This parameter can be used to define a path to the key/value pair YAML file. The path can be escaped with double quotes if it contains spaces or any special characters. The records from the file will be used to preprocess the scripts and replace the corresponding Shell parameters with the actual values. The key literals must not be decorated with the escape characters and the matching rules are case sensitive. Character colon ':' is used as a key/value pair delimiter and must be escaped with backward slash '\' if it is part of the parameter name. For example, for script 'INSERT INTO %SCHEMA1%.t1(c1) SELECT a from %SCHEMA2%.t2;' the file with the parameters can be organized in the following way. E.g. # common shell parameter map SCHEMA1: actual_schema1 SCHEMA2: actual_schema2 # individual script maps "D:\\MIMB\\hive_001.hql": ${table_name}: actual_table "D:\\MIMB\\hive_002.hql": ${year_var}: 1993 The YAML file contains a "common shell parameter map" section and an "individual script maps" section. The bridge takes key/value pairs from the "common shell parameter map" section to substitute shell parameters in ALL scripts by those values specified in the YAML file. The "individual script maps" section contains pairs for individual scripts. If the bridge does not detect a YAML file with the pathname specified then it will - Generate a template YAML file and fill it with key/default values pairs which may be used to manually edit with the proper values - Invoke the -cache.clear option, as otherwise it would be picking up the metadata from the cache and not even look at the script and thus not have any information to produce a template file with. -schema.default <name> (previously -d) Default schema name. Allows to specify a schema name for the objects that don't have it defined explicitly. -encoding <value> (previously -e) Encoding. This value will be used to load text from the specified script files. By default, UTF-8 will be used. E.g. -encoding UTF-16 -encoding UTF-16BE -encoding US-ASCII |
STRING |
Bridge Mapping
Mapping information is not available