How to set up Microsoft Azure Synapse Analytics

πŸ€“ Who can do this? You will probably need your Microsoft Azure Synapse Analytics administrator to run these commands β€” you may not have access yourself.
πŸ’ͺ Did you know? Atlan currently only supports crawling dedicated SQL pools (formerly SQL DW) with the Microsoft Azure Synapse Analytics package.

Atlan supports only the SQL server authentication method for fetching metadata from Microsoft Azure Synapse Analytics. This method uses a username and password to fetch metadata.

Create a login

You will need to connect to the master database for integration with Atlan.

To create a login with a specific password for integrating with Atlan:

CREATE LOGIN <login_name> WITH PASSWORD = '<password>';
  • Replace <login_name> with the name of the login.
  • Replace <password> with the password for the login.

Create a user

You will need to connect to the target database that you want to crawl in Atlan.

To create a user for that login:

CREATE USER <username> FOR LOGIN <login_name>;
  • Replace <username> with the username to use when integrating Atlan.
  • Replace <login_name> with the name of the login used in the previous step.

Grant permissions

Crawl, preview, and query assets

You will need to connect to the target database that you want to crawl in Atlan.

To grant the minimum permissions needed to crawl, preview, and query assets in a dedicated SQL pool:

GRANT SELECT ON DATABASE::<database_name> TO <username>;
  • Replace <database_name> with the name of the database.
  • Replace <username> with the username created above.
🚨 Careful! You must grant permissions to the user for all databases except the system databases (master, tempdb, msdb, and model). The Microsoft Azure Synapse Analytics crawler will fail without these permissions.

Mine view lineage

To also mine lineage for dedicated SQL pool views, add these permissions:

GRANT VIEW DEFINITION ON DATABASE::<database_name> TO <username>;

Find your SQL pool server

To find the server name of your dedicated SQL pool for crawling Microsoft Azure Synapse Analytics:

  1. Sign in to the Azure portal and search for and select Azure Synapse Analytics.
  2. From the Azure Synapse Analytics page, select Synapse workspace.
  3. From Synapse workspace, select the Synapse workspace to which you want to connect Atlan. 
  4. From the Overview page, navigate to SQL endpoint and copy the server name of your dedicated SQL pool and save it in a temporary location.

Related articles

Was this article helpful?
0 out of 0 found this helpful