Connection Options

• Username: Specify the User to connect to Synapse. It should have enough privileges to read all the metadata.
• Password: Password to connect to Synapse.
• Host and Port: Enter the fully qualified hostname and port number for your Synapse deployment in the Host and Port field.
• Database: The database of the data source is an optional parameter, if you would like to restrict the metadata reading to a single database. If left blank, OpenMetadata ingestion attempts to scan all the databases.
• Driver: Connecting to Synapse requires ODBC driver to be installed. Specify ODBC driver name in the field. You can download the ODBC driver from here. In case of docker or kubernetes deployment this driver comes out of the box with version ODBC Driver 18 for SQL Server.

Authentication Mode:

• Authentication:

  • The authentication parameter determines the method of authentication when connecting to Synapse using ODBC (Open Database Connectivity).
  • If you select "Active Directory Password", you'll need to provide the password associated with your Azure Active Directory account.
  • Alternatively, if you choose "Active Directory Integrated", the connection will use the credentials of the currently logged-in user. This mode ensures secure and seamless connections with Synapse.

• Encrypt:

  • The encrypt setting in the connection string pertains to data encryption during communication with Synapse.
  • When enabled, it ensures that data exchanged between your application and the database is encrypted, enhancing security.

• Trust Server Certificate:

  • The trustServerCertificate option also relates to security.
  • When set to true, your application will trust the server's SSL certificate without validation. Use this cautiously, as it bypasses certificate validation checks.

• Connection Timeout:

  • The connectionTimeout parameter specifies the maximum time (in seconds) that your application will wait while attempting to establish a connection to Synapse.
  • If the connection cannot be established within this timeframe, an error will be raised.

Advanced Configuration

Database Services have an Advanced Configuration section, where you can pass extra arguments to the connector and, if needed, change the connection Scheme.

This would only be required to handle advanced connectivity scenarios or customizations.

• Connection Options (Optional): Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
• Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent during the connection. These details must be added as Key-Value pairs.

Advanced Configuration

Metadata Ingestion Options

• Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.

• Database Filter Pattern (Optional): Use to database filter patterns to control whether or not to include database as part of metadata ingestion.

  • Include: Explicitly include databases by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all databases with names matching one or more of the supplied regular expressions. All other databases will be excluded.
  • Exclude: Explicitly exclude databases by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all databases with names matching one or more of the supplied regular expressions. All other databases will be included.

• Schema Filter Pattern (Optional): Use to schema filter patterns to control whether to include schemas as part of metadata ingestion.

  • Include: Explicitly include schemas by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all schemas with names matching one or more of the supplied regular expressions. All other schemas will be excluded.
  • Exclude: Explicitly exclude schemas by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all schemas with names matching one or more of the supplied regular expressions. All other schemas will be included.

• Table Filter Pattern (Optional): Use to table filter patterns to control whether to include tables as part of metadata ingestion.

  • Include: Explicitly include tables by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all tables with names matching one or more of the supplied regular expressions. All other tables will be excluded.
  • Exclude: Explicitly exclude tables by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all tables with names matching one or more of the supplied regular expressions. All other tables will be included.

• Enable Debug Log (toggle): Set the Enable Debug Log toggle to set the default log level to debug.

• Mark Deleted Tables (toggle): Set the Mark Deleted Tables toggle to flag tables as soft-deleted if they are not present anymore in the source system.

• Mark Deleted Tables from Filter Only (toggle): Set the Mark Deleted Tables from Filter Only toggle to flag tables as soft-deleted if they are not present anymore within the filtered schema or database only. This flag is useful when you have more than one ingestion pipelines. For example if you have a schema

• includeTables (toggle): Optional configuration to turn off fetching metadata for tables.

• includeViews (toggle): Set the Include views toggle to control whether to include views as part of metadata ingestion.

• includeTags (toggle): Set the 'Include Tags' toggle to control whether to include tags as part of metadata ingestion.

• includeOwners (toggle): Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.

• includeStoredProcedures (toggle): Optional configuration to toggle the Stored Procedures ingestion.

• includeDDL (toggle): Optional configuration to toggle the DDL Statements ingestion.

• queryLogDuration (Optional): Configuration to tune how far we want to look back in query logs to process Stored Procedures results.

• queryParsingTimeoutLimit (Optional): Configuration to set the timeout for parsing the query in seconds.

• useFqnForFiltering (toggle): Regex will be applied on fully qualified name (e.g service_name.db_name.schema_name.table_name) instead of raw name (e.g. table_name).

• Incremental (Beta): Use Incremental Metadata Extraction after the first execution. This is done by getting the changed tables instead of all of them. Only Available for BigQuery, Redshift and Snowflake

  • Enabled: If True, enables Metadata Extraction to be Incremental.
  • lookback Days: Number of days to search back for a successful pipeline run. The timestamp of the last found successful pipeline run will be used as a base to search for updated entities.
  • Safety Margin Days: Number of days to add to the last successful pipeline run timestamp to search for updated entities.

• Threads (Beta): Use a Multithread approach for Metadata Extraction. You can define here the number of threads you would like to run concurrently. For further information please check the documentation on Metadata Ingestion - Multithreading

Note that the right-hand side panel in the OpenMetadata UI will also share useful documentation when configuring the ingestion.