Google Cloud BigQuery Database (via JDBC) - Import
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 | |
| Tool Name | Cloud 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 |
| Data Profiling |  |
| Incremental Harvesting | |
| Multi-Model Harvesting | |
| Remote Repository Browsing for Model Selection | |
SPECIFICATIONS
Tool: Google / Cloud 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.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 establishes a connection to Google's BigQuery servers in order to extract the physical metadata.
REQUIREMENTS
The import 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 import bridge will automatically download the required driver(s) into _Install/data/download/MIMB folder.
This import bridge utilizes the native Java API to parse the metadata, by loading the Simba JDBC driver.
Optionally, this import bridge also supports 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.3.0.1001
See the PERMISSIONS section below.
AUTHENTICATION
n/a
PERMISSIONS
Any import bridge is warranted to be read only and only extracts metadata. Therefore the user of this import bridge requires much less permissions than classic users needing to read/write data.
In case of the Google BigQuery Database:
This import bridge extracts the metadata by reading the Google BigQuery database system tables (e.g. INFORMATION_SCHEMA). Note that the JDBC driver (nor the import bridge) creates a BigQuery job when it needs to read from these system tables, or any table for that matter. Therefore, this import 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
This import 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 import 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 import bridge.
https://developers.google.com/bigquery/docs/authorization#service-accounts-server
FREQUENTLY ASKED QUESTIONS
n/a
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 | ||||
| Driver location | The file directory where the JDBC driver files are located. When the value is empty (default), the bridge tries to download the driver files from Google site. The default driver class name is 'com.simba.googlebigquery.jdbc42.DataSource'. If the driver specified has a different class name, specify that name using the -driver.className option in the Miscellaneous bridge parameter. |
DIRECTORY | |||||||
| Service client ID | The client ID for the service account created for the import 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 import 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 | *.* | ||||||
| Projects | The fully qualified projects IDs to import expressed as a comma/semicolon separated list of projects IDs, e.g. mydomain.com:myProject1, mydomain.com:myProject2 Note that only the first project in that list will be used for authentication of all other projects in the list. Therefore, some of the projects in the list may not be imported if the credential provided via the first project does not have access to other listed projects. |
STRING | Mandatory | ||||||
| Locations | List of Region names (see https://cloud.google.com/bigquery/docs/locations ) where the desired datasets are located. For example, asia-northeast1,US,EU. A dataset is located in a particular region. When you create a dataset you can specify its regional location or use the default. This parameter allows you to filter datasets based on their location. By default, the parameter value is empty which instructs the bridge to import datasets located in the US Multi-region. This option works only with the MultiModel mode. |
STRING | |||||||
| Datasets | The subset of datasets to import expressed as a semicolon separated list of datasets' names, 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 % or *, 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: ^ $ * + ? | \ ( ) [ ] { } whitespace enclose this name in square brackets and escape special characters, e.g. OneWord%; [Two\sWords.*]; [Dollar\$] |
REPOSITORY_SUBSET | |||||||
| Stored procedure details | Controls the amount of details imported from stored procedures: 'Signature' The name and parameters of stored procedures 'Code, signature' The above plus code 'Lineage, code, signature' The above plus data lineage derived from the code 'None' stored procedure details are not included. |
ENUMERATED |
|
Signature | |||||
| 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) GOOGLE BIGQUERY OPTIONS -s Import system objects that are skipped by default. -model.split (previously -multiModel) Splits a large server model into multi models (e.g. one database per model). Warning: This is a system option managed by the application calling this import bridge and should not be set by users. -driver.className The full name (including the package name) of the Java class that implements the JDBC driver interface. -driver.options "<option declaration>" JDBC driver connection options. All provided options will be added to the JDBC driver connection string. examples: -driver.options "Timeout=100" -driver.options "AllowLargeResults=1;Timeout=300;LogLevel=1" -driver.url The fully qualified JDBC connection string. It overrides any other bridge connection options. |
STRING |
Bridge Mapping
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"Google Cloud 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 |