Create a Microsoft SQL Server Connection

This guide shows you how to create a MSSQL connection in Ascend

Prerequisites

• An existing Ascend project (see: Create a Project)
• An existing Ascend Workspace (see: Setting Up a Workspace)
• Credentials for your sql_server database
  • Username: Username of the account used to connect to MSSQL
  • Password: Password of the account used to connect to MSSQL
• An ODBC driver will be necessary for the connection configuration

UI

Locate Your Project Folder

1. From your Ascend Instance Homepage, click on your Workspace to open it.
2. From here, click on the Files icon on the left navigation bar. This will open the File Tree in the left panel.
3. In your File Tree, locate your top-level project folder and open it.
4. Within the project folder, locate the connections folder.

Add a New Connection File

1. Right-click on the connections folder and click New File.
2. Provide the file with a name and a .yaml extension, such as mssql_connection.yaml. This will open the empty file in the build pane.
3. From here, you can enter the details for your connection.

Enter Connection Details

Your new connection file will open in the build panel. Enter the following YAML configuration, replacing the placeholder values with your MSSQL connection details:

/my_project/connections/mssql_connection.yaml

connection:
  mssql:
    host: <hostname>
    port: 1433 # default value is 1433, can modify as needed
    schema: <schema>
    database: <database>
    user: <username>
    password: ${secret.<your_vault>.<password>}
    driver: ODBC Driver 18 for SQL Server # default value is ODBC Driver 18 for SQL Server, can use FreeTDS instead

To view all available connection options, see the MSSQL Connection Reference.

Once you have entered your Connection details, click "Save" to save the file and click "Build Project" to apply the changes.

Now that you have created a MSSQL connection, you can start ingesting data from MSSQL or writing data out to MSSQL.