feat(core): Support configuration metadata database name in .env file (…

…#741)

*Others*:
- Support disable alembic to initialize and upgrade database metadata
with parameter `--disable_alembic_upgrade`
- New APP ID parameter `proxy_api_app_id` for proxy LLM

.env.template

@@ -84,6 +84,7 @@ LOCAL_DB_TYPE=sqlite
 # LOCAL_DB_PASSWORD=aa12345678
 # LOCAL_DB_HOST=127.0.0.1
 # LOCAL_DB_PORT=3306
+# LOCAL_DB_NAME=dbgpt
 ### This option determines the storage location of conversation records. The default is not configured to the old version of duckdb. It can be optionally db or file (if the value is db, the database configured by LOCAL_DB will be used)
 #CHAT_HISTORY_STORE_TYPE=db
 

assets/schema/knowledge_management.sql

@@ -1,5 +1,15 @@
-CREATE DATABASE knowledge_management;
-use knowledge_management;
+-- You can change `dbgpt` to your actual metadata database name in your `.env` file
+-- eg. `LOCAL_DB_NAME=dbgpt`
+
+CREATE DATABASE IF NOT EXISTS dbgpt;
+use dbgpt;
+
+-- For alembic migration tool
+CREATE TABLE `alembic_version` (
+      version_num VARCHAR(32) NOT NULL,
+      CONSTRAINT alembic_version_pkc PRIMARY KEY (version_num)
+);
+
 CREATE TABLE `knowledge_space` (
   `id` int NOT NULL AUTO_INCREMENT COMMENT 'auto increment id',
   `name` varchar(100) NOT NULL COMMENT 'knowledge space name',
@@ -43,6 +53,102 @@ CREATE TABLE `document_chunk` (
   KEY `idx_document_id` (`document_id`) COMMENT 'index:document_id'
 ) ENGINE=InnoDB AUTO_INCREMENT=100001 DEFAULT CHARSET=utf8mb4 COMMENT='knowledge document chunk detail';
 
+
+
+CREATE TABLE `connect_config` (
+  `id` int NOT NULL AUTO_INCREMENT COMMENT 'autoincrement id',
+  `db_type` varchar(255) NOT NULL COMMENT 'db type',
+  `db_name` varchar(255) NOT NULL COMMENT 'db name',
+  `db_path` varchar(255) DEFAULT NULL COMMENT 'file db path',
+  `db_host` varchar(255) DEFAULT NULL COMMENT 'db connect host(not file db)',
+  `db_port` varchar(255) DEFAULT NULL COMMENT 'db cnnect port(not file db)',
+  `db_user` varchar(255) DEFAULT NULL COMMENT 'db user',
+  `db_pwd` varchar(255) DEFAULT NULL COMMENT 'db password',
+  `comment` text COMMENT 'db comment',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `uk_db` (`db_name`),
+  KEY `idx_q_db_type` (`db_type`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT 'Connection confi';
+
+CREATE TABLE `chat_history` (
+  `id` int NOT NULL AUTO_INCREMENT COMMENT 'autoincrement id',
+  `conv_uid` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'Conversation record unique id',
+  `chat_mode` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'Conversation scene mode',
+  `summary` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'Conversation record summary',
+  `user_name` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'interlocutor',
+  `messages` text COLLATE utf8mb4_unicode_ci COMMENT 'Conversation details',
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT 'Chat history';
+
+CREATE TABLE `chat_feed_back` (
+  `id` bigint(20) NOT NULL AUTO_INCREMENT,
+  `conv_uid` varchar(128) DEFAULT NULL COMMENT 'Conversation ID',
+  `conv_index` int(4) DEFAULT NULL COMMENT 'Round of conversation',
+  `score` int(1) DEFAULT NULL COMMENT 'Score of user',
+  `ques_type` varchar(32) DEFAULT NULL COMMENT 'User question category',
+  `question` longtext DEFAULT NULL COMMENT 'User question',
+  `knowledge_space` varchar(128) DEFAULT NULL COMMENT 'Knowledge space name',
+  `messages` longtext DEFAULT NULL COMMENT 'The details of user feedback',
+  `user_name` varchar(128) DEFAULT NULL COMMENT 'User name',
+  `gmt_created` timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'created time',
+  `gmt_modified` timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'update time',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `uk_conv` (`conv_uid`,`conv_index`),
+  KEY `idx_conv` (`conv_uid`,`conv_index`)
+) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=utf8mb4 COMMENT='User feedback table';
+
+
+CREATE TABLE `my_plugin` (
+  `id` int NOT NULL AUTO_INCREMENT COMMENT 'autoincrement id',
+  `tenant` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'user tenant',
+  `user_code` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'user code',
+  `user_name` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'user name',
+  `name` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'plugin name',
+  `file_name` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'plugin package file name',
+  `type` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'plugin type',
+  `version` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'plugin version',
+  `use_count` int DEFAULT NULL COMMENT 'plugin total use count',
+  `succ_count` int DEFAULT NULL COMMENT 'plugin total success count',
+  `gmt_created` TIMESTAMP DEFAULT CURRENT_TIMESTAMP COMMENT 'plugin install time',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `name` (`name`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='User plugin table';
+
+CREATE TABLE `plugin_hub` (
+  `id` int NOT NULL AUTO_INCREMENT COMMENT 'autoincrement id',
+  `name` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'plugin name',
+  `description` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'plugin description',
+  `author` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'plugin author',
+  `email` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'plugin author email',
+  `type` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'plugin type',
+  `version` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'plugin version',
+  `storage_channel` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'plugin storage channel',
+  `storage_url` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'plugin download url',
+  `download_param` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'plugin download param',
+  `gmt_created` TIMESTAMP DEFAULT CURRENT_TIMESTAMP COMMENT 'plugin upload time',
+  `installed` int DEFAULT NULL COMMENT 'plugin already installed count',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `name` (`name`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='Plugin Hub table';
+
+
+CREATE TABLE `prompt_manage` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `chat_scene` varchar(100) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'Chat scene',
+  `sub_chat_scene` varchar(100) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'Sub chat scene',
+  `prompt_type` varchar(100) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'Prompt type: common or private',
+  `prompt_name` varchar(512) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'prompt name',
+  `content` longtext COLLATE utf8mb4_unicode_ci COMMENT 'Prompt content',
+  `user_name` varchar(128) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'User name',
+  `gmt_created` timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'created time',
+  `gmt_modified` timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'update time',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `prompt_name_uiq` (`prompt_name`),
+  KEY `gmt_created_idx` (`gmt_created`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='Prompt management table';
+
+
+
 CREATE DATABASE EXAMPLE_1;
 use EXAMPLE_1;
 CREATE TABLE `users` (

docs/getting_started/faq/deploy/deploy_faq.md

@@ -100,8 +100,49 @@ pip install --use-pep517 fschat
 ```
 
 ##### Q9: alembic.util.exc.CommandError: Target database is not up to date.
-delete files in `DB-GPT/pilot/meta_data/alembic/versions/` and reboot.
+
+delete files in `DB-GPT/pilot/meta_data/alembic/versions/` and restart.
 ```commandline
 rm -rf DB-GPT/pilot/meta_data/alembic/versions/*
 rm -rf DB-GPT/pilot/meta_data/alembic/dbgpt.db
 ```
+
+##### Q10: How to store DB-GPT metadata into my database
+
+In version 0.4.0, the metadata module of the DB-GPT application has been refactored. All metadata tables will now be automatically saved in the 'dbgpt' database, based on the database type specified in the `.env` file. If you would like to retain the existing data, it is recommended to use a data migration tool to transfer the database table information to the 'dbgpt' database. Additionally, you can change the default database name 'dbgpt' in your `.env` file.
+
+```commandline
+### SQLite database (Current default database)
+#LOCAL_DB_PATH=data/default_sqlite.db
+#LOCAL_DB_TYPE=sqlite
+
+### Mysql database
+LOCAL_DB_TYPE=mysql
+LOCAL_DB_USER=root
+LOCAL_DB_PASSWORD=aa12345678
+LOCAL_DB_HOST=127.0.0.1
+LOCAL_DB_PORT=3306
+# You can change it to your actual metadata database name
+LOCAL_DB_NAME=dbgpt
+
+### This option determines the storage location of conversation records. The default is not configured to the old version of duckdb. It can be optionally db or file (if the value is db, the database configured by LOCAL_DB will be used)
+CHAT_HISTORY_STORE_TYPE=db
+```
+
+##### Q11: pymysql.err.OperationalError: (1142, "ALTER command denied to user '{you db user}'@'{you db host}' for table '{some table name}'")
+
+In version 0.4.0, DB-GPT use migration tool alembic to migrate metadata. If the database user does not have DDL permissions, this error will be reported. You can solve this problem by importing the metadata information separately.
+
+1. Use a privileged user to execute DDL sql file
+```bash
+mysql -h127.0.0.1 -uroot -paa12345678 < ./assets/schema/knowledge_management.sql
+```
+
+2. Run DB-GPT webserver with `--disable_alembic_upgrade`
+```bash
+python pilot/server/dbgpt_server.py --disable_alembic_upgrade
+```
+or 
+```bash
+dbgpt start webserver --disable_alembic_upgrade
+```

docs/getting_started/faq/kbqa/kbqa_faq.md

@@ -72,7 +72,7 @@ $ mysql -h127.0.0.1 -uroot -paa12345678 < ./assets/schema/knowledge_management.s
 
 ##### Q6:when pull from 0.4.0, I found historical knowledge document disappeared
 
-In version 0.4.0, the metadata module of the DB-GPT application has been refactored. All metadata tables will now be automatically saved in the 'dbgpt' database, based on the database type specified in the .env file. If you would like to retain the existing data, it is recommended to use a data migration tool to transfer the database table information to the 'dbgpt' database.
+In version 0.4.0, the metadata module of the DB-GPT application has been refactored. All metadata tables will now be automatically saved in the 'dbgpt' database, based on the database type specified in the `.env` file. If you would like to retain the existing data, it is recommended to use a data migration tool to transfer the database table information to the 'dbgpt' database. Additionally, you can change the default database name 'dbgpt' in your `.env` file.
 
 ```{tip}
 old database:knowledge_management;
@@ -89,5 +89,6 @@ LOCAL_DB_USER=root
 LOCAL_DB_PASSWORD=aa12345678
 LOCAL_DB_HOST=127.0.0.1
 LOCAL_DB_PORT=3306
-
-```
+# You can change it to your actual metadata database name
+LOCAL_DB_NAME=dbgpt
+```