适用于 MySQL 的 Google Cloud SQL

Cloud SQL 是一种完全托管的关系数据库服务，可提供高性能、无缝集成和令人印象深刻的可扩展性。它提供 MySQL、PostgreSQL 和 SQL Server 数据库引擎。扩展您的数据库应用，以利用 Cloud SQL 的 Langchain 集成构建 AI 驱动的体验。

此笔记本介绍了如何使用 Cloud SQL for MySQL 来保存、加载和删除 langchain 文档MySQLLoader和MySQLDocumentSaver.

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

准备工作

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

• 创建 Google Cloud 项目
• 启用 Cloud SQL Admin API。
• 创建 Cloud SQL for MySQL 实例
• 创建 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 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-mysql包中，因此我们需要安装它。

%pip install -upgrade --quiet langchain-google-cloud-sql-mysql

仅限 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 项目，以便您可以利用此笔记本中的 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}

🔐 认证

以登录此笔记本的 IAM 用户身份向 Google Cloud 进行身份验证，以便访问您的 Google Cloud 项目。

• 如果您使用 Colab 运行此笔记本，请使用下面的单元格并继续。
• 如果您使用的是 Vertex AI Workbench，请在此处查看设置说明。

from google.colab import auth

auth.authenticate_user()

基本用法

MySQLEngine 连接池

在保存或加载 MySQL 表的文档之前，我们首先需要配置一个到 Cloud SQL 数据库的连接池。这MySQLEngine配置到 Cloud SQL 数据库的连接池，从而支持从您的应用程序成功连接并遵循行业最佳实践。

要创建MySQLEngine用MySQLEngine.from_instance()您只需提供 4 项内容：

1. project_id：Cloud SQL 实例所在的 Google Cloud 项目的项目 ID。
2. region：Cloud SQL 实例所在的区域。
3. instance：Cloud SQL 实例的名称。
4. database：要在 Cloud SQL 实例上连接到的数据库的名称。

默认情况下，将使用 IAM 数据库身份验证作为数据库身份验证的方法。此库使用属于源自环境的应用程序默认凭证 （ADC） 的 IAM 委托人。

有关 IAM 数据库身份验证的更多信息，请参阅：

• 配置实例以进行 IAM 数据库身份验证
• 使用 IAM 数据库身份验证管理用户

（可选）也可以使用使用用户名和密码访问 Cloud SQL 数据库的内置数据库身份验证。只需提供可选的user和passwordarguments 设置为MySQLEngine.from_instance():

• user：用于内置数据库身份验证和登录的数据库用户
• password：用于内置数据库身份验证和登录的数据库密码。

from langchain_google_cloud_sql_mysql import MySQLEngine

engine = MySQLEngine.from_instance(
    project_id=PROJECT_ID, region=REGION, instance=INSTANCE, database=DATABASE
)

初始化表

通过以下方式初始化 default schema 的表MySQLEngine.init_document_table(<table_name>).表列：

• page_content （类型： text）
• langchain_metadata （类型： JSON）

overwrite_existing=Trueflag 表示新初始化的 table 将替换任何现有的同名 table。

engine.init_document_table(TABLE_NAME, overwrite_existing=True)

保存文档

保存 langchain 文档MySQLDocumentSaver.add_documents(<documents>).初始化MySQLDocumentSaverclass 你需要提供 2 件事：

1. engine- 一个MySQLEngine发动机。
2. table_name- Cloud SQL 数据库中用于存储 langchain 文档的表的名称。

from langchain_core.documents import Document
from langchain_google_cloud_sql_mysql import MySQLDocumentSaver

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

API 参考：文档

加载文档

加载 langchain 文档MySQLLoader.load()或MySQLLoader.lazy_load().lazy_load返回一个生成器，该生成器在迭代期间仅查询 database。初始化MySQLLoader类：

1. engine- 一个MySQLEngine发动机。
2. table_name- Cloud SQL 数据库中用于存储 langchain 文档的表的名称。

from langchain_google_cloud_sql_mysql import MySQLLoader

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

通过查询加载文档

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

from langchain_google_cloud_sql_mysql import MySQLLoader

loader = MySQLLoader(
    engine=engine,
    query=f"select * from `{TABLE_NAME}` where JSON_EXTRACT(langchain_metadata, '$.fruit_id') = 1;",
)
onedoc = loader.load()
onedoc

从 SQL 查询生成的视图可以具有与 default table 不同的架构。在这种情况下，MySQLLoader 的行为与从具有非默认架构的表中加载相同。请参阅使用自定义文档页面内容和元数据加载文档部分。

删除文档

从 MySQL 表中删除 langchain 文档列表MySQLDocumentSaver.delete(<documents>).

对于具有默认架构 （page_content， langchain_metadata） 的表，删除条件为：

一个row如果存在document，以便

• document.page_content等于row[page_content]
• document.metadata等于row[langchain_metadata]

from langchain_google_cloud_sql_mysql import MySQLLoader

loader = MySQLLoader(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"""
            CREATE TABLE IF NOT EXISTS `{TABLE_NAME}`(
                fruit_id INT AUTO_INCREMENT 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 TINYINT(1) NOT NULL
            )
            """
        )
    )
    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()

如果我们仍然加载默认参数为MySQLLoader在此示例表中，page_contentof loaded documents 将是表的第一列，而metadata将由所有其他列的键值对组成。

loader = MySQLLoader(
    engine=engine,
    table_name=TABLE_NAME,
)
loader.load()

我们可以通过设置content_columns和metadata_columns初始化MySQLLoader.

1. content_columns：要写入page_content的文件。
2. metadata_columns：要写入metadata的文件。

例如，此处的content_columns将连接在一起形成一个以空格分隔的字符串，因为page_content加载的文档，以及metadata的加载文档将仅包含metadata_columns.

loader = MySQLLoader(
    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 文档保存到具有自定义元数据字段的表中。我们首先需要通过MySQLEngine.init_document_table()，并指定metadata_columns我们希望它拥有。在此示例中，创建的表将包含表列：

• description （type： text）：用于存储水果描述。
• fruit_name （type text）：用于存储水果名称。
• organic （type tinyint（1））：判断水果是否为有机水果。
• other_metadata （type： JSON）：用于存储水果的其他元数据信息。

我们可以将以下参数与MySQLEngine.init_document_table()要创建表，请执行以下作：

1. table_name：Cloud SQL 数据库中用于存储 langchain 文档的表的名称。
2. metadata_columns：一个sqlalchemy.Column指示我们需要的元数据列列表。
3. content_column：要存储的列的名称page_content的 langchain 文档。违约：page_content.
4. metadata_json_column：用于存储额外metadata的 langchain 文档。违约：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,
)

保存文档MySQLDocumentSaver.add_documents(<documents>).如您在此示例中所示，

• document.page_content将保存到description列。
• document.metadata.fruit_name将保存到fruit_name列。
• document.metadata.organic将保存到organic列。
• document.metadata.fruit_id将保存到other_metadataJSON 格式的列。

test_docs = [
    Document(
        page_content="Granny Smith 150 0.99",
        metadata={"fruit_id": 1, "fruit_name": "Apple", "organic": 1},
    ),
]
saver = MySQLDocumentSaver(
    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())

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

我们还可以通过MySQLDocumentSaver.delete(<documents>).删除条件为：

一个row如果存在document，以便

• document.page_content等于row[page_content]
• 对于每个元数据字段k在document.metadata
  • document.metadata[k]等于row[k]或document.metadata[k]等于row[langchain_metadata][k]
• 中没有额外的元数据字段row但不在document.metadata.

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

相关

• Document loader 概念指南
• Document loader 操作指南