Microsoft SQL Server

This guide shows you how to create a Microsoft SQL Server 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 Microsoft SQL Server Connection

From your workspace Super Graph view, follow these steps:

Form

1. Create a Connection by either:
   • Clicking the + button next to Connections in the left Build panel
   
   • Right-clicking in the Super Graph and selecting Create Connection
   
2. Enter a descriptive name like `read_mssql`
3. Select Microsoft SQL Server from the available options
4. Fill in the required fields (and any optional fields as needed)
5. Click Save at the bottom to create your Connection

Files panel

1. Open the Files panel in the top left
2. Right-click the Connections directory and select New File

3. Give your file a descriptive name like `read_mssql.yaml`

For complete configuration options, see our Connection reference guide.

Example

Use the following YAML template for your Microsoft SQL Server 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

🎉 Congratulations, you just set up a Microsoft SQL Connection in Ascend!