Skip to content

Commit 089cd1e

Browse files
tianzhouclaude
andcommitted
docs: add search_path to TOML configuration reference
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent ec5c2f3 commit 089cd1e

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/config/toml.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,27 @@ Sources define database connections. Each source represents a database that DBHu
281281
```
282282
</ParamField>
283283

284+
### search_path
285+
286+
<ParamField path="search_path" type="string">
287+
Comma-separated list of PostgreSQL schema names to set as the session `search_path`. The first schema in the list becomes the default schema for all discovery methods (`getTables`, `getTableSchema`, etc.).
288+
289+
**PostgreSQL only.**
290+
291+
```toml
292+
[[sources]]
293+
id = "production"
294+
dsn = "postgres://user:pass@localhost:5432/mydb"
295+
search_path = "myschema,public"
296+
```
297+
298+
Without `search_path`, DBHub defaults to the `public` schema for all schema discovery operations.
299+
300+
<Note>
301+
This option is **only available via TOML**. It is not supported as a DSN query parameter.
302+
</Note>
303+
</ParamField>
304+
284305
### SSH Tunnel Options
285306

286307
<ParamField path="ssh_*" type="group">
@@ -575,6 +596,7 @@ default = 10
575596
| `instanceName` | string || SQL Server named instance |
576597
| `authentication` | string || SQL Server auth method |
577598
| `domain` | string || Windows domain (NTLM) |
599+
| `search_path` | string || PostgreSQL schema search path (comma-separated) |
578600
| `ssh_host` | string || SSH server hostname |
579601
| `ssh_port` | number || SSH server port (default: 22) |
580602
| `ssh_user` | string || SSH username |

0 commit comments

Comments
 (0)