Meta Integration® Model Bridge (MIMB)
"Metadata Integration" Solution

MIMB Bridge Documentation

MIMB Import Bridge from Google BigQuery Database (via JDBC)

Bridge Specifications

Vendor Google
Tool Name BigQuery Database
Tool Version 2.0.0
Tool Web Site http://developers.google.com/bigquery/
Supported Methodology [Relational Database] Multi-Model, Data Store (Physical Data Model) via Java API

SPECIFICATIONS
Tool: Google / BigQuery Database version 2.0.0 via Java API
See http://developers.google.com/bigquery/
Metadata: [Relational Database] Multi-Model, Data Store (Physical Data Model)
Component: GoogleBigQuery version 11.0.0

DISCLAIMER
This 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 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 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 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 Google's BigQuery servers in order to extract the physical metadata.

The bridge uses jar files to connect to Google servers.
These jar files are typically available at: https://cloud.google.com/bigquery/providers/simba-drivers.
The bridge automatically download it into _Install/data/download/MIMB folder.

REQUIREMENTS
This bridge uses Oauth 2.0 protocol for accessing Google's BigQuery service. Currently, it supports authentication using the 'service account key'.
The authentication method supports either JSON or P12 key file. You can specify the file to the bridge using the Private Key File parameter. The P12 file is a legacy format that requires you to specify your service account ID in the optional Service Client ID parameter.
Please refer to the documentation provided with the link below to create a new service account. This will provide you with the client ID and the key file that is required to run the bridge.
https://developers.google.com/bigquery/docs/authorization#service-accounts-server

USER PERMISSIONS
This bridge does not just read the metadata using native java API, and therefore only requiring BigQuery Metadata Viewer permissions.
Instead, this bridge also optionally support data driven metadata discovery / data profiling, and therefore uses the BigQuery JDBC driver downloaded from Google, e.g.
data/download/MIMB/com.simba.googlebigquery/jdbc42/SimbaJDBCDriverforGoogleBigQuery42_1.2.12.1015
This bridge extracts the metadata by reading the Google BigQuery database system tables (e.g. INFORMATION_SCHEMA). Note that the JDBC driver (not the bridge) creates a BigQuery job when it needs to read from these system tables, or any table for that matter. Therefore, this bridge requires both BigQuery Metadata Viewer and BigQuery Job User roles on the projects Please refer to the documentation provided with the link below for more details:
https://cloud.google.com/bigquery/docs/jobs-overview

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
Service client ID The client ID for the service account created for the bridge, e.g.
xyz@developer.gserviceaccount.com.
This account ID information is necessary when using the P12 key file.
STRING      
Private key file The private key file for the service account created for the bridge.
This file should be in either JSON or P12 format (with either JSON or P12 file extension).
P12 is a legacy PKCS #12 format (Public Key Cryptography Standard #12) that requires you to specify your service account ID in the optional Service Client ID parameter.
Leave this parameter value empty when using the Application Default Credentials (ADC) authentication strategy.
FILE *.*    
Project IDs The list of fully qualified project identifiers. Usually, a project ID is of the form: mydomain.com:myProject. STRING     Mandatory
Dataset The subset of datasets to import expressed as a semicolon separated list of datasets, e.g.
dataset1; dataset2

All datasets are imported if that list is empty.

Dataset 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      
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
-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.
-java.parameters -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

-java.executable <Java Runtime Environment full path name> (previously -jre)

It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-java.executable "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-environment.variable <name>=<value> (previously -v)

None by default, e.g.
-environment.variable 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

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

GOOGLE BIG QUERY OPTIONS
-s

Import system objects that are skipped by default.

-datasets.location

The location where the BigQuery datasets are stored. If this property is specified, the connector can only query datasets that are in this location. For a list of locations, see "Dataset Locations" in the Google BigQuery documentation: https://cloud.google.com/bigquery/docs/locations.
For example, -location asia-east2

-driver.location

Alternative BigQuery JDBC driver location.
The JDBC driver folder location where all found JAR files will be added to the CLASSPATH.
The 'com.simba.googlebigquery.jdbc42.DataSource' JDBC driver is required.

-auth.access_token

The access token obtained from Google used to authorize access to BigQuery. Learn how to get one from Obtaining OAuth 2.0 access tokens.
Learn how to get one from: https://developers.google.com/identity/protocols/oauth2/web-server#obtainingaccesstokens

-auth.refresh_token

The refresh token obtained from Google used to authorize access to BigQuery. Learn how to get one from Obtaining OAuth 2.0 access tokens.
Learn how to get one from: https://developers.google.com/identity/protocols/oauth2/web-server#obtainingaccesstokens

-auth.client_secret

Secret of the application used to generate the refresh token.

STRING      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"Google BigQuery Database (via JDBC)"
Metamodel
Google BigQuery (Project)
Mapping Comments
     
Attribute Column  
Description Description  
ExtraConstraint Constraint  
InitialValue Initial Value  
Name Name  
NativeId Native Id  
Optional Nullable  
PhysicalName Physical Name  
Position Position  
Class Table, RECORD  
Description Description  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
ClassDiagram Diagram  
Description Description  
Name Name  
DatabaseSchema Dataset  
Description Description  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
DesignPackage Subject Area  
Description Description  
Name Name  
Join Logical Relationship  
Description Description  
Name Name  
SQLViewAttribute ViewColumn  
Description Description  
InitialValue Initial Value  
Name Name  
NativeId Native Id  
Optional Nullable  
PhysicalName Physical Name  
Position Position  
SQLViewEntity View  
Description Description  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
ViewStatement View Statement  
StoreModel Project  
Author Author  
CreationTime Creation Time  
Description Description  
ModificationTime Modification Time  
Modifier Modifier  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
StoreType Store Type  
SystemMajorVersion System Major Version  
SystemMinorVersion System Minor Version  
SystemReleaseVersion System Release Version  
SystemType System Type  
SystemTypeOld System Type Old  

Last updated on Fri, 10 Sep 2021 17:38:23

Copyright © Meta Integration Technology, Inc. 1997-2021 All Rights Reserved.

Meta Integration® is a registered trademark of Meta Integration Technology, Inc.
All other trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.