From c655f55ab42c71cd3c1177679eaf0dcee4c2f4be Mon Sep 17 00:00:00 2001 From: alanchen <40684202+chenliang15405@users.noreply.github.com> Date: Fri, 16 May 2025 19:01:23 +0800 Subject: [PATCH] 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 --- docs/docs/installation/integrations.md | 20 +++++----- .../integrations/clickhouse_install.md | 2 +- .../integrations/duckdb_install.md | 2 +- .../integrations/mssql_install.md | 2 +- .../integrations/oracle_install.md | 38 +++++++++++++++++++ .../integrations/postgres_install.md | 2 +- docs/sidebars.js | 4 ++ 7 files changed, 56 insertions(+), 14 deletions(-) create mode 100644 docs/docs/installation/integrations/oracle_install.md diff --git a/docs/docs/installation/integrations.md b/docs/docs/installation/integrations.md index f9c430b5c..5affd4bba 100644 --- a/docs/docs/installation/integrations.md +++ b/docs/docs/installation/integrations.md @@ -10,16 +10,16 @@ Integration Packages | Provider | Supported | Install Packages | |-------------|-----------|----------------------| -| MySQL | ✅ | --extra datasource_mysql | -| OceanBase | ✅ | | -| ClickHouse | ✅ | --extra datasource_clickhouse | -| Hive | ✅ | --extra datasource_hive | -| MSSQL | ✅ | --extra datasource_mssql | -| PostgreSQL | ✅ | --extra datasource_postgres | -| ApacheDoris | ✅ | | -| StarRocks | ✅ | --extra datasource_starroks | -| Spark | ✅ | --extra datasource_spark | -| Oracle | ❌ | | +| MySQL | ✅ | --extra datasource_mysql | +| OceanBase | ✅ | | +| ClickHouse | ✅ | --extra datasource_clickhouse | +| Hive | ✅ | --extra datasource_hive | +| MSSQL | ✅ | --extra datasource_mssql | +| PostgreSQL | ✅ | --extra datasource_postgres | +| ApacheDoris | ✅ | | +| StarRocks | ✅ | --extra datasource_starroks | +| Spark | ✅ | --extra datasource_spark | +| Oracle | ✅ | --extra datasource_oracle | # RAG Storage Providers diff --git a/docs/docs/installation/integrations/clickhouse_install.md b/docs/docs/installation/integrations/clickhouse_install.md index 55b899023..dba84398c 100644 --- a/docs/docs/installation/integrations/clickhouse_install.md +++ b/docs/docs/installation/integrations/clickhouse_install.md @@ -21,7 +21,7 @@ Prepare ClickHouse database service, reference-[ClickHouse Installation](https:/ Then run the following command to start the webserver: ```bash -uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-openai.toml +uv run dbgpt start webserver --config configs/dbgpt-proxy-openai.toml ``` Optionally, you can also use the following command to start the webserver: diff --git a/docs/docs/installation/integrations/duckdb_install.md b/docs/docs/installation/integrations/duckdb_install.md index ef2b649ed..763a31416 100644 --- a/docs/docs/installation/integrations/duckdb_install.md +++ b/docs/docs/installation/integrations/duckdb_install.md @@ -25,7 +25,7 @@ Prepare DuckDB database service, reference-[DuckDB Installation](https://duckdb. Then run the following command to start the webserver: ```bash -uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-openai.toml +uv run dbgpt start webserver --config configs/dbgpt-proxy-openai.toml ``` diff --git a/docs/docs/installation/integrations/mssql_install.md b/docs/docs/installation/integrations/mssql_install.md index 441d72120..84badea19 100644 --- a/docs/docs/installation/integrations/mssql_install.md +++ b/docs/docs/installation/integrations/mssql_install.md @@ -23,7 +23,7 @@ Prepare MSSQL database service, reference-[MSSQL Installation](https://docs.micr Then run the following command to start the webserver: ```bash -uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-openai.toml +uv run dbgpt start webserver --config configs/dbgpt-proxy-openai.toml ``` Optionally, you can also use the following command to start the webserver: diff --git a/docs/docs/installation/integrations/oracle_install.md b/docs/docs/installation/integrations/oracle_install.md new file mode 100644 index 000000000..9dbaf560f --- /dev/null +++ b/docs/docs/installation/integrations/oracle_install.md @@ -0,0 +1,38 @@ +# Oracle + +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. + +### Install Dependencies + +First, you need to install the `dbgpt oracle datasource` library. + +```bash + +uv sync --all-packages \ +--extra "base" \ +--extra "datasource_oracle" \ +--extra "rag" \ +--extra "storage_chromadb" \ +--extra "dbgpts" +``` + +### Prepare Oracle + +Prepare Oracle database service, reference-[Oracle Installation](https://docs.oracle.com/en/database/oracle/oracle-database/index.html). + +Then run the following command to start the webserver: +```bash + +uv run dbgpt start webserver --config configs/dbgpt-proxy-openai.toml +``` + +Optionally, you can also use the following command to start the webserver: +```bash + +uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-openai.toml +``` + +### Oracle Configuration +

+ +

diff --git a/docs/docs/installation/integrations/postgres_install.md b/docs/docs/installation/integrations/postgres_install.md index a447dda73..a6bb8cfb7 100644 --- a/docs/docs/installation/integrations/postgres_install.md +++ b/docs/docs/installation/integrations/postgres_install.md @@ -25,7 +25,7 @@ Prepare Postgres database service, reference-[Postgres Installation](https://www Then run the following command to start the webserver: ```bash -uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-openai.toml +uv run dbgpt start webserver --config configs/dbgpt-proxy-openai.toml ``` Optionally, you can also use the following command to start the webserver: diff --git a/docs/sidebars.js b/docs/sidebars.js index 46bf6e88b..5f321aed6 100755 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -93,6 +93,10 @@ const sidebars = { type: "doc", id: "installation/integrations/mssql_install" }, + { + type: "doc", + id: "installation/integrations/oracle_install" + }, ] }, {