langchain_community.document_loaders.snowflake_loader.SnowflakeLoader¶

class langchain_community.document_loaders.snowflake_loader.SnowflakeLoader(query: str, user: str, password: str, account: str, warehouse: str, role: str, database: str, schema: str, parameters: Optional[Dict[str, Any]] = None, page_content_columns: Optional[List[str]] = None, metadata_columns: Optional[List[str]] = None)[source]¶

Load from Snowflake 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 Snowflake document loader.

Parameters

  • query (str) – The query to run in Snowflake.

  • user (str) – Snowflake user.

  • password (str) – Snowflake password.

  • account (str) – Snowflake account.

  • warehouse (str) – Snowflake warehouse.

  • role (str) – Snowflake role.

  • database (str) – Snowflake database

  • schema (str) – Snowflake schema

  • 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.

Methods

__init__(query, user, password, account, ...)

Initialize Snowflake document loader.

alazy_load()

A lazy loader for Documents.

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, user: str, password: str, account: str, warehouse: str, role: str, database: str, schema: str, parameters: Optional[Dict[str, Any]] = None, page_content_columns: Optional[List[str]] = None, metadata_columns: Optional[List[str]] = None)[source]¶

Initialize Snowflake document loader.

Parameters

  • query (str) – The query to run in Snowflake.

  • user (str) – Snowflake user.

  • password (str) – Snowflake password.

  • account (str) – Snowflake account.

  • warehouse (str) – Snowflake warehouse.

  • role (str) – Snowflake role.

  • database (str) – Snowflake database

  • schema (str) – Snowflake schema

  • 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.

async alazy_load() → AsyncIterator[Document]¶

A lazy loader for Documents.

Return type

AsyncIterator[Document]

lazy_load() → Iterator[Document][source]¶

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 SnowflakeLoader¶