Skip to main content
Open In ColabOpen on GitHub

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。

在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 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。
  • 查看支持页面：Locate the project 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配置了一个SQLAlchemy连接池到您的Cloud SQL数据库，使您的应用程序能够成功连接并遵循行业最佳实践。

要使用MSSQLEngine.from_instance()创建MSSQLEngine，你只需要提供4样东西：

  1. project_id : Google Cloud 项目中 Cloud SQL 实例所在的项目 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()初始化一个默认模式的表。表列：

  • 页面内容（类型：文本）
  • langchain_metadata (类型: JSON)

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

engine.init_document_table(TABLE_NAME, overwrite_existing=True)

保存文档​

使用MSSQLDocumentSaver.add_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查询生成的视图可以具有与默认表不同的模式。在这种情况下，MSSQLLoader的行为与从具有非默认模式的表加载的行为相同。请参阅章节使用自定义文档页面内容和元数据加载文档。

删除文档​

使用MSSQLDocumentSaver.delete()从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()保存文档。正如你在这个例子中看到的，

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

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

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

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

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

这个页面有帮助吗？