TiDBLoader#

class langchain_community.document_loaders.tidb.TiDBLoader(connection_string: str, query: str, page_content_columns: List[str] | None = None, metadata_columns: List[str] | None = None, engine_args: Dict[str, Any] | None = None)[来源]#

从TiDB加载文档。

初始化 TiDB 文档加载器。

Parameters:
  • connection_string (str) – TiDB数据库的连接字符串, 格式: “mysql+pymysql://root@127.0.0.1:4000/test”.

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

  • page_content_columns (List[str] | None) – 可选。写入文档page_content的列,默认为None,表示所有列。

  • metadata_columns (List[str] | None) – 可选。写入文档metadata的列,默认为None,表示不写入任何列。

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

方法

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

初始化 TiDB 文档加载器。

alazy_load()

文档的懒加载器。

aload()

将数据加载到Document对象中。

lazy_load()

懒加载TiDB数据到文档对象中。

load()

将数据加载到Document对象中。

load_and_split([text_splitter])

加载文档并分割成块。

__init__(connection_string: str, query: str, page_content_columns: List[str] | None = None, metadata_columns: List[str] | None = None, engine_args: Dict[str, Any] | None = None) None[来源]#

初始化 TiDB 文档加载器。

Parameters:
  • connection_string (str) – TiDB数据库的连接字符串, 格式: “mysql+pymysql://root@127.0.0.1:4000/test”.

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

  • page_content_columns (List[str] | None) – 可选。写入文档page_content的列,默认为None,表示所有列。

  • metadata_columns (List[str] | None) – 可选。写入文档metadata的列,默认为None,表示不写入任何列。

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

Return type:

async alazy_load() AsyncIterator[Document]#

文档的懒加载器。

Return type:

AsyncIterator[Document]

async aload() list[Document]#

将数据加载到Document对象中。

Return type:

列表[Document]

lazy_load() Iterator[Document][source]#

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

Return type:

迭代器[文档]

load() list[Document]#

将数据加载到Document对象中。

Return type:

列表[Document]

load_and_split(text_splitter: TextSplitter | None = None) list[Document]#

加载文档并将其分割成块。块以文档形式返回。

不要重写此方法。它应该被视为已弃用!

Parameters:

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

Returns:

文档列表。

Return type:

列表[Document]

使用 TiDBLoader 的示例