Skip to content

feat(credentials): saved PostgreSQL, MySQL, and SQL Server connections #9929

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
waleedlatif1 merged 13 commits into from
Nov 12, 2026
Merged

feat(credentials): saved PostgreSQL, MySQL, and SQL Server connections #9929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
54681da
refactor(credentials): share the owner-scoped service-account secret …
waleedlatif1 Nov 12, 2026
8c86920
feat(credentials): saved PostgreSQL, MySQL, and SQL Server connections
waleedlatif1 Nov 12, 2026
36d1ff6
feat(database-tools): run PostgreSQL, MySQL, and SQL Server tools on …
waleedlatif1 Nov 12, 2026
98f88c1
feat(blocks): credential-only PostgreSQL, MySQL, and SQL Server blocks
waleedlatif1 Nov 12, 2026
69e4fa2
docs(integrations): set up saved PostgreSQL, MySQL, and SQL Server co…
waleedlatif1 Nov 12, 2026
9c55072
refactor(database-tools): wrap SQL families at registration and deriv…
waleedlatif1 Nov 12, 2026
8f704cf
fix(credentials): describe saved-connection TLS modes as the drivers …
waleedlatif1 Nov 12, 2026
5f23767
refactor(credentials): derive stored database connection fields and c…
waleedlatif1 Nov 12, 2026
603e91e
fix(credentials): validate the saved-connection port in the form and …
waleedlatif1 Nov 12, 2026
0c06e59
docs(credentials): document the database connection provider id helpers
waleedlatif1 Nov 12, 2026
5fe7134
fix(credentials): keep an encryption failure on a verified database c…
waleedlatif1 Nov 12, 2026
471705c
docs(credentials): document the database connection descriptor and id…
waleedlatif1 Nov 12, 2026
7ba8f3d
docs(databases): describe the PostgreSQL, MySQL and SQL Server connec…
waleedlatif1 Nov 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions apps/docs/components/ui/icon-mapping.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -630,7 +630,9 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
mongodb: MongoDBIcon,
mothership: Blimp,
mssql: MicrosoftSqlIcon,
mssql_v2: MicrosoftSqlIcon,
mysql: MySQLIcon,
mysql_v2: MySQLIcon,
neo4j: Neo4jIcon,
netsuite: NetSuiteIcon,
neverbounce: NeverBounceIcon,
Expand Down Expand Up @@ -668,6 +670,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
planetscale_v2: PlanetScaleIcon,
polymarket: PolymarketIcon,
postgresql: PostgresIcon,
postgresql_v2: PostgresIcon,
posthog: PosthogIcon,
powerbi: PowerBIIcon,
profound: ProfoundIcon,
Expand Down
56 changes: 12 additions & 44 deletions apps/docs/content/docs/integrations/mssql.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,25 @@
title: Microsoft SQL Server
description: Connect to Microsoft SQL Server database
integration:
type: "mssql"
type: "mssql_v2"
color: "#FFFFFF"
---

import { ReferenceDetails } from "@/components/ui/reference-details"


