数据库
数据库工具规范 #
基类: BaseToolSpec
, BaseReader
简易数据库工具。
将每一行连接成LlamaIndex使用的文档。
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
sql_database
|
Optional[SQLDatabase]
|
要使用的SQL数据库,包括需要指定的表名。详情请参阅: |
None
|
engine
|
Optional[Engine]
|
数据库连接的SQLAlchemy引擎对象。 |
None
|
uri
|
Optional[str]
|
数据库连接的URI。 |
None
|
scheme
|
Optional[str]
|
数据库连接的方案。 |
None
|
host
|
Optional[str]
|
数据库连接的主机。 |
None
|
port
|
Optional[int]
|
数据库连接的端口。 |
None
|
user
|
Optional[str]
|
数据库连接的用户。 |
None
|
password
|
Optional[str]
|
数据库连接的密码。 |
None
|
dbname
|
Optional[str]
|
数据库连接的dbname。 |
None
|
Source code in llama-index-integrations/tools/llama-index-tools-database/llama_index/tools/database/base.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
|
加载数据 #
load_data(query: str) -> List[Document]
从数据库查询并加载数据,返回一个文档列表。
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
query
|
str
|
一个用于筛选表和行的SQL查询。 |
required |
返回:
类型 | 描述 |
---|---|
List[Document]
|
List[Document]: 一个Document对象列表。 |
Source code in llama-index-integrations/tools/llama-index-tools-database/llama_index/tools/database/base.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
|
list_tables #
list_tables() -> List[str]
返回数据库中可用表的列表。 要获取特定表列的详细信息,请使用 describe_tables端点。
Source code in llama-index-integrations/tools/llama-index-tools-database/llama_index/tools/database/base.py
106 107 108 109 110 111 112 |
|
描述表 #
describe_tables(tables: Optional[List[str]] = None) -> str
描述数据库中指定的表。
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
tables
|
List[str]
|
要检索详细信息的表名列表 |
None
|
Source code in llama-index-integrations/tools/llama-index-tools-database/llama_index/tools/database/base.py
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
|