Toggle Menu
Prev Up Next

# `langchain_community.document_loaders.surrealdb`.SurrealDBLoader

class langchain_community.document_loaders.surrealdb.SurrealDBLoader(filter_criteria: Optional[Dict] = None, **kwargs: Any)

  Load SurrealDB documents.

  Methods

  `__init__`([filter_criteria]) |
  `alazy_load`() | A lazy loader for Documents.
  `aload`() | Load data into Document objects.
  `initialize`() | Initialize connection to surrealdb database and authenticate if credentials are provided
  `lazy_load`() | A lazy loader for Documents.
  `load`() | Load data into Document objects.
  `load_and_split`([text_splitter]) | Load Documents and split into chunks.

  Parameters

    - filter_criteria (Optional[Dict]) –

    - kwargs (Any) –

  __init__(filter_criteria: Optional[Dict] = None, **kwargs: Any) → None
    Parameters

      - filter_criteria (Optional[Dict]) –

      - kwargs (Any) –

    Return type

      None

  async alazy_load() → AsyncIterator[Document]

    A lazy loader for Documents.

    Return type

      AsyncIterator[Document]

  async aload() → List[Document]

    Load data into Document objects.

    Return type

      List[Document]

  async initialize() → None

    Initialize connection to surrealdb database and authenticate if credentials are provided

    Return type

      None

  lazy_load() → Iterator[Document]

    A lazy loader for Documents.

    Return type

      Iterator[Document]

  load() → List[Document]

    Load data into Document objects.

    Return type

      List[Document]

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

    Load Documents and split into chunks. Chunks are returned as Documents.

    Do not override this method. It should be considered to be deprecated!

    Parameters

      text_splitter (Optional[TextSplitter]) – TextSplitter instance to use for splitting documents. Defaults to RecursiveCharacterTextSplitter.

    Returns

      List of Documents.

    Return type

      List[Document]

# Examples using SurrealDBLoader

- %pip install –upgrade –quiet surrealdb langchain langchain-community