@@ -36,24 +36,26 @@ https://demo.dbhub.ai/sse connects a [sample employee database](https://github.c
3636
3737### Database Resources
3838
39- | Resource | URI Format | PostgreSQL | MySQL | SQL Server | SQLite |
40- | -------- | :-----------------------: | :--------: | :---: | :--------: | :----: |
41- | Tables | ` db://tables ` | ✅ | ✅ | ✅ | ✅ |
42- | Schema | ` db://schema/{tableName} ` | ✅ | ✅ | ✅ | ✅ |
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 ` | ✅ | ✅ | ✅ | ✅ |
4345
4446### Database Tools
4547
46- | Tool | Command Name | PostgreSQL | MySQL | SQL Server | SQLite |
47- | --------------- | : ---------------: | :--------: | :---: | :--------: | :----: |
48- | Execute Query | ` run_query ` | ✅ | ✅ | ✅ | ✅ |
48+ | Tool | Command Name | PostgreSQL | MySQL | SQL Server | SQLite |
49+ | --------------- | ----------------- | :--------: | :---: | :--------: | :----: |
50+ | Execute Query | ` run_query ` | ✅ | ✅ | ✅ | ✅ |
4951| List Connectors | ` list_connectors ` | ✅ | ✅ | ✅ | ✅ |
5052
5153### Prompt Capabilities
5254
53- | Prompt | Command Name | PostgreSQL | MySQL | SQL Server | SQLite |
54- | ------------------- | : ------------: | :--------: | :---: | :--------: | :----: |
55- | Generate SQL | ` generate_sql ` | ✅ | ✅ | ✅ | ✅ |
56- | Explain DB Elements | ` explain_db ` | ✅ | ✅ | ✅ | ✅ |
55+ | Prompt | Command Name | PostgreSQL | MySQL | SQL Server | SQLite |
56+ | ------------------- | --------------- | :--------: | :---: | :--------: | :----: |
57+ | Generate SQL | ` generate_sql ` | ✅ | ✅ | ✅ | ✅ |
58+ | Explain DB Elements | ` explain_db ` | ✅ | ✅ | ✅ | ✅ |
5759
5860## Installation
5961
@@ -179,12 +181,12 @@ For real databases, a Database Source Name (DSN) is required. You can provide th
179181
180182DBHub supports the following database connection string formats:
181183
182- | Database | DSN Format | Example |
183- | ---------- | -------------------------------------------------------- | ---------------------------------------------------------------- |
184- | PostgreSQL | ` postgres://[user]:[password]@[host]:[port]/[database] ` | ` postgres://user:password@localhost:5432/dbname?sslmode=disable ` |
185- | SQLite | ` sqlite:///[path/to/file] ` or ` sqlite::memory: ` | ` sqlite:///path/to/database.db ` or ` sqlite::memory: ` |
186- | SQL Server | ` sqlserver://[user]:[password]@[host]:[port]/[database] ` | ` sqlserver://user:password@localhost:1433/dbname ` |
187- | MySQL | ` mysql://[user]:[password]@[host]:[port]/[database] ` | ` mysql://user:password@localhost:3306/dbname ` |
184+ | Database | DSN Format | Example |
185+ | ---------- | -------------------------------------------------------- | ----------------------------------------------------------------- |
186+ | PostgreSQL | ` postgres://[user]:[password]@[host]:[port]/[database] ` | ` postgres://user:password@localhost:5432/dbname?sslmode=disable ` |
187+ | SQLite | ` sqlite:///[path/to/file] ` or ` sqlite::memory: ` | ` sqlite:///path/to/database.db ` or ` sqlite::memory: ` |
188+ | SQL Server | ` sqlserver://[user]:[password]@[host]:[port]/[database] ` | ` sqlserver://user:password@localhost:1433/dbname ` |
189+ | MySQL | ` mysql://[user]:[password]@[host]:[port]/[database] ` | ` mysql://user:password@localhost:3306/dbname ` |
188190
189191### Transport
190192
@@ -202,13 +204,13 @@ DBHub supports the following database connection string formats:
202204### Command line options
203205
204206| Option | Description | Default |
205- | : -------- | : -------------------------------------------------------------- | : --------------------------- |
207+ | --------- | --------------------------------------------------------------- | - --------------------------- |
206208| demo | Run in demo mode with sample employee database | ` false ` |
207209| dsn | Database connection string | Required if not in demo mode |
208210| transport | Transport mode: ` stdio ` or ` sse ` | ` stdio ` |
209211| port | HTTP server port (only applicable when using ` --transport=sse ` ) | ` 8080 ` |
210212
211- The demo mode uses an in-memory SQLite database loaded with the [ sample employee database] ( https://github.com/bytebase/dbhub/tree/main/resources/employee-sqlite ) that includes tables for employees, departments, titles, and salaries .
213+ The demo mode uses an in-memory SQLite database loaded with the [ sample employee database] ( https://github.com/bytebase/dbhub/tree/main/resources/employee-sqlite ) that includes tables for employees, departments, titles, salaries, department employees, and department managers. The sample database includes SQL scripts for table creation, data loading, and testing .
212214
213215## Development
214216
0 commit comments