Skip to main content
Cloud SQL 是一项全托管的关系型数据库服务，提供高性能、无缝集成和卓越的可扩展性。它支持 MySQL、PostgreSQL 和 SQL Server 数据库引擎。通过 Cloud SQL 的 LangChain 集成，扩展您的数据库应用，构建 AI 驱动的体验。
本 notebook 介绍如何使用 Cloud SQL for SQL Server 通过 MSSQLLoader 和 MSSQLDocumentSaver 来保存、加载和删除 LangChain 文档。 在 GitHub 上了解更多关于该软件包的信息。 Open In Colab

​
开始之前

要运行本 notebook，您需要完成以下准备工作： 确认可以在本 notebook 的运行环境中访问数据库后，请填写以下值并在运行示例脚本之前执行该单元格。 
# @markdown Please fill in the both the Google Cloud region and name of your Cloud SQL instance.
REGION = "us-central1"  # @param {type:"string"}
INSTANCE = "test-instance"  # @param {type:"string"}

# @markdown Please fill in user name and password of your Cloud SQL instance.
DB_USER = "sqlserver"  # @param {type:"string"}
DB_PASS = "password"  # @param {type:"string"}

# @markdown Please specify a database and a table for demo purpose.
DATABASE = "test"  # @param {type:"string"}
TABLE_NAME = "test-default"  # @param {type:"string"}

​
🦜🔗 安装库

该集成位于独立的 langchain-google-cloud-sql-mssql 包中，需要单独安装。 
pip install -qU langchain-google-cloud-sql-mssql
仅限 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)

​
🔐 身份验证

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

auth.authenticate_user()

​
☁ 设置 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}

​
💡 启用 API

langchain-google-cloud-sql-mssql 包要求您在 Google Cloud 项目中启用 Cloud SQL Admin API。 
# enable Cloud SQL Admin API
!gcloud services enable sqladmin.googleapis.com

​
基本用法

​
MSSQLEngine 连接池

在从 MSSQL 表保存或加载文档之前，首先需要配置连接池以连接到 Cloud SQL 数据库。MSSQLEngine 负责为您的 Cloud SQL 数据库配置 SQLAlchemy 连接池，确保应用程序成功连接并遵循行业最佳实践。 使用 MSSQLEngine.from_instance() 创建 MSSQLEngine 时，您只需提供以下 4 个参数：
  1. project_id：Cloud SQL 实例所在 Google Cloud 项目的项目 ID。
  2. region：Cloud SQL 实例所在的区域。
  3. instance：Cloud SQL 实例的名称。
  4. database：要连接到的 Cloud SQL 数据库名称。
  5. user：用于内置数据库身份验证和登录的数据库用户名。
  6. password：用于内置数据库身份验证和登录的数据库密码。
from langchain_google_cloud_sql_mssql import MSSQLEngine

engine = MSSQLEngine.from_instance(
    project_id=PROJECT_ID,
    region=REGION,
    instance=INSTANCE,
    database=DATABASE,
    user=DB_USER,
    password=DB_PASS,
)

​
初始化表

通过 MSSQLEngine.init_document_table(<table_name>) 初始化默认 Schema 的表。表列如下：
  • page_content（类型：text）
  • langchain_metadata（类型：JSON）
overwrite_existing=True 标志表示新初始化的表将替换同名的现有表。 
engine.init_document_table(TABLE_NAME, overwrite_existing=True)

​
保存文档

使用 MSSQLDocumentSaver.add_documents(<documents>) 保存 LangChain 文档。初始化 MSSQLDocumentSaver 类需要提供以下 2 个参数：
  1. engine：MSSQLEngine 引擎的实例。
  2. table_name：Cloud SQL 数据库中用于存储 LangChain 文档的表名。
from langchain_core.documents import Document
from langchain_google_cloud_sql_mssql import MSSQLDocumentSaver

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 = MSSQLDocumentSaver(engine=engine, table_name=TABLE_NAME)
saver.add_documents(test_docs)

