Matillion - 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 | Matillion |
| Tool Name | Matillion |
| Tool Version | Current |
| Tool Web Site | https://www.matillion.com/ |
| Supported Methodology | [Data Integration] Multi-Model, Data Store (Physical Data Model), ETL/ELT (Source and Target Data Stores, Transformation Lineage, Expression Parsing) via REST API on JSON File |
| Data Profiling |  |
| Incremental Harvesting |  |
| Multi-Model Harvesting | |
| Remote Repository Browsing for Model Selection | |
SPECIFICATIONS
Tool: Matillion / Matillion version Current via REST API on JSON File
See https://www.matillion.com/
Metadata: [Data Integration] Multi-Model, Data Store (Physical Data Model), ETL/ELT (Source and Target Data Stores, Transformation Lineage, Expression Parsing)
Component: MatillionETL 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 -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
Matillion ETL is a cloud-native Data Integration (DI/ETL) platform designed for modern data teams working with cloud data warehouses. It provides an intuitive UI and a low-code environment for building, orchestrating, and managing complex data pipelines. https://docs.matillion.com/metl/docs/0000001/ https://www.matillion.com/products/etl/
Matillion ETL supports native integration with cloud platforms such as Snowflake, Amazon Redshift, and Delta Lake on Databricks, offering scalability, performance, and enterprise-grade features.
Matillion provides an ETL design user interface where you may define job designs which are then used to derive SQL for execution, and the SQL transactions are logged at runtime. The data flow lineage of most conventional ETL tools (like PowerCenter or Talend) is produced by generating a runtime data lineage graph emulating the execution of the original design with the actual runtime parameters. Matillion ETL is implemented as an ELT, in such case the lineage is produced by parsing the generated SQL. The generated SQL can be found in the Matillion UI, by selecting any Table Output end step (on the right in red) of the design, then select the SQL tab (at the bottom next the Metadata tab) and make sure to select the Expand References check box.
This bridge requires the Matillion jobs to be working and have been executed within the past 7 days. Such execution logs can be found in the Matillion UI in the Project > Task History menu. Note that jobs are typically executed daily over that 7 days period, the bridge will detect similar jobs and factorize them to avoid duplicating lineage. If a job has been redesigned or modified, make sure to set an appropriate filter (e.g., using -task.history.started miscellaneous option) to avoid retrieving lineage from older versions.
The bridge uses the Matillion ETL REST API of the server to retrieve that SQL and runtime logging. The bridge parses these artifacts to determine the source/target data connections and the column level data flow lineage between the data connections. https://docs.matillion.com/metl/docs/9907241/ .
REQUIREMENTS
- Matillion ETL Authentication Requirements:
Requires the internal user with API permissions.
Ensure one of the following applies:
-Role. API - This role grants direct access to the Matillion API for this instance.
https://docs.matillion.com/metl/docs/8233018/#adding-users
-Group. Assigned to a group with at least the Reader role.
https://docs.matillion.com/metl/docs/2931106/
-Permission Set. The user has been granted appropriate API permissions manually via a custom permission set.
https://docs.matillion.com/metl/docs/2932106/
- Matillion ETL Metadata API Requirements:
-Requires Matillion ETL version 1.54.7 or higher;
-Requires Matillion ETL instance with Enterprise Mode;
-Requires Matillion ETL for Snowflake, Delta Lake on Databricks, or Amazon Redshift.
For details, see: https://docs.matillion.com/metl/docs/9907241/
LIMITATIONS
Refer to the current general known limitations at MIMB Known Limitations
- Matillion ETL Metadata API Limitations:
Lineage metadata older than seven days is automatically removed from the Matillion ETL server each day.
By default, no more than 30,000 task history records can be retrieved per environment. To avoid hitting this limit, use the miscellaneous option -task.history.started to apply an appropriate filter
- Bridge Limitations:
The Matillion ETL bridge currently supports the following component types:
-Run Transformation (Transform)
-Database Query (Load Connector)
-Google BigQuery (Load Connector)
-Create Table (DDL)
-SQL Script (DDL)
Bridge Parameters
| Parameter Name | Description | Type | Values | Default | Scope |
| Host | The hostname or IP address of your Matillion ETL instance, including the protocol (e.g., http://127.0.0.1 or https://your-hostname). This address will be used to access the Matillion ETL API Metadata Endpoint. Example values: https://desktop-88ak0 http://127.0.0.1 |
STRING | Mandatory | ||
| Username | The username used to authenticate with your Matillion ETL instance. For more details, see Bridge Requirements -> Matillion ETL Authentication requirements. |
STRING | Mandatory | ||
| Password | The password corresponding to the provided username. This credential will be used for authenticating API requests to your Matillion ETL instance. | PASSWORD | Mandatory | ||
| Groups | A semicolon-separated list of group names in your Matillion ETL instance. Only jobs and metadata associated with the specified groups will be included in the bridge’s output. Example values: default;finance;marketing |
REPOSITORY_SUBSET | |||
| Projects | A semicolon-separated list of project names within the specified Matillion groups. The bridge will extract metadata only from these projects. Example values: default/customers_staging;finance/orders_distribute;marketing/reviews_development |
REPOSITORY_SUBSET | |||
| Environments | A semicolon-separated list of environment names within the selected projects. The bridge will use these environments to scope metadata extraction. Example values: default/customers_staging/Dev;finance/orders_distribute/Production;marketing/reviews_development/QA |
REPOSITORY_SUBSET | Mandatory | ||
| 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) MATILLION OPTIONS -task.history.started Date Filters all input data to include only tasks that started after the specified date in the format MM-dd-yyyy. (e.g. 06-18-2025) The value is converted to milliseconds since the Unix epoch (UTC). |
STRING |
Bridge Mapping
Mapping information is not available