Create a Microsoft SQL Server Connection

This guide shows you how to create a Microsoft SQL connection in Ascend.

Prerequisites

• Ascend Project
• Ascend Workspace
• Credentials for your sql_server database
  • Username: Username of the account used to connect to Microsoft SQL
  • Password: Password of the account used to connect to Microsoft SQL
• An ODBC driver will be necessary for the connection configuration

Create a new Microsoft SQL Server Connection

Begin from your workspace Super Graph view. Follow these steps to create your connection:

Using the Connection Form

1. To start creating a connection, either:
   • Click the + button next to Connections in the left Build panel
   
   • Or right-click anywhere in the Super Graph and hover over Create Connection
   
2. Name your connection `read_mssql`
3. Select Microsoft SQL Server from the available options
4. Complete the required form fields (along with any desired optional fields)

5. Scroll to the bottom and click Save to create your Connection

Using the Files Panel

1. Open the files panel in the top left corner
2. Right-click on the Connections directory and choose New File

3. Name your file with a descriptive name like `read_mssql.yaml` and press enter

To learn more about the different options for Connections, check out our reference guide.

Example

Use the following YAML template for your Microsoft SQL connection. Customize the highlighted placeholder values with your specific 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: ${vaults.<your_vault>.<password>}
    driver: ODBC Driver 18 for SQL Server # default value is ODBC Driver 18 for SQL Server, can use FreeTDS instead