Bridge Specifications
| Vendor | Databricks |
| Tool Name | Databricks Unity Catalog |
| Tool Version | 10.x to 16.x |
| Tool Web Site | https://docs.databricks.com/data-governance/unity-catalog/ |
| Supported Methodology | [Relational Database] Multi-Model, Data Store (Physical Data Model) via JDBC API |
SPECIFICATIONS
Tool: Databricks / Databricks Unity Catalog version 10.x to 16.x via JDBC API
See https://docs.databricks.com/data-governance/unity-catalog/
Metadata: [Relational Database] Multi-Model, Data Store (Physical Data Model)
Component: DatabricksUnityCatalogMetastore version 12.0.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 -java.parameters 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
Imports metadata from a Databricks Unity Catalog server.
AUTHENTICATION
Select the appropriate Authentication method and provide the corresponding credentials:
- Databricks personal access token:
Select Authentication method = Databricks.
Tenant ID =
Client ID =
Client Secret =
Personal access token = <Databricks personal access token>
- Databricks managed service principal:
Select Authentication method = Databricks.
Tenant ID =
Client ID = <Databricks service principal client ID>
Client Secret = <Databricks service principal client secret>
Personal access token =
- Microsoft Entra ID service principal:
Select Authentication method = Azure.
Tenant ID = <Microsoft Entra application tenant ID>
Client ID = <Microsoft Entra application client ID>
Client Secret = <Microsoft Entra application client secret>
Personal access token =
The bridge uses these credentials to obtain a Microsoft Entra ID access token
for Azure Databricks through the Cloud Identity library.
The Microsoft Entra application must:
- Have a corresponding service principal configured in the Databricks account.
- Be assigned to the Databricks workspace that the bridge needs to access.
- Have access to the required Databricks SQL warehouse or other compute resources.
- Have the required permissions for the catalogs, schemas, tables, and other
Databricks resources that need to be imported.
REQUIREMENTS
n/a
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).
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 Databricks Unity Catalog:
The user should have permission to run USE CATALOG, USE SCHEMA, and SELECT commands on the following catalogs, schemas, and metadata tables:
system.information_schema.metastores
system.information_schema.schema_tags
system.information_schema.table_tags
system.information_schema.column_tags
system.information_schema.catalog_tags
system.information_schema.catalogs
<catalog>.information_schema.schemata
<catalog>.information_schema.tables
<catalog>.information_schema.columns
<catalog>.information_schema.key_column_usage
<catalog>.information_schema.table_constraints
<catalog>.information_schema.referential_constraints
<catalog>.information_schema.key_column_usage
<catalog>.information_schema.table_constraints
<catalog>.information_schema.key_column_usage
<catalog>.information_schema.routines
<catalog>.information_schema.routine_columns
<catalog>.information_schema.routines
<catalog>.information_schema.views
<catalog>.information_schema.tables
where <catalog> is a specific catalog to import;
Bridge Parameters
| Parameter Name | Description | Type | Values | Default | Scope | ||
| Server hostname | Enter the DatabricksUnityCatalogMetastore Server URL here. | STRING | localhost | Mandatory | |||
| HTTP Path | Enter the Azure Databricks compute resource's HTTP Path value import bridge will use to log in. See details - https://learn.microsoft.com/en-us/azure/databricks/integrations/jdbc-odbc-bi#retrieve-the-connection-details |
STRING | Mandatory | ||||
| Authentication method | Select the authentication method and provide the corresponding credentials: Databricks: Client ID and Client Secret: Databricks managed service principal authentication. Personal access token: Databricks personal access token authentication. Azure: Tenant ID: Microsoft Entra application tenant ID. Client ID: Microsoft Entra application client ID. Client Secret: Microsoft Entra application client secret. |
ENUMERATED |
|
Databricks | |||
| Tenant ID | Enter the Microsoft Entra application tenant ID used by import bridge to authenticate with Azure Databricks. This parameter is required when the Authentication method is set to Azure. | STRING | |||||
| Client ID | Enter the client ID used by import bridge for OAuth authentication. For the Databricks authentication method, enter the Databricks service principal client ID. For the Azure authentication method, enter the Microsoft Entra application client ID. | STRING | |||||
| Client Secret | Enter the client secret used by import bridge for OAuth authentication. For the Databricks authentication method, enter the Databricks service principal client secret. For the Azure authentication method, enter the Microsoft Entra application client secret. | PASSWORD | |||||
| Personal access token | Enter the Databricks personal access token used by import bridge to authenticate. This parameter applies only when the Authentication method is set to Databricks and Client ID and Client Secret are empty. | PASSWORD | |||||
| Catalogs | Name(s) of the catalog(s) you want to import. Separate names in the list with a semi-colon (;). When you want to import all catalogs in the warehouse leave the parameter empty. You can use SQL LIKE patterns to identify names of catalogs. | REPOSITORY_SUBSET | |||||
| Schemas | Name(s) of the schema(s) you want to import. Separate names in the list with a semi-colon (;). When you want to import all schema in the catalog leave the parameter empty. You can use SQL LIKE patterns to identify names of schemas. | REPOSITORY_SUBSET | |||||
| Tables | Name(s) of the table(s) you want to import. Separate names in the list with a semi-colon (;). When you want to import all tables in the schema leave the parameter empty. You can use SQL LIKE patterns to identify names of tables. | 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> 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) DATABRICKS UNITY CATALOG -http.path <path> HTTP path for the SQL Warehouse. Used only for data sampling and profiling. -metricview.skip Skip the Metric Views query text on a huge models to prevent call individual queries to get the Views query text. -semantic.hub Enable Semantic Hub-compatible model translation. ACCESS TOKEN -access.token <token> The pre-generated access token. There should be acccess token without Json frame. If you use some utility (CUrl) which produces Json responds like: \{"access_token":"eyJ***OcDfg","client_id":"a6ad***cc1d8",***"token_type":"Bearer"} the parameter should be: -access.token eyJ***OcDfg -model.split (previously -multiModel) Splits a large database model into multi models (e.g. one schema per model). Warning: this is a system option managed by the application calling this import bridge and should not be set by users. -deploy.catalog <catalog name> The catalog name to deploy to. -deploy.schema <schema name> The schema name to deploy to. |
STRING |
Bridge Mapping
Mapping information is not available