mssql

MSSQL Connector

This connector extracts technical metadata from a Microsoft SQL Server using System catalog views.

Note: For on-permise MSSQL server, we support SQL Server 2016 (13.x) and later

Setup

We recommend creating a dedicated MSSQL user with limited permissions for the connector to use

Use the following command to set up the read-only user for MSSQL database

-- navigate to master database
CREATE LOGIN <username> WITH PASSWORD = '<password>'
CREATE USER <username> FROM LOGIN <username>
-- switch to user MSSQL database
CREATE USER <username> FROM LOGIN <username>
GRANT VIEW DEFINITION TO <username>
GRANT VIEW DATABASE STATE TO <username>

Note: You'll need to run the above command for each database you'd like to connect to.

Required Configurations

username: <username>  # The MSSQL server login username

password: <password>  # The MSSQL server login password

endpoint: <endpoint>  # The MSSQL server endpoint

Optional Configurations

You could specfic server_name or tenant_id to connector.

server_name: <sever_name>  # specify server name for MSSQL server

tenant_id: <tenant_id>  # The azure directory (tenant) id

See Filter Configurations for more information on the optional filter config.

Output Destination

See Output Config for more information on the optional output config.

Testing

Follow the Installation instructions to install metaphor-connectors in your environment (or virtualenv). Make sure to include either all or mssql extra.

Run the following command to test the connector locally:

metaphor mssql <config_file>

Manually verify the output after the command finishes.