数据库
DatabaseReader #
基类: BaseReader
简单的数据库读取器。
通过查询从数据库读取数据并返回LlamaIndex Document对象。允许指定元数据列(可选择重命名)并从文本内容中排除列。还可以从行数据生成自定义的Document ID。
当与 sql_database
一起传递时,不支持 schema
参数。
如果 sql_database
对象是使用 schema 创建的,则将使用该 schema。
参数
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
sql_database
|
Optional[SQLDatabase]
|
要使用的SQL数据库,包括要指定的表名。更多详情请参阅 :ref: |
无
|
engine
|
Optional[Engine]
|
数据库连接的SQLAlchemy Engine对象。 |
无
|
uri
|
Optional[str]
|
数据库连接的uri。 |
无
|
scheme
|
Optional[str]
|
数据库连接的scheme。 |
无
|
host
|
Optional[str]
|
数据库连接的host。 |
无
|
port
|
Optional[int]
|
数据库连接的port。 |
无
|
user
|
Optional[str]
|
数据库连接的user。 |
无
|
password
|
Optional[str]
|
数据库连接的password。 |
无
|
dbname
|
Optional[str]
|
数据库连接的dbname。 |
无
|
返回值
名称 | 类型 | 描述 |
---|---|---|
DatabaseReader |
一个DatabaseReader对象。 |
注意
schema (Optional[str]): 数据库schema 仅在 此类内部创建连接对象时(即传递 engine、uri 或单独的连接参数时)才会生效。如果您提供一个已构建的 SQLDatabase 对象,则使用其内部 schema(如果存在),并且此参数将被忽略。
连接模式#
+----------------------------+-----------+---------------------------------------+ | 模式 | 支持 | 注意 | +============================+===========+=======================================+ | sql_database
| ✖ | 如果在此处需要处理 schema,请传递一个预配置的 SQLDatabase
对象。 | | | | | +----------------------------+-----------+---------------------------------------+ | engine
+ schema
| ✔ | | +----------------------------+-----------+---------------------------------------+ | uri
+ schema
| ✔ | | +----------------------------+-----------+---------------------------------------+ | scheme/host/…
+ | ✔ | | | schema
| | | +----------------------------+-----------+---------------------------------------+
(schema = 数据库命名空间; scheme = 驱动/方言,例如 postgresql+psycopg
)
源代码位于 llama-index-integrations/readers/llama-index-readers-database/llama_index/readers/database/base.py
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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
|
lazy_load_data #
lazy_load_data(query: str, metadata_cols: Optional[Iterable[Union[str, Tuple[str, str]]]] = None, excluded_text_cols: Optional[Iterable[str]] = None, document_id: Optional[Callable[[Dict[str, Any]], str]] = None, **load_kwargs: Any) -> Generator[Document, Any, None]
从数据库延迟查询和加载数据。
参数
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
query
|
str
|
要执行的SQL查询。 |
必需 |
metadata_cols
|
Optional[Iterable[Union[str, Tuple[str, str]]]]
|
要包含在Document元数据中的列名或(db_col, meta_key)元组的迭代器。如果是str,列名用作键。如果是元组,第一个元素用作DB列名,第二个用作元数据键。如果两个条目映射到相同的元数据键,后者将静默覆盖前者 - 请避免重复。 |
无
|
excluded_text_cols
|
Optional[Iterable[str]]
|
要从Document文本中排除的列名的迭代器。对于仅元数据列很有用。 |
无
|
document_id
|
Optional[Callable[[Dict[str, Any]], str]]
|
一个函数,接受一行数据(以字典形式)并返回一个字符串作为Document的 |
无
|
**load_kwargs
|
Any
|
额外的关键字参数(被忽略)。 |
{}
|
Yields
名称 | 类型 | 描述 |
---|---|---|
Document |
Document
|
为获取的每一行数据生成一个Document对象。 |
源代码位于 llama-index-integrations/readers/llama-index-readers-database/llama_index/readers/database/base.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
|
load_data #
load_data(query: str, metadata_cols: Optional[Iterable[Union[str, Tuple[str, str]]]] = None, excluded_text_cols: Optional[Iterable[str]] = None, document_id: Optional[Callable[[Dict[str, Any]], str]] = None, **load_kwargs: Any) -> List[Document]
从数据库查询数据并将其加载到Document列表中。
参数
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
query
|
str
|
要执行的SQL查询。 |
必需 |
metadata_cols
|
Optional[Iterable[Union[str, Tuple[str, str]]]]
|
要包含在Document元数据中的列名或(db_col, meta_key)元组的迭代器。如果是str,列名用作键。如果是元组,第一个元素用作DB列名,第二个用作元数据键。如果两个条目映射到相同的元数据键,后者将静默覆盖前者 - 请避免重复。 |
无
|
excluded_text_cols
|
Optional[Iterable[str]]
|
要从Document文本中排除的列名的迭代器。对于仅元数据列很有用。 |
无
|
document_id
|
Optional[Callable[[Dict[str, Any]], str]]
|
一个函数,接受一行数据(以字典形式)并返回一个字符串作为Document的 |
无
|
**load_kwargs
|
Any
|
传递给 lazy_load_data 的额外参数。 |
{}
|
返回值
类型 | 描述 |
---|---|
List[Document]
|
List[Document]: 一个Document对象列表。 |
源代码位于 llama-index-integrations/readers/llama-index-readers-database/llama_index/readers/database/base.py
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
|
aload_data async
#
aload_data(query: str, metadata_cols: Optional[Iterable[Union[str, Tuple[str, str]]]] = None, excluded_text_cols: Optional[Iterable[str]] = None, document_id: Optional[Callable[[Dict[str, Any]], str]] = None, **load_kwargs: Any) -> List[Document]
异步地从数据库查询数据并加载到列表中。
实现使用了 asyncio.to_thread
;数据库I/O仍然
在工作线程中运行,而不是在异步驱动中。
参数
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
query
|
str
|
要执行的SQL查询。 |
必需 |
metadata_cols
|
Optional[Iterable[Union[str, Tuple[str, str]]]]
|
要包含在Document元数据中的列名或(db_col, meta_key)元组的迭代器。如果是str,列名用作键。如果是元组,第一个元素用作DB列名,第二个用作元数据键。如果两个条目映射到相同的元数据键,后者将静默覆盖前者 - 请避免重复。 |
无
|
excluded_text_cols
|
Optional[Iterable[str]]
|
要从Document文本中排除的列名的迭代器。对于仅元数据列很有用。 |
无
|
document_id
|
Optional[Callable[[Dict[str, Any]], str]]
|
一个函数,接受一行数据(以字典形式)并返回一个字符串作为Document的 |
无
|
**load_kwargs
|
Any
|
传递给底层加载方法的额外参数。 |
{}
|
返回值
类型 | 描述 |
---|---|
List[Document]
|
List[Document]: 一个Document对象列表。 |
源代码位于 llama-index-integrations/readers/llama-index-readers-database/llama_index/readers/database/base.py
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
|