Google Cloud Platform (GCP) Hadoop Hive Database SQL DDL Script - 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 Specifications
| Vendor | |
| Tool Name | Cloud Platform (GCP) Hadoop Hive Database |
| Tool Version | Hive 2.x to 3.x |
| Tool Web Site | https://cloud.google.com/gcp/ |
| Supported Methodology | [Relational Database] Multi-Model, Data Store (Physical Data Model), (Expression Parsing) via SQL TXT File |
| Data Profiling |  |
| Incremental Harvesting | |
| Multi-Model Harvesting |  |
| Remote Repository Browsing for Model Selection | |
SPECIFICATIONS
Tool: Google / Cloud Platform (GCP) Hadoop Hive Database version Hive 2.x to 3.x via SQL TXT File
See https://cloud.google.com/gcp/
Metadata: [Relational Database] Multi-Model, Data Store (Physical Data Model), (Expression Parsing)
Component: DdlScriptApacheHiveQLImport.GoogleCloudPlatform version 11.2.0
OVERVIEW
This import bridge parses a directory of Hive SQL Data Definition Language (SQL DDL) scripts to extract all its metadata (e.g. Schemas, Tables, Columns, Data Types.) and parse any SQL (e.g. Views, Stored Procedures) to produce the data flow lineage.
- DDL vs JDBC:
This import bridge parses the SQL DDL statements creating schema, tables, views, stored procedures, etc. (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).
- DDL vs DML:
This import bridge only parses the SQL Data Definition Language(DDL) statements creating schema, tables, views, stored procedures, etc., therefore creating a data model of the database. If the SQL scripts also contain statements to insert, update, delete data in tables, then you must use the import bridge importing from the full SQL Data Manipulation Language (DML) which creates a Data Integration (DI/ETL/ELT) model.
REQUIREMENTS
n/a
FREQUENTLY ASKED QUESTIONS
Q: How do I obtain DDL from a Hadoop Hive server?
A: Please use the utility provided at '${MODEL_BRIDGE_HOME}/bin/hive_generate_ddl.sh'. Place this utility on the Hive cluster (should not matter where). Once there, remotely connect with a bash shell and execute the utility. It will extract the DDL from all the schemas in the cluster into a file name 'tables.hql'. You may also pass a list of schemas to extract, as the first parameter of the utility.
LIMITATIONS
Refer to the current general known limitations at MIMB Known Limitations or bundled in Documentation/ReadMe/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 | |||
| File | The file with database SQL DDL script to import. | FILE |
|
Mandatory | ||||
| Default schema | The default schema name to be used for the objects that don't have a schema qualifier defined. | STRING | ||||||
| Schemas | The subset of schemas to import expressed as a semicolon separated list of schemas, e.g. schema1; schema2 All user schemas are imported if that list is empty. All system schemas (e.g. SysAdmin) and objects are ignored by default. If system schemas are needed, use the Miscellaneous parameter option -s. 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%' |
STRING | ||||||
| Tables and views | The subset of tables to import expressed as a semicolon separated list of tables, e.g. table1; table2 All user tables are imported if that list is empty. All system tables (e.g. SysAdmin) and objects are ignored by default. If system tables are needed, use the Miscellaneous parameter option -s. Table 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%' |
STRING | ||||||
| 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> This option allows to save the bridge input metadata for further troubleshooting. The provided <directory> must be empty. The primary use of this option is for data store import bridges, in particular JDBC based database import bridges. Note that this option is not operational on some bridges including: - File based import bridges (as such input files can be used instead) - DI/BI repository import bridges (as the tool's repository native backup can be used instead) - Some API based import bridges (e.g. COM based) for technical reasons. 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.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) SQL DDL OPTIONS -s <pathname> Path to the key/value pair file that will be used to preprocess the script files and replace shell parameters with the actual values. The path can be escaped with double quotes if it contains spaces or any special characters. The colon character (:) must be escaped with '\' if it is part of a parameter name. The file (referred to by the pathname) must have the following format: key1:value1 "key 2":value2 \:key3withcolon:value3 E.g. -s J:\MIMB\map_of_shell_parameters.txt -default.server <server name> Default server. Allows to specify a default database server name. -default.database <database name> Default database. Allows to specify a database name. -default.databasetype <database type> Default database type. Allows to specify a default database type. -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 -e ISO-8859-1 -p <warehouse path> Warehouse path. /user/hive/warehouse by default. E.g. -p /user/hive/temp -model.split (previously -multiModel) Splits a large database model into multi models (e.g. one schema per model). |
STRING |
Bridge Mapping
Mapping information is not available