Skip to content

Edit MSSQL Data Source

This page explains updating an existing MSSQL data source in the Pirivision Port module via the Edit action.

Use this flow when the SQL Server has moved, password rotation has occurred, the database name has changed, or you want to move the data source to a different folder.

Prerequisite

At least one MSSQL data source must be saved in the Port list. If none, see Add MSSQL Data Source first.

1. Find the Data Source in the Port List

Click Port in the left menu. Find the MSSQL data source you want to edit in the list.

Port list — MSSQL data source card

You can use the search bar in the list to filter by data source name or by #tag.

2. Click the Edit Button

The Edit button (pencil icon) is on the right side of the data source card.

Click the Edit button.

Tip

The Edit button appears directly on the card. Access via the More menu is not required.

3. The Edit Form Opens

When Edit is clicked, the form opens with current values pre-filled. This is the same screen as the new data source form; the only differences are the pre-filled values and the Test and Update button at the bottom.

MSSQL Edit Form — pre-filled values

4. Editable Fields

The following fields can be edited:

Section Field Required Default Description
Display Info Name Yes — The display name of the data source within Pirivision
Display Info Description No — Short description text
Connection Settings Database Name Yes — Name of the database to connect to
Connection Settings Host Yes — IP or domain of the server
Connection Settings Port Yes 1433 SQL Server connection port
Authentication Username Yes — SQL Server username
Authentication Password Yes — User's password
Location Target Folder No — Location of the data source in the Port folder structure

No Schema in MSSQL

The MSSQL data source has no separate Schema field like PostgreSQL. Schema is specified in the query in Compass via the [schema].[table] notation.

Non-Editable Field

Field Status
Data source type Stays fixed as MSSQL; cannot be converted to PostgreSQL, MySQL, etc.

5. Test and Update Button

After all fields are updated, click the Test and Update button at the bottom right.

This works in two stages:

  1. The SQL Server connection is tested with the entered info.
  2. If the test succeeds, the updated values are saved.

The bottom of the form shows:

Connection will be saved automatically if the test is successful

Success

If the test succeeds, the updated data source is redirected to the Port list. The Compass query cache associated with the connection is automatically invalidated; queries run with the most up-to-date connection.

Failure

If the test fails, the updated info is not saved. Check host, port, database name, username, and password info.

6. Common Errors

Error / Symptom Possible Cause Solution
a datasource with this name already exists, please choose a different name Another data source with the same name exists Enter a different Name value
you do not have permission to update this datasource or the datasource was not found The data source belongs to another user or was deleted Refresh the Port list; contact admin if needed
user not found Session expired Log in again
update failed: ... Connection test failed Verify connection parameters and network access
Login failed for user '...' Wrong username or password Verify SQL Server Authentication credentials
Cannot open database '...' requested by the login Wrong Database Name Check the actual database name in SSMS
Timeout Server unreachable Check firewall, VPN, and TCP/IP protocol settings
TCP/IP connection cannot be established TCP/IP disabled in SQL Server Enable TCP/IP in SQL Server Configuration Manager

7. Next Step

After the data source is updated, Compass queries that use this source automatically use the new connection parameters. You can verify the query still runs correctly by running a test query in Compass.

flowchart LR
    A["Port<br/>MSSQL Edited"] --> B["Compass<br/>Query Verification"]
    B --> C["Cartography<br/>Chart / KPI (no changes)"]

Summary

The MSSQL data source editing process:

  1. Open the Port module.
  2. Find the MSSQL data source in the list.
  3. Click Edit on the card.
  4. The form opens pre-filled with current values.
  5. Update the relevant fields.
  6. Test and save the connection with Test and Update.
  7. Verify the query in Compass.