github/DB-GPT
1
0
Fork 0
mirror of https://github.com/csunny/DB-GPT.git synced 2025-08-09 20:28:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix:1. fix typos, 2.update CONTRIBUTING.md guideline and requirements (#661)

Browse Source
This commit is contained in:
Aries-ckt 2023-10-10 18:46:50 +05:00 committed by GitHub
commit 053bf19e97
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 43 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -10,11 +10,11 @@ git clone https://github.com/<YOUR-GITHUB-USERNAME>/DB-GPT
```
3. Install the project requirements
```
pip install -r requirements.txt
pip install -r requirements/dev-requirements.txt
```
4. Install pre-commit hooks
```
pre-commit install
pre-commit install --allow-missing-config
```
5. Create a new branch for your changes using the following command:

4
pilot/server/base.py
View File

@ -19,7 +19,7 @@ def signal_handler(sig, frame):
os._exit(0)
def async_db_summery(system_app: SystemApp):
def async_db_summary(system_app: SystemApp):
from pilot.summary.db_summary_client import DBSummaryClient
client = DBSummaryClient(system_app=system_app)
@ -79,7 +79,7 @@ def _create_model_start_listener(system_app: SystemApp):
print("begin run _add_app_startup_event")
conn_manage = ConnectManager(system_app)
cfg.LOCAL_DB_MANAGE = conn_manage
async_db_summery(system_app)
async_db_summary(system_app)
return startup_event

12
pilot/summary/db_summary.py
View File

@ -1,18 +1,18 @@
class DBSummary:
def __init__(self, name):
self.name = name
self.summery = None
self.summary = None
self.tables = []
self.metadata = str
def get_summery(self):
return self.summery
def get_summary(self):
return self.summary
class TableSummary:
def __init__(self, name):
self.name = name
self.summery = None
self.summary = None
self.fields = []
self.indexes = []
@ -20,12 +20,12 @@ class TableSummary:
class FieldSummary:
def __init__(self, name):
self.name = name
self.summery = None
self.summary = None
self.data_type = None
class IndexSummary:
def __init__(self, name):
self.name = name
self.summery = None
self.summary = None
self.bind_fields = []

12
pilot/summary/db_summary_client.py
View File

@ -47,13 +47,13 @@ class DBSummaryClient:
"embeddings": embeddings,
}
embedding = StringEmbedding(
file_path=db_summary_client.get_summery(),
file_path=db_summary_client.get_summary(),
vector_store_config=vector_store_config,
)
self.init_db_profile(db_summary_client, dbname, embeddings)
if not embedding.vector_name_exist():
if CFG.SUMMARY_CONFIG == "FAST":
for vector_table_info in db_summary_client.get_summery():
for vector_table_info in db_summary_client.get_summary():
embedding = StringEmbedding(
vector_table_info,
vector_store_config,
@ -61,7 +61,7 @@ class DBSummaryClient:
embedding.source_embedding()
else:
embedding = StringEmbedding(
file_path=db_summary_client.get_summery(),
file_path=db_summary_client.get_summary(),
vector_store_config=vector_store_config,
)
embedding.source_embedding()
@ -144,8 +144,8 @@ class DBSummaryClient:
vector_store_config=vector_store_config,
embedding_factory=embedding_factory,
)
table_summery = knowledge_embedding_client.similar_search(query, 1)
related_table_summaries.append(table_summery[0].page_content)
table_summary = knowledge_embedding_client.similar_search(query, 1)
related_table_summaries.append(table_summary[0].page_content)
return related_table_summaries
def init_db_summary(self):
@ -169,7 +169,7 @@ class DBSummaryClient:
"embeddings": embeddings,
}
embedding = StringEmbedding(
file_path=db_summary_client.get_db_summery(),
file_path=db_summary_client.get_db_summary(),
vector_store_config=profile_store_config,
)
if not embedding.vector_name_exist():

48
pilot/summary/rdbms_db_summary.py
View File

@ -12,7 +12,7 @@ class RdbmsSummary(DBSummary):
def __init__(self, name, type):
self.name = name
self.type = type
self.summery = """{{"database_name": "{name}", "type": "{type}", "tables": "{tables}", "qps": "{qps}", "tps": {tps}}}"""
self.summary = """{{"database_name": "{name}", "type": "{type}", "tables": "{tables}", "qps": "{qps}", "tps": {tps}}}"""
self.tables = {}
self.tables_info = []
self.vector_tables_info = []
@ -48,7 +48,7 @@ class RdbmsSummary(DBSummary):
for table_name in tables:
table_summary = RdbmsTableSummary(self.db, name, table_name, comment_map)
# self.tables[table_name] = table_summary.get_summery()
# self.tables[table_name] = table_summary.get_summary()
self.tables[table_name] = table_summary.get_columns()
self.table_columns_info.append(table_summary.get_columns())
# self.table_columns_json.append(table_summary.get_summary_json())
@ -59,18 +59,18 @@ class RdbmsSummary(DBSummary):
)
)
self.table_columns_json.append(table_profile)
# self.tables_info.append(table_summary.get_summery())
# self.tables_info.append(table_summary.get_summary())
def get_summery(self):
def get_summary(self):
if CFG.SUMMARY_CONFIG == "FAST":
return self.vector_tables_info
else:
return self.summery.format(
return self.summary.format(
name=self.name, type=self.type, table_info=";".join(self.tables_info)
)
def get_db_summery(self):
return self.summery.format(
def get_db_summary(self):
return self.summary.format(
name=self.name,
type=self.type,
tables=";".join(self.vector_tables_info),
@ -94,8 +94,8 @@ class RdbmsTableSummary(TableSummary):
def __init__(self, instance, dbname, name, comment_map):
self.name = name
self.dbname = dbname
self.summery = """database name:{dbname}, table name:{name}, have columns info: {fields}, have indexes info: {indexes}"""
self.json_summery_template = """{{"table_name": "{name}", "comment": "{comment}", "columns": "{fields}", "indexes": "{indexes}", "size_in_bytes": {size_in_bytes}, "rows": {rows}}}"""
self.summary = """database name:{dbname}, table name:{name}, have columns info: {fields}, have indexes info: {indexes}"""
self.json_summary_template = """{{"table_name": "{name}", "comment": "{comment}", "columns": "{fields}", "indexes": "{indexes}", "size_in_bytes": {size_in_bytes}, "rows": {rows}}}"""
self.fields = []
self.fields_info = []
self.indexes = []
@ -107,19 +107,19 @@ class RdbmsTableSummary(TableSummary):
for field in fields:
field_summary = RdbmsFieldsSummary(field)
self.fields.append(field_summary)
self.fields_info.append(field_summary.get_summery())
self.fields_info.append(field_summary.get_summary())
field_names.append(field[0])
self.column_summery = """{name}({columns_info})""".format(
self.column_summary = """{name}({columns_info})""".format(
name=name, columns_info=",".join(field_names)
)
for index in indexes:
index_summary = RdbmsIndexSummary(index)
self.indexes.append(index_summary)
self.indexes_info.append(index_summary.get_summery())
self.indexes_info.append(index_summary.get_summary())
self.json_summery = self.json_summery_template.format(
self.json_summary = self.json_summary_template.format(
name=name,
comment=comment_map[name],
fields=self.fields_info,
@ -128,8 +128,8 @@ class RdbmsTableSummary(TableSummary):
rows=1000,
)
def get_summery(self):
return self.summery.format(
def get_summary(self):
return self.summary.format(
name=self.name,
dbname=self.dbname,
fields=";".join(self.fields_info),
@ -137,10 +137,10 @@ class RdbmsTableSummary(TableSummary):
)
def get_columns(self):
return self.column_summery
return self.column_summary
def get_summary_json(self):
return self.json_summery
return self.json_summary
class RdbmsFieldsSummary(FieldSummary):
@ -148,14 +148,14 @@ class RdbmsFieldsSummary(FieldSummary):
def __init__(self, field):
self.name = field[0]
# self.summery = """column name:{name}, column data type:{data_type}, is nullable:{is_nullable}, default value is:{default_value}, comment is:{comment} """
# self.summery = """{"name": {name}, "type": {data_type}, "is_primary_key": {is_nullable}, "comment":{comment}, "default":{default_value}}"""
# self.summary = """column name:{name}, column data type:{data_type}, is nullable:{is_nullable}, default value is:{default_value}, comment is:{comment} """
# self.summary = """{"name": {name}, "type": {data_type}, "is_primary_key": {is_nullable}, "comment":{comment}, "default":{default_value}}"""
self.data_type = field[1]
self.default_value = field[2]
self.is_nullable = field[3]
self.comment = field[4]
def get_summery(self):
def get_summary(self):
return '{{"name": "{name}", "type": "{data_type}", "is_primary_key": "{is_nullable}", "comment": "{comment}", "default": "{default_value}"}}'.format(
name=self.name,
data_type=self.data_type,
@ -170,11 +170,11 @@ class RdbmsIndexSummary(IndexSummary):
def __init__(self, index):
self.name = index[0]
# self.summery = """index name:{name}, index bind columns:{bind_fields}"""
self.summery_template = '{{"name": "{name}", "columns": {bind_fields}}}'
# self.summary = """index name:{name}, index bind columns:{bind_fields}"""
self.summary_template = '{{"name": "{name}", "columns": {bind_fields}}}'
self.bind_fields = index[1]
def get_summery(self):
return self.summery_template.format(
def get_summary(self):
return self.summary_template.format(
name=self.name, bind_fields=self.bind_fields
)

4
requirements/dev-requirements.txt
View File

@ -9,4 +9,6 @@ pytest-mock
pytest-recording
pytesseract==0.3.10
# python code format
black
black
# for git hooks
pre-commmit