Configure the Azure Synapse Connector

Configure and run the Azure Synapse connector to import metadata into DataGalaxy.

2 min read

This article describes how DataGalaxy Azure Synapse connector works.

This connector is available in the following modes:

Desktop mode ✅SaaS Online mode ✅

For general information about how to connect to Azure Synapse, please refer to the service documentation here.

Connector scope

The connector allows you to import the following metadata from Azure Synapse into a Database source:

  • The set of schemas for a given database
  • The content of the schemas: tables, views and columns
  • Primary keys

The extracted objects and their correspondences are detailed in the following table:

Azure Synapse ObjectDataGalaxy ObjectComments
SchemaModel (Container)
TableTable (Structure)
ViewView
ColumnColumnName, data type (size and precision), order are returned when available.
Primary KeyPrimary Key

Configuration of a connection

Azure Synapse connector uses the ODBC Driver 17 for SQL Server by Microsoft.

The following information is required to set up a connection:

ParameterMandatoryDescription
ServerYesFull domain name (FQDN) of the Synapse instance, example: mysynapseserver.sql.azuresynapse.net Serverless and dedicated pools are both supported.
PortYesSynapse database TCP port, default 1433
DatabaseYesLimits the scope to the specified database (SQL Pool identifier)
Available authentication modes:
SQL/AAD password (desktop)/ AAD password with MFA (desktop)
UserYesUser name
PasswordYesUser password
AAD Service principal (desktop)
Tenant IDYesTenant ID
Client IDYesClient ID
Client SecretYesClient secret

Execution of the connector

To create a connection to Azure Synapse via the Online connector, the entry points are as follows:

  • From the Import button of the "Shortcuts" widget on the home screen of a client space or workspace
  • From the Import button of one of the modules when it is empty
  • From the Import button in the contextual menu of one of the modules, on the right side of the filtered views
  • From the Add a connection button in the Connector tab available in the workspace setup screen

You can optionally filter (by module, connector type or by using the search bar), then click on the desired technology:

You then need to complete the login form using the login information described above to perform an import. For more details on the steps involved in running the Online connector, you can consult the following article: Running the Online connector.

This technology is also available via the Desktop Connector, you can find more information on the procedure here: Desktop Connector Operating Mode.

Releases

DatePlugin VersionDataGalaxy releaseDesktop Connector version (minimum)Description
29/09/20263.0.13.423.06.2.2New internal implementation to fix security vulnerabilities
07/07/20262.0.3v3.376.05.18.2New internal implementation
16/07/20243.0.0v3.59.05.0.1Migrated from java 11 to java 17 + CVE fixes
08/03/20241.4.1v3.34.04.5.0Addition of authentication modes (desktop)

Read more

Related articles

Was this page helpful?