Cloudera Enterprise Hadoop HiveQL Script - Import - 7.1

Talend Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
7.1
EnrichProdName
Talend Big Data Platform
Talend Data Fabric
Talend Data Management Platform
Talend Data Services Platform
Talend MDM Platform
Talend Real-Time Big Data Platform
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/. For more information on how to retrieve third-party drivers when the TDC server cannot access the Internet, see this article.

Bridge Specifications

Vendor Cloudera
Tool Name Enterprise Hadoop Hive Database
Tool Version Hive 2.x to 3.x
Tool Web Site http://www.cloudera.com/products.html
Supported Methodology [Data Integration] Multi-Model, Data Store (Physical Data Model), (Source and Target Data Stores, Transformation Lineage, Expression Parsing) via SQL TXT File
Incremental Harvesting
Remote Repository Browsing for Model Selection
Data Profiling
Multi-Model Harvesting

SPECIFICATIONS
Tool: Cloudera / Enterprise Hadoop Hive Database version Hive 2.x to 3.x via SQL TXT File
See http://www.cloudera.com/products.html
Metadata: [Data Integration] Multi-Model, Data Store (Physical Data Model), (Source and Target Data Stores, Transformation Lineage, Expression Parsing)
Component: SqlScriptApacheHiveQLImport.ClouderaEnterprise 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 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 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 you must use the bridge importing from the SQL Data Definition Language (DML) 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 bridge importing metadata from the live database via JDBC, instead of this bridge parsing SQL DDL (see limitations below).

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
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
*.csv - include only csv files at the root level
**.csv -include only csv files at any level
*.{csv,gz} include only csv or gz files at the root level
dir/*.csv - include only csv files in the 'dir' folder
dir/**.csv - include only csv files under 'dir' folder at any level
dir/**.* - include any file under 'dir' folder at any level
f.csv - include only f.csv under root level
**/f.csv - include only f.csv 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
*.csv - exclude only csv files at the root level
**.csv -exclude only csv files at any level
*.{csv,gz} exclude only csv or gz files at the root level
dir/*.csv - exclude only csv files in the 'dir' folder
dir/**.csv - exclude only csv files under 'dir' folder at any level
dir/**.* - exclude any file under 'dir' folder at any level
f.csv - exclude only f.csv under root level
**/f.csv - exclude only f.csv 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      
Incremental import Incremental import only extracts what has changed since the last import. The initial full metadata harvesting (model import) of a very large source system can take a long time. However the extracted metadata are organized as a multi-model, where each model is a unit of change (e.g. Schema of a RDBMS server, or report of BI server). Subsequent model imports are dramatically faster than the initial import as this bridge will automatically try to detect changes in the source system, in order to only process the modified, added or deleted models and reuse all unchanged metadata from the model cache. Note however that the detection of change is more or less efficient depending on the sources system: e.g. BI servers can quickly provide the list of new, modified or deleted reports, but not all data stores offer a schema level change detection.

'True'
Import only the changes made since the last import

'False'
import all metadata. This option is required after upgrading the bridge in particular to take full advantage of any additional metadata coverage.

For debugging purpose, the option -cache.clear of the Miscellaneous parameter can be used to clear one model from the cache which is located (by default) in: $HOME/data/MIMB/cache/<BridgeId>/<ModelId>
BOOLEAN
False
True
True  
Miscellaneous Specify miscellaneous options identified with a -option followed by a value if required:

GENERAL 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.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.

-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.

-s <filepath>
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

If the bridge doesn't find yaml file then it generates new one and fills it with pairs of keys/default values.
Yaml file contains "common shell parameter map" section and "individual script maps" section. The bridge takes common key/value pairs to substitute shell parameters by its values in all scripts. The section "individual script maps" contains pairs for individual scripts.

SQL SCRIPT OPTIONS
-d
Default schema. Allows to specify a schema name for the objects that don't have it defined explicitly.

-e
Encoding. This value will be used to load text from the specified script files. By default, UTF-8 will be used. E.g.
-e UTF-16
-e UTF-16BE
-e US-ASCII

-cs
Create separate connections for all database schemas
-cs c1, c2 - create separate connections for all database schemas of 'c1' and 'c2' connections
-cs app1=c.s1 - create 'app1' connection for the 's1' schema in the 'c' connection
STRING      

 

Bridge Mapping

Mapping information is not available