feat(core): Support simple DB query for sdk (#917)

Co-authored-by: chengfangyin2 <chengfangyin3@jd.com>
This commit is contained in:
FangYin Cheng
2023-12-11 18:33:54 +08:00
committed by GitHub
parent 43190ca333
commit cbba50ab1b
18 changed files with 467 additions and 74 deletions

View File

@@ -1,5 +1,7 @@
from typing import List
from dbgpt._private.config import Config
from dbgpt.rag.summary.db_summary import DBSummary
from dbgpt.datasource.rdbms.base import RDBMSDatabase
CFG = Config()
@@ -36,32 +38,63 @@ class RdbmsSummary(DBSummary):
example:
table_name(column1(column1 comment),column2(column2 comment),column3(column3 comment) and index keys, and table comment: {table_comment})
"""
columns = []
for column in self.db._inspector.get_columns(table_name):
if column.get("comment"):
columns.append((f"{column['name']} ({column.get('comment')})"))
else:
columns.append(f"{column['name']}")
column_str = ", ".join(columns)
index_keys = []
for index_key in self.db._inspector.get_indexes(table_name):
key_str = ", ".join(index_key["column_names"])
index_keys.append(f"{index_key['name']}(`{key_str}`) ")
table_str = self.summary_template.format(
table_name=table_name, columns=column_str
)
if len(index_keys) > 0:
index_key_str = ", ".join(index_keys)
table_str += f", and index keys: {index_key_str}"
try:
comment = self.db._inspector.get_table_comment(table_name)
except Exception:
comment = dict(text=None)
if comment.get("text"):
table_str += f", and table comment: {comment.get('text')}"
return table_str
return _parse_table_summary(self.db, self.summary_template, table_name)
def table_summaries(self):
"""Get table summaries."""
return self.table_info_summaries
def _parse_db_summary(
conn: RDBMSDatabase, summary_template: str = "{table_name}({columns})"
) -> List[str]:
"""Get db summary for database.
Args:
conn (RDBMSDatabase): database connection
summary_template (str): summary template
"""
tables = conn.get_table_names()
table_info_summaries = [
_parse_table_summary(conn, summary_template, table_name)
for table_name in tables
]
return table_info_summaries
def _parse_table_summary(
conn: RDBMSDatabase, summary_template: str, table_name: str
) -> str:
"""Get table summary for table.
Args:
conn (RDBMSDatabase): database connection
summary_template (str): summary template
table_name (str): table name
Examples:
table_name(column1(column1 comment),column2(column2 comment),column3(column3 comment) and index keys, and table comment: {table_comment})
"""
columns = []
for column in conn._inspector.get_columns(table_name):
if column.get("comment"):
columns.append(f"{column['name']} ({column.get('comment')})")
else:
columns.append(f"{column['name']}")
column_str = ", ".join(columns)
index_keys = []
for index_key in conn._inspector.get_indexes(table_name):
key_str = ", ".join(index_key["column_names"])
index_keys.append(f"{index_key['name']}(`{key_str}`) ")
table_str = summary_template.format(table_name=table_name, columns=column_str)
if len(index_keys) > 0:
index_key_str = ", ".join(index_keys)
table_str += f", and index keys: {index_key_str}"
try:
comment = conn._inspector.get_table_comment(table_name)
except Exception:
comment = dict(text=None)
if comment.get("text"):
table_str += f", and table comment: {comment.get('text')}"
return table_str