Skip to main content
Open In ColabOpen on GitHub

Google Cloud SQL for MySQL

Cloud SQL is a fully managed relational database service that offers high performance, seamless integration, and impressive scalability. It offers MySQL, PostgreSQL, and SQL Server database engines. Extend your database application to build AI-powered experiences leveraging Cloud SQL's Langchain integrations.

本笔记本介绍如何使用 Cloud SQL for MySQL 配合 MySQLLoader 和 MySQLDocumentSaver 来保存、加载和删除 LangChain 文档。

在 GitHub 上了解更多关于该包的信息。

Open In Colab

开始之前​

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

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

# @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.from_instance() 创建一个 MySQLEngine，您只需提供 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 数据库认证的更多信息，请参阅：

或者，也可以使用用户名和密码进行内置数据库身份验证来访问 Cloud SQL 数据库。只需向MySQLEngine.from_instance()提供可选的user和password参数即可：

  • user : 用于内置数据库认证和登录的数据库用户
  • password : 用于内置数据库认证和登录的数据库密码。
from langchain_google_cloud_sql_mysql import MySQLEngine

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

初始化表格​

通过 MySQLEngine.init_document_table(<table_name>) 初始化默认模式的表。表列：

  • page_content（类型：文本）
  • langchain_metadata（类型：JSON）

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

engine.init_document_table(TABLE_NAME, overwrite_existing=True)

保存文档

使用 MySQLDocumentSaver.add_documents(<documents>) 保存 LangChain 文档。要初始化 MySQLDocumentSaver 类，您需要提供两件事：

  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 参考：文档

加载文档​

使用 MySQLLoader.load() 或 MySQLLoader.lazy_load() 加载 LangChain 文档。lazy_load 返回一个生成器，仅在迭代期间查询数据库。要初始化 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 查询生成的视图可能具有与默认表不同的模式。在这种情况下，MySQLLoader 的行为与从非默认模式的表加载相同。请参阅章节 使用自定义文档页面内容和元数据加载文档。

删除文档​

从 MySQL 表中删除包含 MySQLDocumentSaver.delete(<documents>) 的 LangChain 文档列表。

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

如果列表中存在一个 document，则应删除一个 row，使得

  • 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 的默认参数加载 LangChain 文档，则已加载文档的 page_content 将是表格的第一列，而 metadata 将由所有其他列的键值对组成。

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

我们可以通过在初始化 MySQLLoader 时设置 content_columns 和 metadata_columns 来指定想要加载的内容和元数据。

  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（类型：文本）：用于存储水果描述。
  • fruit_name（类型：文本）：用于存储水果名称。
  • organic (type tinyint(1))：用于标识该水果是否为有机产品。
  • other_metadata（类型：JSON）：用于存储水果的其他元数据信息。

我们可以使用以下参数与 MySQLEngine.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,
)

使用 MySQLDocumentSaver.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 = 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>) 从表中删除带有自定义元数据列的文档。删除条件为：

如果列表中存在一个 document，则应删除一个 row，使得

  • document.page_content 等于 row[page_content]
  • 对于每个元数据字段k in 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())