Skip to content

Commit 351bccb

Browse files
committed
docs(integrations): set up saved PostgreSQL, MySQL, and SQL Server connections
Each page's intro now explains adding a saved connection, how Sim proves it before saving, what every SSL mode or SQL Server TLS setting does in the runtime's drivers, and that existing workflows keep their inline connection fields.
1 parent 74e4122 commit 351bccb

3 files changed

Lines changed: 32 additions & 2 deletions

File tree

‎apps/docs/content/docs/integrations/mssql.mdx‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,17 @@ import { ReferenceDetails } from "@/components/ui/reference-details"
1010

1111

1212
{/* MANUAL-CONTENT-START:intro */}
13-
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.
13+
Use [Microsoft SQL Server](https://www.microsoft.com/sql-server) to query or modify rows, execute T-SQL, and inspect tables, keys, and indexes.
14+
15+
### Connection setup
16+
17+
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.
18+
19+
- **Encrypt connection** encrypts the connection with TLS; leave it enabled.
20+
- **Trust server certificate** skips certificate validation. Enable it only for a server with a self-signed certificate you trust.
21+
- Named instances are not supported; give the instance a static TCP port and connect to that port.
22+
23+
Workflows built before saved connections keep their inline connection fields and run unchanged.
1424
{/* MANUAL-CONTENT-END */}
1525

1626
## Use the block [#usage-instructions]

‎apps/docs/content/docs/integrations/mysql.mdx‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,19 @@ import { ReferenceDetails } from "@/components/ui/reference-details"
1010

1111

1212
{/* MANUAL-CONTENT-START:intro */}
13-
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.
13+
Use [MySQL](https://www.mysql.com/) to query rows, insert or modify records, execute raw SQL, and inspect databases, tables, columns, keys, and indexes.
1414

1515
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.
16+
17+
### Connection setup
18+
19+
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.
20+
21+
- **Preferred** encrypts without verifying the server certificate.
22+
- **Required** encrypts and verifies the server certificate against the runtime's trust store.
23+
- **Disabled** never encrypts. Use it only on a network whose confidentiality you control.
24+
25+
Workflows built before saved connections keep their inline connection fields and run unchanged.
1626
{/* MANUAL-CONTENT-END */}
1727

1828
## Use the block [#usage-instructions]

‎apps/docs/content/docs/integrations/postgresql.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@ import { ReferenceDetails } from "@/components/ui/reference-details"
1111

1212
{/* MANUAL-CONTENT-START:intro */}
1313
Use [PostgreSQL](https://www.postgresql.org/) to query and modify rows, execute SQL, and inspect tables, columns, keys, and indexes. Schema inspection lets a workflow discover the database structure before generating a query.
14+
15+
### Connection setup
16+
17+
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.
18+
19+
- **Preferred** encrypts when the server offers TLS and otherwise connects without it.
20+
- **Required** always encrypts but does not verify the server certificate, like libpq's `sslmode=require`.
21+
- **Disabled** never encrypts. Use it only on a network whose confidentiality you control.
22+
23+
Workflows built before saved connections keep their inline connection fields and run unchanged.
1424
{/* MANUAL-CONTENT-END */}
1525

1626
## Use the block [#usage-instructions]

0 commit comments

Comments
 (0)