Google Cloud SQL for SQL server

Cloud SQL 是一项全托管式关系数据库服务，提供高性能、无缝集成和出色的可扩展性。它提供 MySQL、PostgreSQL 和 SQL Server 数据库引擎。利用 Cloud SQL 的 Langchain 集成，扩展您的数据库应用程序以构建由 AI 驱动的体验。

本 Notebook 介绍如何使用 Cloud SQL for SQL server 通过 MSSQLLoader 和 MSSQLDocumentSaver 来 保存、加载和删除 Langchain 文档。

在 GitHub 上了解有关该软件包的更多信息。

开始之前

要运行此笔记本，您需要执行以下操作：

• 创建 Google Cloud 项目
• 启用 Cloud SQL Admin API
• 创建 Cloud SQL for SQL server 实例
• 创建 Cloud SQL 数据库
• 向数据库添加 IAM 数据库用户（可选）

在笔记本的运行时环境中确认数据库访问权限后，请填充以下值并运行单元格，然后再运行示例脚本。

# @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 --upgrade --quiet 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)

🔐 身份验证

通过当前笔记本登录的 IAM 用户身份验证到 Google Cloud，以便访问您的 Google Cloud 项目。

• 如果您使用 Colab 运行此笔记本，请使用下面的单元格并继续。
• 如果您使用 Vertex AI Workbench，请参阅此处的设置说明：https://github.com/GoogleCloudPlatform/generative-ai/tree/main/setup-env。

from google.colab import auth

auth.authenticate_user()

☁ 设置您的 Google Cloud 项目

设置您的 Google Cloud 项目，以便在本笔记本中利用 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>) 初始化一个默认模式的表。表结构：

• page_content (类型：text)
• langchain_metadata (类型：JSON)

overwrite_existing=True 标志表示新初始化的表将替换同名的现有表。

engine.init_document_table(TABLE_NAME, overwrite_existing=True)

保存文档

使用 MSSQLDocumentSaver.add_documents(<documents>) 保存Langchain文档。要初始化 MSSQLDocumentSaver 类，您需要提供两项：

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)

API Reference:Document

加载文档

使用 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 文档。

对于具有默认架构（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())

高级用法

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

首先，我们准备一个具有非默认模式的示例表，并用一些任意数据填充它。

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())

删除具有自定义页面内容和元数据的文档

To delete documents that include custom page content and metadata, you will need to create a DeleteMany

我们也可以通过 MSSQLDocumentSaver.delete(<documents>) 从具有自定义元数据列的表中删除文档。删除标准是：

如果列表中存在一个 document，使得：

• 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())

Related

• Document loader conceptual guide
• Document loader how-to guides