Skip to content

Commit c655f55

Browse files
docs(datasource): integration oracle doc (#2701)
# Description Add Oracle datasource documentation examples and update duplicate command of start webserver # How Has This Been Tested? # Snapshots: Include snapshots for easier review. # Checklist: - [ ] My code follows the style guidelines of this project - [x] I have already rebased the commits and make the commit message conform to the project standard. - [x] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] Any dependent changes have been merged and published in downstream modules
1 parent 11c2ec1 commit c655f55

File tree

7 files changed

+56
-14
lines changed

7 files changed

+56
-14
lines changed

docs/docs/installation/integrations.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ Integration Packages
1010

1111
| Provider | Supported | Install Packages |
1212
|-------------|-----------|----------------------|
13-
| MySQL | | --extra datasource_mysql |
14-
| OceanBase | | |
15-
| ClickHouse | | --extra datasource_clickhouse |
16-
| Hive | | --extra datasource_hive |
17-
| MSSQL | | --extra datasource_mssql |
18-
| PostgreSQL | | --extra datasource_postgres |
19-
| ApacheDoris | | |
20-
| StarRocks | | --extra datasource_starroks |
21-
| Spark | | --extra datasource_spark |
22-
| Oracle | | |
13+
| MySQL || --extra datasource_mysql |
14+
| OceanBase || |
15+
| ClickHouse || --extra datasource_clickhouse |
16+
| Hive || --extra datasource_hive |
17+
| MSSQL || --extra datasource_mssql |
18+
| PostgreSQL || --extra datasource_postgres |
19+
| ApacheDoris || |
20+
| StarRocks || --extra datasource_starroks |
21+
| Spark || --extra datasource_spark |
22+
| Oracle | | --extra datasource_oracle |
2323

2424

2525
# RAG Storage Providers

docs/docs/installation/integrations/clickhouse_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Prepare ClickHouse database service, reference-[ClickHouse Installation](https:/
2121

2222
Then run the following command to start the webserver:
2323
```bash
24-
uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-openai.toml
24+
uv run dbgpt start webserver --config configs/dbgpt-proxy-openai.toml
2525
```
2626

2727
Optionally, you can also use the following command to start the webserver:

docs/docs/installation/integrations/duckdb_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Prepare DuckDB database service, reference-[DuckDB Installation](https://duckdb.
2525
Then run the following command to start the webserver:
2626
```bash
2727

28-
uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-openai.toml
28+
uv run dbgpt start webserver --config configs/dbgpt-proxy-openai.toml
2929

3030
```
3131

docs/docs/installation/integrations/mssql_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Prepare MSSQL database service, reference-[MSSQL Installation](https://docs.micr
2323
Then run the following command to start the webserver:
2424
```bash
2525

26-
uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-openai.toml
26+
uv run dbgpt start webserver --config configs/dbgpt-proxy-openai.toml
2727
```
2828

2929
Optionally, you can also use the following command to start the webserver:
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Oracle
2+
3+
In this example, we will show how to use the Oracle as in DB-GPT Datasource. Using Oracle to implement Datasource can, to some extent, alleviate the uncertainty and interpretability issues brought about by vector database retrieval.
4+
5+
### Install Dependencies
6+
7+
First, you need to install the `dbgpt oracle datasource` library.
8+
9+
```bash
10+
11+
uv sync --all-packages \
12+
--extra "base" \
13+
--extra "datasource_oracle" \
14+
--extra "rag" \
15+
--extra "storage_chromadb" \
16+
--extra "dbgpts"
17+
```
18+
19+
### Prepare Oracle
20+
21+
Prepare Oracle database service, reference-[Oracle Installation](https://docs.oracle.com/en/database/oracle/oracle-database/index.html).
22+
23+
Then run the following command to start the webserver:
24+
```bash
25+
26+
uv run dbgpt start webserver --config configs/dbgpt-proxy-openai.toml
27+
```
28+
29+
Optionally, you can also use the following command to start the webserver:
30+
```bash
31+
32+
uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-openai.toml
33+
```
34+
35+
### Oracle Configuration
36+
<p align="left">
37+
<img src={'https://github.com/user-attachments/assets/c285f8c3-9e99-4fab-bd39-ae34206ec54f'} width="1000px"/>
38+
</p>

docs/docs/installation/integrations/postgres_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Prepare Postgres database service, reference-[Postgres Installation](https://www
2525
Then run the following command to start the webserver:
2626
```bash
2727

28-
uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-openai.toml
28+
uv run dbgpt start webserver --config configs/dbgpt-proxy-openai.toml
2929
```
3030

3131
Optionally, you can also use the following command to start the webserver:

docs/sidebars.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,10 @@ const sidebars = {
9393
type: "doc",
9494
id: "installation/integrations/mssql_install"
9595
},
96+
{
97+
type: "doc",
98+
id: "installation/integrations/oracle_install"
99+
},
96100
]
97101
},
98102
{

0 commit comments

Comments
 (0)