Toggle Menu
Prev Up Next

# `langchain_community.document_loaders.kinetica_loader`.KineticaLoader

class langchain_community.document_loaders.kinetica_loader.KineticaLoader(query: str, host: str, username: str, password: str, parameters: Optional[Dict[str, Any]] = None, page_content_columns: Optional[List[str]] = None, metadata_columns: Optional[List[str]] = None)

  Load from Kinetica API.

  Each document represents one row of the result. The page_content_columns are written into the page_content of the document. The metadata_columns are written into the metadata of the document. By default, all columns are written into the page_content and none into the metadata.

  Initialize Kinetica document loader.

  Parameters

    - query (str) – The query to run in Kinetica.

    - parameters (Optional[Dict[str, Any]]) – Optional. Parameters to pass to the query.

    - page_content_columns (Optional[List[str]]) – Optional. Columns written to Document page_content.

    - metadata_columns (Optional[List[str]]) – Optional. Columns written to Document metadata.

    - host (str) –

    - username (str) –

    - password (str) –

  Methods

  `__init__`(query, host, username, password[, ...]) | Initialize Kinetica document loader.
  `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.

  __init__(query: str, host: str, username: str, password: str, parameters: Optional[Dict[str, Any]] = None, page_content_columns: Optional[List[str]] = None, metadata_columns: Optional[List[str]] = None)

    Initialize Kinetica document loader.

    Parameters

      - query (str) – The query to run in Kinetica.

      - parameters (Optional[Dict[str, Any]]) – Optional. Parameters to pass to the query.

      - page_content_columns (Optional[List[str]]) – Optional. Columns written to Document page_content.

      - metadata_columns (Optional[List[str]]) – Optional. Columns written to Document metadata.

      - host (str) –

      - username (str) –

      - password (str) –

  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.

    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]