langchain_community.document_loaders.tidb.TiDBLoader

class langchain_community.document_loaders.tidb.TiDBLoader(connection_string: str, query: str, page_content_columns: Optional[List[str]] = None, metadata_columns: Optional[List[str]] = None, engine_args: Optional[Dict[str, Any]] = None)[source]

从TiDB加载文档。

初始化TiDB文档加载器。

参数

  • connection_string (str) – TiDB数据库的连接字符串，格式：“mysql+pymysql://[email protected]:4000/test”。

  • query (str) – 在TiDB中运行的查询。

  • page_content_columns (Optional[List[str]]) – 可选。写入到文档page_content的列，默认为None，即所有列。

  • metadata_columns (Optional[List[str]]) – 可选。写入到文档metadata的列，默认为None，即无列。

  • engine_args (Optional[Dict[str, Any]]) – 可选。传递给sqlalchemy引擎的额外参数。

方法

__init__(connection_string, query[, ...])

初始化TiDB文档加载器。

alazy_load()

Documents的延迟加载器。

aload()

将数据加载到Document对象中。

lazy_load()

延迟将TiDB数据加载到文档对象中。

load()

将数据加载到Document对象中。

load_and_split([text_splitter])

加载文档并分割成块。
__init__(connection_string: str, query: str, page_content_columns: Optional[List[str]] = None, metadata_columns: Optional[List[str]] = None, engine_args: Optional[Dict[str, Any]] = None) → None[source]

初始化TiDB文档加载器。

参数

  • connection_string (str) – TiDB数据库的连接字符串，格式：“mysql+pymysql://[email protected]:4000/test”。

  • query (str) – 在TiDB中运行的查询。

  • page_content_columns (Optional[List[str]]) – 可选。写入到文档page_content的列，默认为None，即所有列。

  • metadata_columns (Optional[List[str]]) – 可选。写入到文档metadata的列，默认为None，即无列。

  • engine_args (Optional[Dict[str, Any]]) – 可选。传递给sqlalchemy引擎的额外参数。

返回类型

None

async alazy_load() → AsyncIterator[Document]

Documents的延迟加载器。

返回类型

AsyncIterator[Document]

async aload() → List[Document]

将数据加载到Document对象中。

返回类型

List[Document]

lazy_load() → Iterator[Document][source]

延迟将TiDB数据加载到文档对象中。

返回类型

Iterator[Document]

load() → List[Document]

将数据加载到Document对象中。

返回类型

List[Document]

load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]

加载文档并将其拆分为块。块以Document的形式返回。

不要重写此方法。应考虑将其弃用！

参数

text_splitter (可选[TextSplitter]) – 用于拆分文档的TextSplitter实例。默认为RecursiveCharacterTextSplitter。

返回

文档列表。

返回类型

List[Document]

使用TiDBLoader的示例