​
加载文档

使用 MSSQLLoader.load() 或 MSSQLLoader.lazy_load() 加载 LangChain 文档。lazy_load 返回一个生成器，仅在迭代时才查询数据库。初始化 MSSQLDocumentSaver 类需要提供以下参数：
  1. engine：MSSQLEngine 引擎的实例。
  2. table_name：Cloud SQL 数据库中用于存储 LangChain 文档的表名。
from langchain_google_cloud_sql_mssql import MSSQLLoader

loader = MSSQLLoader(engine=engine, table_name=TABLE_NAME)
docs = loader.lazy_load()
for doc in docs:
    print("Loaded documents:", doc)

​
通过查询加载文档

除了从表中加载文档，我们还可以选择从 SQL 查询生成的视图中加载文档。例如： 
from langchain_google_cloud_sql_mssql import MSSQLLoader

loader = MSSQLLoader(
    engine=engine,
    query=f"select * from \"{TABLE_NAME}\" where JSON_VALUE(langchain_metadata, '$.fruit_id') = 1;",
)
onedoc = loader.load()
onedoc
SQL 查询生成的视图可能具有与默认表不同的 Schema。在这种情况下，MSSQLLoader 的行为与从非默认 Schema 的表加载时相同。请参阅使用自定义文档页面内容和元数据加载文档部分。

​
删除文档

使用 MSSQLDocumentSaver.delete(<documents>) 从 MSSQL 表中删除一组 LangChain 文档。 对于使用默认 Schema（page_content、langchain_metadata）的表，删除条件为： 如果列表中存在某个 document，满足以下条件，则应删除对应的 row：
  • document.page_content 等于 row[page_content]
  • document.metadata 等于 row[langchain_metadata]
from langchain_google_cloud_sql_mssql import MSSQLLoader

loader = MSSQLLoader(engine=engine, table_name=TABLE_NAME)
docs = loader.load()
print("Documents before delete:", docs)
saver.delete(onedoc)
print("Documents after delete:", loader.load())

​
高级用法

​
使用自定义文档页面内容和元数据加载文档

首先，我们准备一个使用非默认 Schema 的示例表，并向其中填充一些任意数据。 
import sqlalchemy

with engine.connect() as conn:
    conn.execute(sqlalchemy.text(f'DROP TABLE IF EXISTS "{TABLE_NAME}"'))
    conn.commit()
    conn.execute(
        sqlalchemy.text(
            f"""
            IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[{TABLE_NAME}]') AND type in (N'U'))
                BEGIN
                    CREATE TABLE [dbo].[{TABLE_NAME}](
                        fruit_id INT IDENTITY(1,1) PRIMARY KEY,
                        fruit_name VARCHAR(100) NOT NULL,
                        variety VARCHAR(50),
                        quantity_in_stock INT NOT NULL,
                        price_per_unit DECIMAL(6,2) NOT NULL,
                        organic BIT NOT NULL
                    )
                END
            """
        )
    )
    conn.execute(
        sqlalchemy.text(
            f"""
            INSERT INTO "{TABLE_NAME}" (fruit_name, variety, quantity_in_stock, price_per_unit, organic)
            VALUES
                ('Apple', 'Granny Smith', 150, 0.99, 1),
                ('Banana', 'Cavendish', 200, 0.59, 0),
                ('Orange', 'Navel', 80, 1.29, 1);
            """
        )
    )
    conn.commit()
如果我们仍然使用 MSSQLLoader 的默认参数从该示例表加载 LangChain 文档，则加载的文档的 page_content 将是表的第一列，而 metadata 将由其余所有列的键值对组成。 
loader = MSSQLLoader(
    engine=engine,
    table_name=TABLE_NAME,
)
loader.load()
我们可以在初始化 MSSQLLoader 时，通过设置 content_columns 和 metadata_columns 来指定要加载的内容和元数据。
  1. content_columns：要写入文档 page_content 的列。
  2. metadata_columns：要写入文档 metadata 的列。
