Skip to main content
Spanner 是一种高度可扩展的数据库，将无限扩展性与关系语义（如二级索引、强一致性、Schema 和 SQL）相结合，以一种简便的解决方案提供 99.999% 的可用性。
本 notebook 介绍如何使用 Spanner 通过 SpannerLoader 和 SpannerDocumentSaver 来保存、加载和删除 LangChain 文档。 在 GitHub 上了解更多关于该软件包的信息。 Open In Colab

​
开始之前

要运行本 notebook，您需要完成以下步骤： 在本 notebook 的运行环境中确认可以访问数据库后，填写以下值并在运行示例脚本前先运行该单元格。 
# @markdown Please specify an instance id, a database, and a table for demo purpose.
INSTANCE_ID = "test_instance"  # @param {type:"string"}
DATABASE_ID = "test_database"  # @param {type:"string"}
TABLE_NAME = "test_table"  # @param {type:"string"}

​
🦜🔗 安装库

该集成位于独立的 langchain-google-spanner 包中，需要单独安装。 
pip install -upgrade --quiet langchain-google-spanner langchain
仅限 Colab：取消注释以下单元格以重启内核，或使用按钮重启内核。对于 Vertex AI Workbench，可以使用顶部的按钮重启终端。 
# # Automatically restart kernel after installs so that your environment can access the new packages
# import IPython

# app = IPython.Application.instance()
# app.kernel.do_shutdown(True)

​
☁ 设置您的 Google Cloud 项目

设置您的 Google Cloud 项目，以便在本 notebook 中使用 Google Cloud 资源。 如果您不知道项目 ID，请尝试以下方法：
  • 运行 gcloud config list。
  • 运行 gcloud projects list。
  • 查看支持页面：查找项目 ID。
# @markdown Please fill in the value below with your Google Cloud project ID and then run the cell.

PROJECT_ID = "my-project-id"  # @param {type:"string"}

# Set the project id
!gcloud config set project {PROJECT_ID}

​
🔐 身份验证

以登录本 notebook 的 IAM 用户身份对 Google Cloud 进行身份验证，以访问您的 Google Cloud 项目。
  • 如果您使用 Colab 运行本 notebook，请使用下面的单元格并继续。
  • 如果您使用 Vertex AI Workbench，请查看此处的设置说明。
from google.colab import auth

auth.authenticate_user()

​
基本用法

​
保存文档

使用 SpannerDocumentSaver.add_documents(<documents>) 保存 LangChain 文档。要初始化 SpannerDocumentSaver 类，您需要提供以下三项：
  1. instance_id - 用于加载数据的 Spanner 实例。
  2. database_id - 用于加载数据的 Spanner 数据库实例。
  3. table_name - Spanner 数据库中用于存储 LangChain 文档的表名。
from langchain_core.documents import Document
from langchain_google_spanner import SpannerDocumentSaver

test_docs = [
    Document(
        page_content="Apple Granny Smith 150 0.99 1",
        metadata={"fruit_id": 1},
    ),
    Document(
        page_content="Banana Cavendish 200 0.59 0",
        metadata={"fruit_id": 2},
    ),
    Document(
        page_content="Orange Navel 80 1.29 1",
        metadata={"fruit_id": 3},
    ),
]

saver = SpannerDocumentSaver(
    instance_id=INSTANCE_ID,
    database_id=DATABASE_ID,
    table_name=TABLE_NAME,
)
saver.add_documents(test_docs)

​
从 Spanner 查询文档

有关连接 Spanner 表的更多详情，请查看 Python SDK 文档。

​
从表中加载文档

使用 SpannerLoader.load() 或 SpannerLoader.lazy_load() 加载 LangChain 文档。lazy_load 返回一个生成器，仅在迭代时查询数据库。要初始化 SpannerLoader 类，您需要提供：
  1. instance_id - 用于加载数据的 Spanner 实例。
  2. database_id - 用于加载数据的 Spanner 数据库实例。
  3. query - 数据库方言的查询语句。
from langchain_google_spanner import SpannerLoader

query = f"SELECT * from {TABLE_NAME}"
loader = SpannerLoader(
    instance_id=INSTANCE_ID,
    database_id=DATABASE_ID,
    query=query,
)

for doc in loader.lazy_load():
    print(doc)
    break

​
删除文档

使用 SpannerDocumentSaver.delete(<documents>) 从表中删除一组 LangChain 文档。 
docs = loader.load()
print("Documents before delete:", docs)

