langchain_community.document_loaders.bigquery.BigQueryLoader¶

class langchain_community.document_loaders.bigquery.BigQueryLoader(query: str, project: Optional[str] = None, page_content_columns: Optional[List[str]] = None, metadata_columns: Optional[List[str]] = None, credentials: Optional[Credentials] = None)[source]¶

Load from the Google Cloud Platform BigQuery.

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 BigQuery document loader.

Parameters

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

  • project (Optional[str]) – Optional. The project to run the query in.

  • page_content_columns (Optional[List[str]]) – Optional. The columns to write into the page_content of the document.

  • metadata_columns (Optional[List[str]]) – Optional. The columns to write into the metadata of the document.

  • credentials (Optional[Credentials]) –

    google.auth.credentials.Credentials, optional Credentials for accessing Google APIs. Use this parameter to override

    default credentials, such as to use Compute Engine (google.auth.compute_engine.Credentials) or Service Account (google.oauth2.service_account.Credentials) credentials directly.

Methods

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

Initialize BigQuery 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, project: Optional[str] = None, page_content_columns: Optional[List[str]] = None, metadata_columns: Optional[List[str]] = None, credentials: Optional[Credentials] = None)[source]¶

Initialize BigQuery document loader.

Parameters

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

  • project (Optional[str]) – Optional. The project to run the query in.

  • page_content_columns (Optional[List[str]]) – Optional. The columns to write into the page_content of the document.

  • metadata_columns (Optional[List[str]]) – Optional. The columns to write into the metadata of the document.

  • credentials (Optional[Credentials]) –

    google.auth.credentials.Credentials, optional Credentials for accessing Google APIs. Use this parameter to override

    default credentials, such as to use Compute Engine (google.auth.compute_engine.Credentials) or Service Account (google.oauth2.service_account.Credentials) credentials directly.

async alazy_load() → AsyncIterator[Document]¶

A lazy loader for Documents.

Return type

AsyncIterator[Document]

lazy_load() → Iterator[Document]¶

A lazy loader for Documents.

Return type

Iterator[Document]

load() → List[Document][source]¶

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