{/* MANUAL-CONTENT-START:intro */}
Use [Microsoft SQL Server](https://www.microsoft.com/sql-server) to query or modify rows, execute T-SQL, and inspect tables, keys, and indexes. Configure the host, port, database, credentials, and TLS settings for your instance.
Use [Microsoft SQL Server](https://www.microsoft.com/sql-server) to query or modify rows, execute T-SQL, and inspect tables, keys, and indexes.

### Connection setup

In **Integrations**, add a connection with the host, port, database, username, password, and transport-security settings. Sim proves the connection with `SELECT 1` before saving it encrypted, then reads it on the server for each run; the block, the workflow, and agents never see the password. Reconnect the connection from Integrations when its credentials change. The runtime must be able to reach the database host.

- **Encrypt connection** requests TLS; leave it enabled. A server that does not support encryption gets an unencrypted session rather than an error, so confirm the server has encryption on.
- **Trust server certificate** skips certificate validation. Enable it only for a server with a self-signed certificate you trust.
- Named instances are not supported; give the instance a static TCP port and connect to that port.

Workflows built before saved connections keep their inline connection fields and run unchanged.
{/* MANUAL-CONTENT-END */}

## Use the block [#usage-instructions]
Expand All @@ -29,13 +39,6 @@ Execute a SELECT query on a Microsoft SQL Server database

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `host` | string | Yes | Microsoft SQL Server hostname or IP address |
| `port` | number | No | Server port \(default: 1433\). A named instance must be reached through its static TCP port |
| `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Database username |
| `password` | string | Yes | Database password |
| `encrypt` | string | No | Request TLS encryption for the connection \(enabled, disabled\). Defaults to enabled. Disabling sends the login packet and every row in cleartext. Enabling requests encryption over TDS 7.4, which the server negotiates during prelogin - a server that answers NOT_SUP yields an unencrypted session rather than an error, so this is a request, not a guarantee |
| `trustServerCertificate` | string | No | Trust a self-signed server certificate \(enabled, disabled\). Defaults to disabled. Enabling skips certificate validation, so the connection is open to a machine-in-the-middle |
| `connectionTimeout` | number | No | Connection and request timeout in milliseconds \(default: 15000\) |
| `query` | string | Yes | T-SQL SELECT query to execute, optionally led by a WITH clause. Statements that modify data or schema are rejected — use the Execute Raw SQL operation for those. |

Expand All @@ -61,13 +64,6 @@ Insert data into a Microsoft SQL Server table

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `host` | string | Yes | Microsoft SQL Server hostname or IP address |
| `port` | number | No | Server port \(default: 1433\). A named instance must be reached through its static TCP port |
| `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Database username |
| `password` | string | Yes | Database password |
| `encrypt` | string | No | Request TLS encryption for the connection \(enabled, disabled\). Defaults to enabled. Disabling sends the login packet and every row in cleartext. Enabling requests encryption over TDS 7.4, which the server negotiates during prelogin - a server that answers NOT_SUP yields an unencrypted session rather than an error, so this is a request, not a guarantee |
| `trustServerCertificate` | string | No | Trust a self-signed server certificate \(enabled, disabled\). Defaults to disabled. Enabling skips certificate validation, so the connection is open to a machine-in-the-middle |
| `connectionTimeout` | number | No | Connection and request timeout in milliseconds \(default: 15000\) |
| `table` | string | Yes | Table name to insert data into |
| `data` | object | Yes | Data object to insert \(key-value pairs\) |
Expand All @@ -94,13 +90,6 @@ Update rows in a Microsoft SQL Server table

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `host` | string | Yes | Microsoft SQL Server hostname or IP address |
| `port` | number | No | Server port \(default: 1433\). A named instance must be reached through its static TCP port |
| `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Database username |
| `password` | string | Yes | Database password |
| `encrypt` | string | No | Request TLS encryption for the connection \(enabled, disabled\). Defaults to enabled. Disabling sends the login packet and every row in cleartext. Enabling requests encryption over TDS 7.4, which the server negotiates during prelogin - a server that answers NOT_SUP yields an unencrypted session rather than an error, so this is a request, not a guarantee |
| `trustServerCertificate` | string | No | Trust a self-signed server certificate \(enabled, disabled\). Defaults to disabled. Enabling skips certificate validation, so the connection is open to a machine-in-the-middle |
| `connectionTimeout` | number | No | Connection and request timeout in milliseconds \(default: 15000\) |
| `table` | string | Yes | Table name to update |
| `data` | object | Yes | Data object with the columns to set \(key-value pairs\) |
Expand Down Expand Up @@ -128,13 +117,6 @@ Delete rows from a Microsoft SQL Server table

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `host` | string | Yes | Microsoft SQL Server hostname or IP address |
| `port` | number | No | Server port \(default: 1433\). A named instance must be reached through its static TCP port |
| `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Database username |
| `password` | string | Yes | Database password |
| `encrypt` | string | No | Request TLS encryption for the connection \(enabled, disabled\). Defaults to enabled. Disabling sends the login packet and every row in cleartext. Enabling requests encryption over TDS 7.4, which the server negotiates during prelogin - a server that answers NOT_SUP yields an unencrypted session rather than an error, so this is a request, not a guarantee |
| `trustServerCertificate` | string | No | Trust a self-signed server certificate \(enabled, disabled\). Defaults to disabled. Enabling skips certificate validation, so the connection is open to a machine-in-the-middle |
| `connectionTimeout` | number | No | Connection and request timeout in milliseconds \(default: 15000\) |
| `table` | string | Yes | Table name to delete rows from |
| `where` | string | Yes | WHERE condition identifying the rows to delete |
Expand All @@ -161,13 +143,6 @@ Execute a raw T-SQL statement on a Microsoft SQL Server database

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `host` | string | Yes | Microsoft SQL Server hostname or IP address |
| `port` | number | No | Server port \(default: 1433\). A named instance must be reached through its static TCP port |
| `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Database username |
| `password` | string | Yes | Database password |
| `encrypt` | string | No | Request TLS encryption for the connection \(enabled, disabled\). Defaults to enabled. Disabling sends the login packet and every row in cleartext. Enabling requests encryption over TDS 7.4, which the server negotiates during prelogin - a server that answers NOT_SUP yields an unencrypted session rather than an error, so this is a request, not a guarantee |
| `trustServerCertificate` | string | No | Trust a self-signed server certificate \(enabled, disabled\). Defaults to disabled. Enabling skips certificate validation, so the connection is open to a machine-in-the-middle |
| `connectionTimeout` | number | No | Connection and request timeout in milliseconds \(default: 15000\) |
| `query` | string | Yes | T-SQL statement to execute |

Expand All @@ -193,13 +168,6 @@ Introspect a Microsoft SQL Server schema to retrieve table structures, columns,

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `host` | string | Yes | Microsoft SQL Server hostname or IP address |
| `port` | number | No | Server port \(default: 1433\). A named instance must be reached through its static TCP port |
| `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Database username |
| `password` | string | Yes | Database password |
| `encrypt` | string | No | Request TLS encryption for the connection \(enabled, disabled\). Defaults to enabled. Disabling sends the login packet and every row in cleartext. Enabling requests encryption over TDS 7.4, which the server negotiates during prelogin - a server that answers NOT_SUP yields an unencrypted session rather than an error, so this is a request, not a guarantee |
| `trustServerCertificate` | string | No | Trust a self-signed server certificate \(enabled, disabled\). Defaults to disabled. Enabling skips certificate validation, so the connection is open to a machine-in-the-middle |
| `connectionTimeout` | number | No | Connection and request timeout in milliseconds \(default: 15000\) |
| `schema` | string | No | Schema to introspect \(default: dbo\) |

Expand Down
51 changes: 13 additions & 38 deletions apps/docs/content/docs/integrations/mysql.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,28 @@
title: MySQL
description: Connect to MySQL database
integration:
type: "mysql"
type: "mysql_v2"
color: "#FFFFFF"
---

import { ReferenceDetails } from "@/components/ui/reference-details"


{/* MANUAL-CONTENT-START:intro */}
Use [MySQL](https://www.mysql.com/) to query rows, insert or modify records, execute raw SQL, and inspect databases, tables, columns, keys, and indexes. Configure the host, port, database, credentials, and SSL mode for the target server.
Use [MySQL](https://www.mysql.com/) to query rows, insert or modify records, execute raw SQL, and inspect databases, tables, columns, keys, and indexes.

Query returns rows and a row count. Insert, update, and delete operations accept the data or WHERE clause documented below. Raw SQL can also change schema; use a database account with the permissions the workflow needs.

### Connection setup

In **Integrations**, add a connection with the host, port, database, username, password, and transport-security settings. Sim proves the connection with `SELECT 1` before saving it encrypted, then reads it on the server for each run; the block, the workflow, and agents never see the password. Reconnect the connection from Integrations when its credentials change. The runtime must be able to reach the database host.

- **Preferred** encrypts without verifying the server certificate.
- **Required** encrypts and verifies the certificate chain against the runtime's trust store, but does not check the host name, like MySQL's `VERIFY_CA`.
- Both refuse a server that offers no TLS rather than connect unencrypted, so Sim's **Preferred** behaves like MySQL's `REQUIRED`, not its `PREFERRED`.
- **Disabled** never encrypts. Use it only on a network whose confidentiality you control.

Workflows built before saved connections keep their inline connection fields and run unchanged.
{/* MANUAL-CONTENT-END */}

## Use the block [#usage-instructions]
Expand All @@ -31,12 +42,6 @@ Execute SELECT query on MySQL database

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MySQL server hostname or IP address |
| `port` | number | Yes | MySQL server port \(default: 3306\) |
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) |
| `username` | string | Yes | Database username |
| `password` | string | Yes | Database password |
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
| `query` | string | Yes | SQL SELECT query to execute \(e.g., SELECT * FROM users WHERE active = 1\) |

#### Output
Expand All @@ -59,12 +64,6 @@ Insert new record into MySQL database

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MySQL server hostname or IP address |
| `port` | number | Yes | MySQL server port \(default: 3306\) |
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) |
| `username` | string | Yes | Database username |
| `password` | string | Yes | Database password |
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
| `table` | string | Yes | Table name to insert into \(e.g., users, orders\) |
| `data` | object | Yes | Data to insert as key-value pairs |

Expand All @@ -88,12 +87,6 @@ Update existing records in MySQL database

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MySQL server hostname or IP address |
| `port` | number | Yes | MySQL server port \(default: 3306\) |
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) |
| `username` | string | Yes | Database username |
| `password` | string | Yes | Database password |
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
| `table` | string | Yes | Table name to update \(e.g., users, orders\) |
| `data` | object | Yes | Data to update as key-value pairs |
| `where` | string | Yes | WHERE clause condition \(without WHERE keyword\) |
Expand All @@ -118,12 +111,6 @@ Delete records from MySQL database

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MySQL server hostname or IP address |
| `port` | number | Yes | MySQL server port \(default: 3306\) |
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) |
| `username` | string | Yes | Database username |
| `password` | string | Yes | Database password |
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
| `table` | string | Yes | Table name to delete from \(e.g., users, orders\) |
| `where` | string | Yes | WHERE clause condition \(without WHERE keyword\) |

Expand All @@ -147,12 +134,6 @@ Execute raw SQL query on MySQL database

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MySQL server hostname or IP address |
| `port` | number | Yes | MySQL server port \(default: 3306\) |
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) |
| `username` | string | Yes | Database username |
| `password` | string | Yes | Database password |
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
| `query` | string | Yes | Raw SQL query to execute \(e.g., CREATE TABLE users \(id INT PRIMARY KEY, name VARCHAR\(255\)\)\) |

#### Output
Expand All @@ -175,12 +156,6 @@ Introspect MySQL database schema to retrieve table structures, columns, and rela

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MySQL server hostname or IP address |
| `port` | number | Yes | MySQL server port \(default: 3306\) |
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) |
| `username` | string | Yes | Database username |
| `password` | string | Yes | Database password |
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |

#### Output

Expand Down
Loading
Loading