doc = test_docs[0]
saver.delete([doc])
print("Documents after delete:", loader.load())

​
高级用法

​
自定义客户端

默认创建的客户端是默认客户端。要显式传入 credentials 和 project，可以将自定义客户端传递给构造函数。 
from google.cloud import spanner
from google.oauth2 import service_account

creds = service_account.Credentials.from_service_account_file("/path/to/key.json")
custom_client = spanner.Client(project="my-project", credentials=creds)
loader = SpannerLoader(
    INSTANCE_ID,
    DATABASE_ID,
    query,
    client=custom_client,
)

​
自定义文档页面内容和元数据

加载器将返回一个文档列表，其中页面内容来自特定的数据列，所有其他数据列将添加到元数据中。每行对应一个文档。

​
自定义页面内容格式

SpannerLoader 假设存在一个名为 page_content 的列。这些默认值可以如下更改： 
custom_content_loader = SpannerLoader(
    INSTANCE_ID, DATABASE_ID, query, content_columns=["custom_content"]
)
如果指定了多列，页面内容的字符串格式将默认为 text（以空格分隔的字符串拼接）。用户也可以指定其他格式，包括 text、JSON、YAML、CSV。

​
自定义元数据格式

SpannerLoader 假设存在一个名为 langchain_metadata 的元数据列，用于存储 JSON 数据。该元数据列将用作基础字典。默认情况下，所有其他列数据都会被添加进来，并可能覆盖原始值。这些默认值可以如下更改： 
custom_metadata_loader = SpannerLoader(
    INSTANCE_ID, DATABASE_ID, query, metadata_columns=["column1", "column2"]
)

​
自定义 JSON 元数据列名

默认情况下，加载器使用 langchain_metadata 作为基础字典。可以自定义此项，选择一个 JSON 列作为文档元数据的基础字典。 
custom_metadata_json_loader = SpannerLoader(
    INSTANCE_ID, DATABASE_ID, query, metadata_json_column="another-json-column"
)

​
自定义时效性

默认时效性为 15 秒。可以通过指定较弱的绑定来自定义，该绑定可以是以给定时间戳执行所有读取，也可以是给定过去时间段之前。 
import datetime

timestamp = datetime.datetime.utcnow()
custom_timestamp_loader = SpannerLoader(
    INSTANCE_ID,
    DATABASE_ID,
    query,
    staleness=timestamp,
)

duration = 20.0
custom_duration_loader = SpannerLoader(
    INSTANCE_ID,
    DATABASE_ID,
    query,
    staleness=duration,
)

​
开启 data boost

默认情况下，加载器不会使用 data boost，因为它会产生额外费用，并需要额外的 IAM 权限。但用户可以选择开启。 
custom_databoost_loader = SpannerLoader(
    INSTANCE_ID,
    DATABASE_ID,
    query,
    databoost=True,
)

​
自定义客户端

默认创建的客户端是默认客户端。要显式传入 credentials 和 project，可以将自定义客户端传递给构造函数。 
from google.cloud import spanner

custom_client = spanner.Client(project="my-project", credentials=creds)
saver = SpannerDocumentSaver(
    INSTANCE_ID,
    DATABASE_ID,
    TABLE_NAME,
    client=custom_client,
)

​
自定义 SpannerDocumentSaver 初始化

SpannerDocumentSaver 支持自定义初始化，允许用户指定文档保存到表中的方式。 content_column：将用作文档页面内容的列名，默认为 page_content。 metadata_columns：如果键存在于文档元数据中，这些元数据将保存到特定列。 metadata_json_column：这将是特殊 JSON 列的列名，默认为 langchain_metadata。 
custom_saver = SpannerDocumentSaver(
    INSTANCE_ID,
    DATABASE_ID,
    TABLE_NAME,
    content_column="my-content",
    metadata_columns=["foo"],
    metadata_json_column="my-special-json-column",
)

​
为 Spanner 初始化自定义 Schema

SpannerDocumentSaver 提供 init_document_table 方法，用于创建具有自定义 Schema 的新表来存储文档。 
from langchain_google_spanner import Column

new_table_name = "my_new_table"

SpannerDocumentSaver.init_document_table(
    INSTANCE_ID,
    DATABASE_ID,
    new_table_name,
    content_column="my-page-content",
    metadata_columns=[
        Column("category", "STRING(36)", True),
        Column("price", "FLOAT64", False),
    ],
)
Edit this page on GitHub or file an issue.
Connect these docs to Claude, VSCode, and more via MCP for real-time answers.