Skip to content

Commit 51bf922

Browse files
authored
Merge pull request #576 from bytebase/eparam-docs
chore: add connection parameters documentation
2 parents f11cf82 + 0c5b772 commit 51bf922

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

content/docs/get-started/instance.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,30 @@ To separate from admin connection, you can configure read-only connections used
6161

6262
![bb-instance-read-only-connection](/content/docs/get-started/instance/bb-instance-read-only-connection.webp)
6363

64+
## Configuring Extra Connection Parameters
65+
66+
When connecting to a database instance, you may need to specify additional parameters to customize the connection behavior. Bytebase provides a feature that allows users to define extra parameters for the database connection string directly in the UI.
67+
68+
### Supported Database Connection Parameters
69+
70+
Below are links to official documentation for configuring connection parameters:
71+
72+
- **PostgreSQL**: [Connection Parameters](https://www.postgresql.org/docs/current/libpq-connect.html)
73+
- **Oracle (Go-ORA)**: [Go-ORA Connection Options](https://github.com/sijms/go-ora)
74+
- **MySQL (Go SQL Driver)**: [Connection Parameters](https://github.com/go-sql-driver/mysql?tab=readme-ov-file#parameters)
75+
- **Microsoft SQL Server (Go-MSSQL)**: [Connection Options](https://pkg.go.dev/github.com/microsoft/go-mssqldb#section-readme)
76+
77+
### Common Connection Parameters
78+
79+
| Parameter | Description | Example |
80+
|-----------|-------------|---------|
81+
| `sslmode` | SSL connection mode (PostgreSQL) | `require` |
82+
| `connect_timeout` | Timeout for establishing connections | `10` |
83+
| `readTimeout` | Read timeout for MySQL and MSSQL connections | `30s` |
84+
| `max_connections` | Maximum number of connections allowed | `100` |
85+
86+
For a full list of supported parameters, refer to the official database documentation links above.
87+
6488
## Choose your data source in SQL Editor
6589

6690
You may select data sources between the admin and read-only connection while running SQL queries in SQL Editor.

0 commit comments

Comments
 (0)