Skip to main content

Configure SQL Server

Prerequisites

  • Have an MSSQL Server instance hosted and network accessible from your Alteryx Server controllers.

    • Alteryx Server supports MSSQL Server 2019 and 2022.

    • Use a separate SQL database for AlteryxGallery/AlteryxService to access.

    • The SQL database access user must initially have admin privileges to create and use any databases Alteryx Server requires. Once the SQL setup is complete and any migration from MongoDB to SQL (if applicable) has been carried out, these privileges can be reduced. However, the user will still need permissions to read, write, delete records, and create or delete tables, but full database creation rights will no longer be necessary.

    • We recommend your SQL DB size to be twice the size of your existing MongoDB. For more information, go to Server SQL DB Customer FAQ.

  • Install SQL Server drivers.

  • Optional: Access to SQL Server Management Studio. This allows you to view and access database data manually so you can verify and validate the state of your data without accessing your Server.

Set-Up Instructions

For both options below, Alteryx Server will automatically create the necessary databases and tables within your SQL Server instance required by Alteryx Server. To ensure a seamless setup and proper DB initialization, we strongly advise relying on this functionality as opposed to creating the databases and tables manually.

  • For new Server environments, set up user-managed MSSQL in Alteryx System Settings under the Controller and Server UI sections. For each of these settings, add a distinct SQL connection string. For more information on how to structure these connection strings, go to the SQL DB Advanced Connection Strings help page.Controller(控制器)

  • To migrate to MSSQL from MongoDB, follow the instructions in the Mongo to SQL Migration Guide. If you currently use embedded MongoDB or user-managed MongoDB, you have the option to migrate to MSSQL as of Server 2024.1.

For more information about SQL DB schemas, visit AlteryxGallery SQL DB Schema and AlteryxService SQL DB Schema.

For information on how to reset database credentials, go to Set New SQL DB Credentials.