Synapse

Start Here

It's time to start the technical onboarding with Catalog. It's pretty simple; you need to grant access to your Synapse metadata to Catalog and to perform a couple of tests.

Which rights do you need to complete the onboarding ?

You will need to be able to use an admin role on synapse, in order to create a user and grants him privileges.

1. Whitelist Catalog's IP on Synapse

Needed only if you've set up network policies, meaning your Synapse instance only accepts connections coming from specific IPs, typically if you need to activate a VPN to query Synapse from your computer.

If applicable then here the Catalog IP to whitelist: 35.246.176.138

2. Create Catalog User on Synapse

2.1 Create a dedicated user

CREATE LOGIN catalog WITH PASSWORD = '<password>';

2.2 Grant it the needed rights

GRANT VIEW DATABASE STATE TO catalog;
GRANT VIEW DEFINITION TO catalog;

If you're interested you can see what is behind this DEFINITION grant here. Same for DATABASE here.

3. Add new credentials in Catalog App

Use the following format to input your credentials in the Catalog App here

{
    "host": "******",
    "username": "******",
    "password": "******",
    "port": 1433,
    "database": "database_name"
}

• host: Full Server Name, Azure documentation to retrieve it

• port: 1433 usually

• database: Your Database Name

• username: Username created above

• password: Password of the user