Connecting to Azure Synapse Analytics
Introduction
We recommend using metadata import in the Portal as the primary method of connecting your data sources.
The Portal offers significant advantages compared to the Desktop application:
- Import multiple sources in a single flow.
- Schedule recurring tasks (metadata import, profiling, and data quality checks).
- Manage connections centrally.
Import through Desktop is still available and allows importing one source at a time.
You can find the instructions at the bottom of this page.
Importing Metadata in Dataedo Portal
Entry point
To start the Metadata Import flow, make sure you have the Connection Manager role.
Then navigate to:
Connections -> Add new connection -> Azure Synapse Analytics (SQL Data Warehouse)
This will open the import wizard described in the following steps.
Step 1. Host details
Provide connection details such as host, port, and connection mode.
You will also be asked to name the Connection.
A Connection in Dataedo represents a saved configuration for accessing a data source.
It can be reused for future imports and scheduling.
Step 2. Credentials
Choose credentials from the list of existing ones available for the selected connector, or add new credentials.
Step 3. Data Sources
- The Portal will display all data sources accessible with the provided credentials.
- For Synapse, this means SQL pools/databases that can be imported.
- You can select multiple sources at once and use the search box to narrow down results.
- Each selected source should be given a Title, which will be visible in Dataedo.
- At this step, the Portal also retrieves the number of assets in each source.
Step 4. Extended properties (optional)
This step appears only if the source exposes Extended Properties.
You can map them to Custom Fields in Dataedo, or skip this step entirely.
If skipped, no extended properties will be imported.
Step 5. Objects to import
For each selected source, you can refine which objects to import:
- Select schemas and object types (tables, views, procedures, functions, etc.).
- Use Advanced filters to include or exclude objects with:
- schema patterns
- name patterns
Step 6. Linked sources (optional)
A linked source refers to a connection between databases or systems established during the import process.
They are essential for data lineage, enabling visualization and tracking of how data flows and transforms across systems.
In this step, you can map linked sources to existing Dataedo sources. This mapping can also be updated later in the Connection details.
Step 7. Schedule
Configure scheduling options for each source individually:
- Define tasks you want to schedule (Metadata Import, Data Quality run, Refresh Profiling).
- Run daily, on selected weekdays, or on specific days of the month.
- Choose an exact time of execution.
- Task state:
Active- the task will run as scheduled.Draft- the task is saved but not executed until switched to Active.
- Run immediately - when checked, the task will also be executed right after clicking
Create connection.
Only one source in a metadata import can have Run immediately selected.
You must configure at least one import task in the schedule section.
If you skip this, an empty database will be created and no metadata will be imported.
Importing Metadata in Dataedo Desktop
Metadata import is also possible using Dataedo Desktop.
In this mode, you can only import one source at a time.
Add new connection
To connect to a Synapse instance, create new documentation by clicking Add and choosing Database connection.
On the connection screen, choose Azure Synapse Analytics (SQL Data Warehouse).
Connection details
Provide connection details:
- Server name - Name of the server you would like to connect to
- Port - Port of the service
- Authentication - Select the way you want to authorize.
- Username/password
- Username - Username to your Synapse, e.g., [email protected]
- Password - Password to your Synapse.
- Username/password
- Connection mode - Select the way you want to encrypt data
- Database - Name of the Synapse database
- Automatic lineage - Disable or enable importing lineage
- Parse SQL - Disable or enable parsing view scripts to get lineage
- Data lineage from query history - Disable or enable getting lineage from parsing queries from
sys.dm_pdw_exec_request
Connection details in Synapse Serverless
There are no differences in connecting to Synapse Serverless.
Saving password
You can save the password for later connections by checking the Save password option. Passwords are securely stored in the repository database.
Importing schema
When the connection is successful, Dataedo will read objects and show a list of schemas found. You can choose which schemas and object types to import and also use an advanced filters.
Confirm the list of objects to import by clicking Next.
The next screen allows you to change the default name of the documentation under which your schema will be visible in the Dataedo repository.
Confirm the list of objects to import by clicking Next.
The next screen allows you to change the default name of the documentation under which your schema will be visible in the Dataedo repository.
Click Import to start the import.
When done, close the import window with the Finish button.
Importing changes
To sync any changes in the schema in Synapse and reimport any technical metadata, simply choose the Import changes option. You will be asked to connect to Azure Synapse Analytics again, and changes will be synced from the source.
Scheduling imports
You can also schedule metadata updates using command-line files. To do it, after creating documentation, use the Save update command option. The downloaded file can be run in the command line, which will reimport changes to your documentation.
Service principal authentication
For configuration steps and required Azure permissions, see:
Connecting to Azure Synapse Analytics Using Service Principal
Azure support
Learn more about Azure support:
