> ## Documentation Index
> Fetch the complete documentation index at: https://langchain-docs-zh.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Google Cloud SQL for MySQL 集成

> 使用 LangChain 与 Google Cloud SQL for MySQL 向量存储集成。

> [Cloud SQL](https://cloud.google.com/sql) 是一个完全托管的关系型数据库服务，提供高性能、无缝集成和显著的扩展性。它支持 PostgreSQL、MySQL 和 SQL Server 数据库引擎。利用 Cloud SQL 的 LangChain 集成扩展您的数据库应用以构建 AI 驱动的体验。

此笔记本将介绍如何使用 `Cloud SQL for MySQL` 通过 `MySQLVectorStore` 类存储向量嵌入。

更多关于此包的信息请参考 [GitHub](https://github.com/googleapis/langchain-google-cloud-sql-mysql-python/)。

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/googleapis/langchain-google-cloud-sql-mysql-python/blob/main/docs/vector_store.ipynb)

## 开始前

运行此笔记本前需要完成以下步骤：

* [创建 Google Cloud 项目](https://developers.google.com/workspace/guides/create-project)
* [启用 Cloud SQL 管理 API.](https://console.cloud.google.com/flows/enableapi?apiid=sqladmin.googleapis.com)
* [创建 Cloud SQL 实例.](https://cloud.google.com/sql/docs/mysql/connect-instance-auth-proxy#create-instance)（版本必须为 **8.0.36** 或更高，且需配置 **cloudsql\_vector** 数据库标志为 "On"）
* [创建 Cloud SQL 数据库.](https://cloud.google.com/sql/docs/mysql/create-manage-databases)
* [为数据库添加用户.](https://cloud.google.com/sql/docs/mysql/create-manage-users)

### 🦜🔗 Library installation

安装集成库 `langchain-google-cloud-sql-mysql` 和嵌入服务库 `langchain-google-vertexai`。

```python theme={null}
pip install -qU langchain-google-cloud-sql-mysql langchain-google-vertexai
```

**Colab 仅用：** 解除以下单元格注释以重启内核或使用重启按钮。对于 Gemini 企业代理平台工作台，可通过顶部按钮重启终端。

```python theme={null}
# # 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)
```

### 🔐 Authentication

使用当前笔记本中已登录的 IAM 用户身份对 Google Cloud 进行身份验证以访问您的项目。

* 若使用 Colab 运行笔记本，请使用下方单元格并继续。
* 若使用 Gemini 企业代理平台工作台，请参考 [Gemini 企业代理平台工作台设置指南](https://github.com/GoogleCloudPlatform/generative-ai/tree/main/setup-env)。

```python theme={null}
from google.colab import auth

auth.authenticate_user()
```

### ☁ 设置 Google 云项目

将此笔记本的 Google Cloud 项目设置为可访问云资源。

若不知道项目 ID，请执行以下操作：

* 运行 `gcloud config list`。
* 运行 `gcloud projects list`。
* 查看支持页面：[查找项目 ID](https://support.google.com/googleapi/answer/7014113)。

```python theme={null}
# @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}
```

## 基本用法

### 设置云 SQL 数据库值

在 [Cloud SQL 实例页面](https://console.cloud.google.com/sql?_ga=2.223735448.2062268965.1707700487-2088871159.1707257687) 中查找数据库值。

**注意：** 仅 MySQL 实例版本 **8.0.36** 或更高支持向量功能。

对于现有实例，可能需要执行 [自助维护更新](https://cloud.google.com/sql/docs/mysql/self-service-maintenance) 以更新维护版本至 **MYSQL\_8\_0\_36.R20240401.03\_00** 或更高。更新后，需 [配置数据库标志](https://cloud.google.com/sql/docs/mysql/flags) 将 **cloudsql\_vector** 标志设为 "On"。

```python theme={null}
# @title Set Your Values Here { display-mode: "form" }
REGION = "us-central1"  # @param {type: "string"}
INSTANCE = "my-mysql-instance"  # @param {type: "string"}
DATABASE = "my-database"  # @param {type: "string"}
TABLE_NAME = "vector_store"  # @param {type: "string"}
```

### MySQLEngine 连接池

在将 Cloud SQL 配置为向量存储时，需要 `MySQLEngine` 对象。 `MySQLEngine` 用于配置连接池以支持应用程序连接并遵循最佳实践。

使用 `MySQLEngine.from_instance()` 创建 `MySQLEngine` 需提供以下四项信息：

1. `project_id` : Google Cloud 项目 ID（Cloud SQL 实例所在项目）
2. `region` : Cloud SQL 实例所在区域
3. `instance` : Cloud SQL 实例名称
4. `database` : 要连接的 Cloud SQL 数据库名称

默认使用 [IAM 数据库身份验证](https://cloud.google.com/sql/docs/mysql/iam-authentication#iam-db-auth) 作为认证方式。本库使用来自环境的 [应用默认凭据 (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials) 的 IAM 主体的身份。

更多 IAM 数据库身份验证信息请参考：

* [为实例配置 IAM 数据库身份验证](https://cloud.google.com/sql/docs/mysql/create-edit-iam-instances)
* [使用 IAM 数据库身份验证管理用户](https://cloud.google.com/sql/docs/mysql/add-manage-iam-users)

也可选择 [内置数据库身份验证](https://cloud.google.com/sql/docs/mysql/built-in-authentication)（使用用户名/密码访问 Cloud SQL）。只需提供可选 `user` 和 `password` 参数给 `MySQLEngine.from_instance()`：

* `user` : 用于内置认证的数据库用户名
* `password` : 用于内置认证的数据库密码

```python theme={null}
from langchain_google_cloud_sql_mysql import MySQLEngine

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

### 初始化表

`MySQLVectorStore` 类需要数据库表。`MySQLEngine` 类提供 `init_vectorstore_table()` 方法可创建符合要求的表结构。

```python theme={null}
engine.init_vectorstore_table(
    table_name=TABLE_NAME,
    vector_size=768,  # Vector size for Gemini Enterprise Agent Platform model (textembedding-gecko@latest)
)
```

### 创建嵌入类实例

您可以使用任何 [LangChain 嵌入模型](https://langchain-docs-zh.mintlify.site/langchain/oss/python/integrations/embeddings.md)。\
若需使用 `VertexAIEmbeddings`，需启用 Gemini 企业代理平台 API。

建议在生产环境中固定嵌入模型版本，更多详情请参考 [文本嵌入模型](https://docs.cloud.google.com/gemini-enterprise-agent-platform/reference/models/text-embeddings-api)。

```python theme={null}
# enable Gemini Enterprise Agent Platform API
!gcloud services enable aiplatform.googleapis.com
```

```python theme={null}
from langchain_google_vertexai import VertexAIEmbeddings

embedding = VertexAIEmbeddings(
    model_name="textembedding-gecko@latest", project=PROJECT_ID
)
```

### 初始化默认 MySQLVectorStore

创建 `MySQLVectorStore` 类实例需提供以下三项：

1. `engine` : `MySQLEngine` 引擎实例
2. `embedding_service` : LangChain 嵌入模型实例
3. `table_name` : 要作为向量存储的 Cloud SQL 数据库表名

```python theme={null}
from langchain_google_cloud_sql_mysql import MySQLVectorStore

store = MySQLVectorStore(
    engine=engine,
    embedding_service=embedding,
    table_name=TABLE_NAME,
)
```

### 添加文本

```python theme={null}
import uuid

all_texts = ["Apples and oranges", "Cars and airplanes", "Pineapple", "Train", "Banana"]
metadatas = [{"len": len(t)} for t in all_texts]
ids = [str(uuid.uuid4()) for _ in all_texts]

store.add_texts(all_texts, metadatas=metadatas, ids=ids)
```

### 删除文本

通过 ID 删除向量存储中的向量。

```python theme={null}
store.delete([ids[1]])
```

### 搜索文档

```python theme={null}
query = "I'd like a fruit."
docs = store.similarity_search(query)
print(docs[0].page_content)
```

```text theme={null}
Pineapple
```

### 搜索文档（基于向量）

可通过 `similarity_search_by_vector` 接受嵌入向量参数进行文档相似度搜索。

```python theme={null}
query_vector = embedding.embed_query(query)
docs = store.similarity_search_by_vector(query_vector, k=2)
print(docs)
```

```python theme={null}
[Document(page_content='Pineapple', metadata={'len': 9}), Document(page_content='Banana', metadata={'len': 6})]
```

### 添加索引

通过应用向量索引加速搜索查询。更多详情请参考 [MySQL 向量索引](https://github.com/googleapis/langchain-google-cloud-sql-mysql-python/blob/main/src/langchain_google_cloud_sql_mysql/indexes.py)。

**注意：** 对于 IAM 数据库身份验证（默认使用），需由特权数据库用户为 IAM 用户授予以下权限以实现向量索引完整控制：

```
GRANT EXECUTE ON PROCEDURE mysql.create_vector_index TO '<IAM_DB_USER>'@'%';
GRANT EXECUTE ON PROCEDURE mysql.alter_vector_index TO '<IAM_DB_USER>'@'%';
GRANT EXECUTE ON PROCEDURE mysql.drop_vector_index TO '<IAM_DB_USER>'@'%';
GRANT SELECT ON mysql.vector_indexes TO '<IAM_DB_USER>'@'%';
```

```python theme={null}
from langchain_google_cloud_sql_mysql import VectorIndex

store.apply_vector_index(VectorIndex())
```

### 移除索引

```python theme={null}
store.drop_vector_index()
```

## 高级用法

### 使用自定义元数据的 MySQLVectorStore

向量存储可利用关系数据对相似度搜索进行过滤。

创建包含自定义元数据列的表和 `MySQLVectorStore` 实例。

```python theme={null}
from langchain_google_cloud_sql_mysql import Column

# set table name
CUSTOM_TABLE_NAME = "vector_store_custom"

engine.init_vectorstore_table(
    table_name=CUSTOM_TABLE_NAME,
    vector_size=768,  # Gemini Enterprise Agent Platform model: textembedding-gecko@latest
    metadata_columns=[Column("len", "INTEGER")],
)


# initialize MySQLVectorStore with custom metadata columns
custom_store = MySQLVectorStore(
    engine=engine,
    embedding_service=embedding,
    table_name=CUSTOM_TABLE_NAME,
    metadata_columns=["len"],
    # connect to an existing VectorStore by customizing the table schema:
    # id_column="uuid",
    # content_column="documents",
    # embedding_column="vectors",
)
```

### 带元数据过滤的文档搜索

在处理文档前可先通过元数据缩小范围。

例如，使用 `filter` 参数对文档进行过滤。

```python theme={null}
import uuid

# add texts to the vector store
all_texts = ["Apples and oranges", "Cars and airplanes", "Pineapple", "Train", "Banana"]
metadatas = [{"len": len(t)} for t in all_texts]
ids = [str(uuid.uuid4()) for _ in all_texts]
custom_store.add_texts(all_texts, metadatas=metadatas, ids=ids)

# use filter on search
query_vector = embedding.embed_query("I'd like a fruit.")
docs = custom_store.similarity_search_by_vector(query_vector, filter="len >= 6")

print(docs)
```

```python theme={null}
[Document(page_content='Pineapple', metadata={'len': 9}), Document(page_content='Banana', metadata={'len': 6}), Document(page_content='Apples and oranges', metadata={'len': 18}), Document(page_content='Cars and airplanes', metadata={'len': 18})]
```

***

> 官方原文：[src/oss/python/integrations/vectorstores/google\_cloud\_sql\_mysql.mdx](https://github.com/langchain-ai/docs/blob/main/src/oss/python/integrations/vectorstores/google_cloud_sql_mysql.mdx) · 非官方翻译，译文由 AI 生成，以英文原文为准。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.