Toggle Menu
Prev Up Next

# `langchain_community.document_loaders.mongodb`.MongodbLoader

class langchain_community.document_loaders.mongodb.MongodbLoader(connection_string: str, db_name: str, collection_name: str, *, filter_criteria: Optional[Dict] = None, field_names: Optional[Sequence[str]] = None)

  Load MongoDB documents.

  Methods

  `__init__`(connection_string, db_name, ...[, ...]) |
  `alazy_load`() | A lazy loader for Documents.
  `aload`() | Load data into Document objects.
  `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

    - connection_string (str) –

    - db_name (str) –

    - collection_name (str) –

    - filter_criteria (Optional[Dict]) –

    - field_names (Optional[Sequence[str]]) –

  __init__(connection_string: str, db_name: str, collection_name: str, *, filter_criteria: Optional[Dict] = None, field_names: Optional[Sequence[str]] = None) → None
    Parameters

      - connection_string (str) –

      - db_name (str) –

      - collection_name (str) –

      - filter_criteria (Optional[Dict]) –

      - field_names (Optional[Sequence[str]]) –

    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]

  lazy_load() → Iterator[Document]

    A lazy loader for Documents.

    Return type

      Iterator[Document]

  load() → List[Document]

    Load data into Document objects.

    Attention:

    This implementation starts an asyncio event loop which will only work if running in a sync env. In an async env, it should fail since there is already an event loop running.

    This code should be updated to kick off the event loop from a separate thread if running within an async context.

    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 MongodbLoader

- add this import for running in jupyter notebook