Skip to main content

Cloud SQL for MySQL for LangChain

preview pypi versions

Quick Start

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.

  2. Enable billing for your project.

  3. Enable the Google Cloud SQL Admin API.

  4. Setup Authentication.

Supported Cloud SQL Maintenance Versions

This LangChain integration is supported for Cloud SQL maintenance versions MYSQL_8_0_36.R20241208.01_00 or later.

Installation

Install this library in a virtualenv using pip. virtualenv is a tool to create isolated Python environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions.

With virtualenv, it’s possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.

Supported Python Versions

Python >= 3.9

Mac/Linux

pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install langchain-google-cloud-sql-mysql

Windows

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install langchain-google-cloud-sql-mysql

Vector Store Usage

Use a vector store to store embedded data and perform vector search.

from langchain_google_cloud_sql_mysql import MySQLEngine, MySQLVectorStore
from langchain_google_vertexai import VertexAIEmbeddings

engine = MySQLEngine.from_instance("project-id", "region", "my-instance", "my-database")
engine.init_vectorstore_table(
    table_name="my-table-name",
    vector_size=768
)
vectorstore = MySQLVectorStore(
    engine,
    embedding_service=VertexAIEmbeddings(model_name="textembedding-gecko@003"),
    table_name="my-table-name"
)

See the full Vector Store tutorial.

Document Loader Usage

Use a document loader to load data as LangChain Documents.

from langchain_google_cloud_sql_mysql import MySQLEngine, MySQLLoader

engine = MySQLEngine.from_instance("project-id", "region", "my-instance", "my-database")
loader = MySQLLoader(
    engine,
    table_name="my-table-name"
)
docs = loader.lazy_load()

See the full Document Loader tutorial.

Chat Message History Usage

Use ChatMessageHistory to store messages and provide conversation history to LLMs.

from langchain_google_cloud_sql_mysql import MySQLChatMessageHistory, MySQLEngine

engine = MySQLEngine.from_instance("project-id", "region", "my-instance", "my-database")
history = MySQLChatMessageHistory(
    engine,
    table_name="my-message-store",
    session_id="my-session-id"
)

See the full Chat Message History tutorial.

Contributions

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.

License

Apache 2.0 - See LICENSE for more information.

Disclaimer

This is not an officially supported Google product.

Metadata

Release files for langchain-google-cloud-sql-mysql 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for langchain-google-cloud-sql-mysql 1.0.0
File Size Uploaded Provenance Actions
langchain_google_cloud_sql_mysql-1.0.0.tar.gz 27.6 kB With provenance Details for langchain_google_cloud_sql_mysql-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for langchain-google-cloud-sql-mysql 1.0.0
File Interpreter ABI Platform Actions
langchain_google_cloud_sql_mysql-1.0.0-py3-none-any.whl Python 3 none any Details for langchain_google_cloud_sql_mysql-1.0.0-py3-none-any.whl

Total release size: 57.6 kB

Release files / langchain_google_cloud_sql_mysql-1.0.0.tar.gz

Download URL langchain_google_cloud_sql_mysql-1.0.0.tar.gz
Size 27.6 kB
Tags Source
SHA-256 checksum
How to use checksums
bf9cc9d57f6a197af86f40e348a6f1ed5b904b9e71fd799165854238975442ff
BLAKE2b-256 checksum
How to use checksums
ebff29caa17e8f2c8c0183b11a2ea40675c8a2049d609c6765d91f8537c05fb2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.2.0 CPython/3.11.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by Google Cloud, verified by PyPI on Nov 5, 2026.

Transparency log

Release files / langchain_google_cloud_sql_mysql-1.0.0-py3-none-any.whl

Download URL langchain_google_cloud_sql_mysql-1.0.0-py3-none-any.whl
Size 30.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7216a5b31bdba790fe9095039b6b11b20c6d53b435d6c27e79c88bf3fcf5a7fd
BLAKE2b-256 checksum
How to use checksums
f964a615805d99ac6953ecb62b3525702b4da2ec6a2556e78b5ff34b5a34244e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.2.0 CPython/3.11.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by Google Cloud, verified by PyPI on Nov 5, 2026.

Transparency log

Security for langchain-google-cloud-sql-mysql 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for langchain_google_cloud_sql_mysql-1.0.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by Google Cloud, verified by PyPI on Nov 5, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page