SQL Server Lineage Connector

SQL Server Lineage Plus Connector – User Setup

To enable Bigeye to connect to SQL Server and retrieve data lineage, you will need to create a read-only user account and configure connection parameters.


1. Create a SQL Server Read-Only User

Follow the instructions in the Bigeye documentation to set up a read-only user for SQL Server:

👉 Create a SQL Server Read-Only User


Configuration Parameters

Configure the following connector parameters:

ParameterDescription
db.connection.url
db.connection.driver_class
db.connection.username
db.connection.password
db.catalog.name.include
db.catalog.name.exclude
db.query.fetchsize
has_master_db_accessAuto-detected for Azure hostnames (.database.windows.net). Set to false for Azure SQL Database instances with non-standard hostnames. Defaults to true for standard SQL Server.

Azure SQL Database Support

The SQL Server connector supports Azure SQL Database in addition to standard SQL Server instances. Azure SQL Database does not provide access to the master database, so the connector automatically detects this and routes the connection through the appropriate execution path.

Automatic detection

If your connection hostname ends with .database.windows.net, the connector automatically detects that it is an Azure SQL Database and configures itself accordingly. No additional configuration is required.

Manual configuration

For Azure SQL Database instances with non-standard hostnames, set has_master_db_access to false in your connector configuration:

connectors:
  - type: sqlserver
    connections:
      - connection_name: my_azure_sql_db
        has_master_db_access: false

Interactive setup

When adding a SQL Server connection via the Agent CLI, the installer detects Azure hostnames and prompts:

Does this connection have access to the master database? (Azure SQL typically does not)

The default is false for Azure hostnames and true for all others.


Summary of Steps

  1. Create a read-only SQL Server user (see Bigeye SQL Server Docs).
  2. Configure the connection parameters in Bigeye.