Google Cloud SQL for SQL server
Cloud SQL 是一个完全托管的关系数据库服务,提供高性能、无缝集成和令人印象深刻的可扩展性。它提供 MySQL、PostgreSQL 和 SQL Server 数据库引擎。扩展您的数据库应用程序,构建利用 Cloud SQL 的 LangChain 集成的 AI 驱动体验。
本笔记本介绍如何使用 Cloud SQL for SQL server 来 保存、加载和删除 langchain 文档,使用 MSSQLLoader
和 MSSQLDocumentSaver
。
在 GitHub 上了解更多关于该包的信息。
开始之前
要运行此笔记本,您需要执行以下操作:
- 创建一个 Google Cloud 项目
- 启用 Cloud SQL 管理 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,请查看 这里 的设置说明。
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 管理 API。
# enable Cloud SQL Admin API
!gcloud services enable sqladmin.googleapis.com
基本用法
MSSQLEngine 连接池
在从 MSSQL 表保存或加载文档之前,我们需要首先配置一个连接池到 Cloud SQL 数据库。MSSQLEngine
配置一个 SQLAlchemy 连接池 到您的 Cloud SQL 数据库,使您的应用程序能够成功连接并遵循行业最佳实践。
要使用 MSSQLEngine.from_instance()
创建一个 MSSQLEngine
,您只需提供 4 个信息:
project_id
: Cloud SQL 实例所在的 Google Cloud 项目的项目 ID。region
: Cloud SQL 实例所在的区域。instance
: Cloud SQL 实例的名称。database
: 要连接的 Cloud SQL 实例上的数据库名称。user
: 用于内置数据库身份验证和登录的数据库用户。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 (类型: 文本)
- langchain_metadata (类型: JSON)
overwrite_existing=True
标志意味着新初始化的表将替换任何同名的现有表。
engine.init_document_table(TABLE_NAME, overwrite_existing=True)
保存文档
使用 MSSQLDocumentSaver.add_documents(<documents>)
保存 LangChain 文档。要初始化 MSSQLDocumentSaver
类,您需要提供两样东西:
engine
-MSSQLEngine
引擎的实例。table_name
- 在 Cloud SQL 数据库中存储 LangChain 文档的表名。
<!--IMPORTS:[{"imported": "Document", "source": "langchain_core.documents", "docs": "https://python.langchain.com/api_reference/core/documents/langchain_core.documents.base.Document.html", "title": "Google Cloud SQL for SQL server"}]-->
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)