例如，在此示例中，content_columns 中各列的值将以空格分隔拼接成字符串，作为加载文档的 page_content；加载文档的 metadata 将只包含 metadata_columns 中指定的列的键值对。 
loader = MSSQLLoader(
    engine=engine,
    table_name=TABLE_NAME,
    content_columns=[
        "variety",
        "quantity_in_stock",
        "price_per_unit",
        "organic",
    ],
    metadata_columns=["fruit_id", "fruit_name"],
)
loader.load()

​
使用自定义页面内容和元数据保存文档

为了将 LangChain 文档保存到具有自定义元数据字段的表中，首先需要通过 MSSQLEngine.init_document_table() 创建该表，并指定所需的 metadata_columns 列表。在本示例中，创建的表将包含以下列：
  • description（类型：text）：用于存储水果描述。
  • fruit_name（类型：text）：用于存储水果名称。
  • organic（类型：tinyint(1)）：用于标识水果是否为有机产品。
  • other_metadata（类型：JSON）：用于存储水果的其他元数据信息。
使用 MSSQLEngine.init_document_table() 创建表时，可使用以下参数：
  1. table_name：Cloud SQL 数据库中用于存储 LangChain 文档的表名。
  2. metadata_columns：sqlalchemy.Column 的列表，指定所需的元数据列。
  3. content_column：用于存储 LangChain 文档 page_content 的列名。默认值：page_content。
  4. metadata_json_column：用于存储 LangChain 文档额外 metadata 的 JSON 列名。默认值：langchain_metadata。
engine.init_document_table(
    TABLE_NAME,
    metadata_columns=[
        sqlalchemy.Column(
            "fruit_name",
            sqlalchemy.UnicodeText,
            primary_key=False,
            nullable=True,
        ),
        sqlalchemy.Column(
            "organic",
            sqlalchemy.Boolean,
            primary_key=False,
            nullable=True,
        ),
    ],
    content_column="description",
    metadata_json_column="other_metadata",
    overwrite_existing=True,
)
使用 MSSQLDocumentSaver.add_documents(<documents>) 保存文档。如本示例所示：
  • document.page_content 将保存到 description 列。
  • document.metadata.fruit_name 将保存到 fruit_name 列。
  • document.metadata.organic 将保存到 organic 列。
  • document.metadata.fruit_id 将以 JSON 格式保存到 other_metadata 列。
test_docs = [
    Document(
        page_content="Granny Smith 150 0.99",
        metadata={"fruit_id": 1, "fruit_name": "Apple", "organic": 1},
    ),
]
saver = MSSQLDocumentSaver(
    engine=engine,
    table_name=TABLE_NAME,
    content_column="description",
    metadata_json_column="other_metadata",
)
saver.add_documents(test_docs)

with engine.connect() as conn:
    result = conn.execute(sqlalchemy.text(f'select * from "{TABLE_NAME}";'))
    print(result.keys())
    print(result.fetchall())

​
使用自定义页面内容和元数据删除文档

我们还可以通过 MSSQLDocumentSaver.delete(<documents>) 从具有自定义元数据列的表中删除文档。删除条件为： 如果列表中存在某个 document，满足以下条件，则应删除对应的 row：
  • document.page_content 等于 row[page_content]
  • 对于 document.metadata 中的每个元数据字段 k
    • document.metadata[k] 等于 row[k] 或 document.metadata[k] 等于 row[langchain_metadata][k]
  • row 中不存在 document.metadata 中没有的额外元数据字段。
loader = MSSQLLoader(engine=engine, table_name=TABLE_NAME)
docs = loader.load()
print("Documents before delete:", docs)
saver.delete(docs)
print("Documents after delete:", loader.load())
在 GitHub 上编辑此页面 或 提交 Issue。
通过 MCP 将这些文档连接到 Claude、VSCode 等工具，获取实时解答。