Skip to content

Commit 1889fc4

Browse files
committed
chore: update readme
1 parent 7f026a7 commit 1889fc4

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ https://demo.dbhub.ai/sse connects a [sample employee database](https://github.c
3636

3737
### Database Resources
3838

39-
| Resource Name | URI Format | PostgreSQL | MySQL | SQL Server | SQLite |
40-
| ----------------------------- | ----------------------------------------------------------- | :--------: | :---: | :--------: | :----: |
41-
| schemas | `db://schemas` |||||
42-
| tables_in_schema | `db://schemas/{schemaName}/tables` |||||
43-
| table_structure_in_schema | `db://schemas/{schemaName}/tables/{tableName}` |||||
44-
| indexes_in_table | `db://schemas/{schemaName}/tables/{tableName}/indexes` |||||
45-
| procedures_in_schema | `db://schemas/{schemaName}/procedures` |||||
46-
| procedure_details_in_schema | `db://schemas/{schemaName}/procedures/{procedureName}` |||||
39+
| Resource Name | URI Format | PostgreSQL | MySQL | SQL Server | SQLite |
40+
| --------------------------- | ------------------------------------------------------ | :--------: | :---: | :--------: | :----: |
41+
| schemas | `db://schemas` |||||
42+
| tables_in_schema | `db://schemas/{schemaName}/tables` |||||
43+
| table_structure_in_schema | `db://schemas/{schemaName}/tables/{tableName}` |||||
44+
| indexes_in_table | `db://schemas/{schemaName}/tables/{tableName}/indexes` |||||
45+
| procedures_in_schema | `db://schemas/{schemaName}/procedures` |||||
46+
| procedure_details_in_schema | `db://schemas/{schemaName}/procedures/{procedureName}` |||||
4747

4848
### Database Tools
4949

@@ -54,10 +54,10 @@ https://demo.dbhub.ai/sse connects a [sample employee database](https://github.c
5454

5555
### Prompt Capabilities
5656

57-
| Prompt | Command Name | PostgreSQL | MySQL | SQL Server | SQLite |
58-
| ------------------- | --------------- | :--------: | :---: | :--------: | :----: |
59-
| Generate SQL | `generate_sql` |||||
60-
| Explain DB Elements | `explain_db` |||||
57+
| Prompt | Command Name | PostgreSQL | MySQL | SQL Server | SQLite |
58+
| ------------------- | -------------- | :--------: | :---: | :--------: | :----: |
59+
| Generate SQL | `generate_sql` |||||
60+
| Explain DB Elements | `explain_db` |||||
6161

6262
## Installation
6363

@@ -181,14 +181,17 @@ For real databases, a Database Source Name (DSN) is required. You can provide th
181181
DSN=postgres://user:password@localhost:5432/dbname?sslmode=disable
182182
```
183183

184+
> [!WARNING]
185+
> When running in Docker, use `host.docker.internal` instead of `localhost` to connect to databases running on your host machine. For example: `mysql://user:password@host.docker.internal:3306/dbname`
186+
184187
DBHub supports the following database connection string formats:
185188

186-
| Database | DSN Format | Example |
187-
| ---------- | -------------------------------------------------------- | ----------------------------------------------------------------- |
188-
| PostgreSQL | `postgres://[user]:[password]@[host]:[port]/[database]` | `postgres://user:password@localhost:5432/dbname?sslmode=disable` |
189-
| SQLite | `sqlite:///[path/to/file]` or `sqlite::memory:` | `sqlite:///path/to/database.db` or `sqlite::memory:` |
190-
| SQL Server | `sqlserver://[user]:[password]@[host]:[port]/[database]` | `sqlserver://user:password@localhost:1433/dbname` |
191-
| MySQL | `mysql://[user]:[password]@[host]:[port]/[database]` | `mysql://user:password@localhost:3306/dbname` |
189+
| Database | DSN Format | Example |
190+
| ---------- | -------------------------------------------------------- | ---------------------------------------------------------------- |
191+
| PostgreSQL | `postgres://[user]:[password]@[host]:[port]/[database]` | `postgres://user:password@localhost:5432/dbname?sslmode=disable` |
192+
| SQLite | `sqlite:///[path/to/file]` or `sqlite::memory:` | `sqlite:///path/to/database.db` or `sqlite::memory:` |
193+
| SQL Server | `sqlserver://[user]:[password]@[host]:[port]/[database]` | `sqlserver://user:password@localhost:1433/dbname` |
194+
| MySQL | `mysql://[user]:[password]@[host]:[port]/[database]` | `mysql://user:password@localhost:3306/dbname` |
192195

193196
### Transport
194197

0 commit comments

Comments
 (0)