mirror of
https://github.com/csunny/DB-GPT.git
synced 2025-10-22 09:28:42 +00:00
681a8e2ed5
Co-authored-by: Magic <magic@B-4TMH9N3X-2120.local> Co-authored-by: aries_ckt <916701291@qq.com>
142 lines
3.7 KiB
Python
142 lines
3.7 KiB
Python
#!/usr/bin/env python3
|
|
# -*- coding:utf-8 -*-
|
|
|
|
"""We need to design a base class. That other connector can Write with this"""
|
|
from abc import ABC
|
|
from typing import Iterable, List, Optional, Any, Dict
|
|
|
|
|
|
class BaseConnect(ABC):
|
|
def get_table_names(self) -> Iterable[str]:
|
|
"""Get all table names"""
|
|
pass
|
|
|
|
def get_table_info(self, table_names: Optional[List[str]] = None) -> str:
|
|
"""Get table info about specified table.
|
|
|
|
Returns:
|
|
str: Table information joined by '\n\n'
|
|
"""
|
|
pass
|
|
|
|
def get_index_info(self, table_names: Optional[List[str]] = None) -> str:
|
|
"""Get index info about specified table.
|
|
|
|
Args:
|
|
table_names (Optional[List[str]]): table names
|
|
"""
|
|
pass
|
|
|
|
def get_example_data(self, table: str, count: int = 3):
|
|
"""Get example data about specified table.
|
|
|
|
Not used now.
|
|
|
|
Args:
|
|
table (str): table name
|
|
count (int): example data count
|
|
"""
|
|
pass
|
|
|
|
def get_database_list(self) -> List[str]:
|
|
"""Get database list.
|
|
|
|
Returns:
|
|
List[str]: database list
|
|
"""
|
|
pass
|
|
|
|
def get_database_names(self):
|
|
"""Get database names."""
|
|
pass
|
|
|
|
def get_table_comments(self, db_name: str):
|
|
"""Get table comments.
|
|
|
|
Args:
|
|
db_name (str): database name
|
|
"""
|
|
pass
|
|
|
|
def get_table_comment(self, table_name: str) -> Dict:
|
|
"""Get table comment.
|
|
Args:
|
|
table_name (str): table name
|
|
Returns:
|
|
comment: Dict, which contains text: Optional[str], eg:["text": "comment"]
|
|
"""
|
|
pass
|
|
|
|
def get_columns(self, table_name: str) -> List[Dict]:
|
|
"""Get columns.
|
|
Args:
|
|
table_name (str): table name
|
|
Returns:
|
|
columns: List[Dict], which contains name: str, type: str, default_expression: str, is_in_primary_key: bool, comment: str
|
|
eg:[{'name': 'id', 'type': 'int', 'default_expression': '', 'is_in_primary_key': True, 'comment': 'id'}, ...]
|
|
"""
|
|
pass
|
|
|
|
def get_column_comments(self, db_name, table_name):
|
|
"""Get column comments.
|
|
|
|
Args:
|
|
table_name (_type_): _description_
|
|
"""
|
|
pass
|
|
|
|
def run(self, command: str, fetch: str = "all") -> List:
|
|
"""Execute sql command.
|
|
|
|
Args:
|
|
command (str): sql command
|
|
fetch (str): fetch type
|
|
"""
|
|
pass
|
|
|
|
def run_to_df(self, command: str, fetch: str = "all"):
|
|
"""Execute sql command and return dataframe."""
|
|
pass
|
|
|
|
def get_users(self):
|
|
"""Get user info."""
|
|
return []
|
|
|
|
def get_grants(self):
|
|
"""Get grant info."""
|
|
return []
|
|
|
|
def get_collation(self):
|
|
"""Get collation."""
|
|
return None
|
|
|
|
def get_charset(self) -> str:
|
|
"""Get character_set of current database."""
|
|
return "utf-8"
|
|
|
|
def get_fields(self, table_name):
|
|
"""Get column fields about specified table."""
|
|
pass
|
|
|
|
def get_simple_fields(self, table_name):
|
|
"""Get column fields about specified table."""
|
|
return self.get_fields(table_name)
|
|
|
|
def get_show_create_table(self, table_name):
|
|
"""Get the creation table sql about specified table."""
|
|
pass
|
|
|
|
def get_indexes(self, table_name: str) -> List[Dict]:
|
|
"""Get table indexes about specified table.
|
|
Args:
|
|
table_name (str): table name
|
|
Returns:
|
|
indexes: List[Dict], eg:[{'name': 'idx_key', 'column_names': ['id']}]
|
|
"""
|
|
pass
|
|
|
|
@classmethod
|
|
def is_normal_type(cls) -> bool:
|
|
"""Return whether the connector is a normal type."""
|
|
return True
|