Skip to main content

preview pypi versions

The AlloyDB for PostgreSQL for LangChain package provides a first class experience for connecting to AlloyDB instances from the LangChain ecosystem while providing the following benefits:

  • Simplified & Secure Connections: easily and securely create shared connection pools to connect to Google Cloud databases utilizing IAM for authorization and database authentication without needing to manage SSL certificates, configure firewall rules, or enable authorized networks.

  • Improved performance & Simplified management: use a single-table schema can lead to faster query execution, especially for large collections.

  • Improved metadata handling: store metadata in columns instead of JSON, resulting in significant performance improvements.

  • Clear separation: clearly separate table and extension creation, allowing for distinct permissions and streamlined workflows.

  • Better integration with AlloyDB: built-in methods to take advantage of AlloyDB’s advanced indexing and scalability capabilities.

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 AlloyDB API.

  4. Setup Authentication.

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.10

Mac/Linux

pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install langchain-google-alloydb-pg

Windows

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install langchain-google-alloydb-pg

Vector Store Usage

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

from langchain_google_alloydb_pg import AlloyDBEngine, AlloyDBVectorStore
from langchain_google_vertexai import VertexAIEmbeddings


engine = AlloyDBEngine.from_instance("project-id", "region", "my-cluster", "my-instance", "my-database")
embeddings_service = VertexAIEmbeddings(model_name="textembedding-gecko@003")
vectorstore = AlloyDBVectorStore.create_sync(
    engine,
    table_name="my-table",
    embedding_service=embeddings_service
)

Document Loader Usage

Use a document loader to load data as LangChain Documents.

from langchain_google_alloydb_pg import AlloyDBEngine, AlloyDBLoader


engine = AlloyDBEngine.from_instance("project-id", "region", "my-cluster", "my-instance", "my-database")
loader = AlloyDBLoader.create_sync(
    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_alloydb_pg import AlloyDBChatMessageHistory, AlloyDBEngine


engine = AlloyDBEngine.from_instance("project-id", "region", "my-cluster", "my-instance", "my-database")
history = AlloyDBChatMessageHistory.create_sync(
    engine,
    table_name="my-message-store",
    session_id="my-session-id"
)

See the full Chat Message History tutorial.

Langgraph Checkpoint Usage

Use AlloyDBSaver to save snapshots of the graph state at a given point in time.

from langchain_google_alloydb_pg import AlloyDBSaver, AlloyDBEngine


engine = AlloyDBEngine.from_instance("project-id", "region", "my-cluster", "my-instance", "my-database")
checkpoint = AlloyDBSaver.create_sync(engine)

See the full Checkpoint tutorial.

Example Usage

Code examples can be found in the samples/ folder.

Converting between Sync & Async Usage

Async functionality improves the speed and efficiency of database connections through concurrency, which is key for providing enterprise quality performance and scaling in GenAI applications. This package uses a native async Postgres driver, asyncpg, to optimize Python’s async functionality.

LangChain supports async programming, since LLM based application utilize many I/O-bound operations, such as making API calls to language models, databases, or other services. All components should provide both async and sync versions of all methods.

asyncio is a Python library used for concurrent programming and is used as the foundation for multiple Python asynchronous frameworks. asyncio uses async / await syntax to achieve concurrency for non-blocking I/O-bound tasks using one thread with cooperative multitasking instead of multi-threading.

Converting Sync to Async

Update sync methods to await async methods

engine = await AlloyDBEngine.afrom_instance("project-id", "region", "my-cluster", "my-instance", "my-database")
await engine.ainit_vectorstore_table(table_name="my-table", vector_size=768)
vectorstore = await AlloyDBVectorStore.create(
   engine,
   table_name="my-table",
   embedding_service=VertexAIEmbeddings(model_name="textembedding-gecko@003")
)

Run the code: notebooks

ipython and jupyter notebooks support the use of the await keyword without any additional setup

Run the code: FastAPI

Update routes to use async def.

@app.get("/invoke/")
async def invoke(query: str):
   return await retriever.ainvoke(query)

Run the code: Local python file

It is recommend to create a top-level async method definition: async def to wrap multiple async methods. Then use asyncio.run() to run the the top-level entrypoint, e.g. “main()”

async def main():
   response = await retriever.ainvoke(query)
   print(response)

asyncio.run(main())

Contributions

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING and DEVELOPER 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-alloydb-pg 0.15.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-alloydb-pg 0.15.0
File Size Uploaded
langchain_google_alloydb_pg-0.15.0.tar.gz 76.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for langchain-google-alloydb-pg 0.15.0
File Interpreter ABI Platform
langchain_google_alloydb_pg-0.15.0-py3-none-any.whl Python 3 none any Details

Total release size: 126.7 kB

Release files / langchain_google_alloydb_pg-0.15.0.tar.gz

Download URL langchain_google_alloydb_pg-0.15.0.tar.gz
Size 76.1 kB
Tags Source
SHA-256 checksum
How to use checksums
db9ca7e54d0520c1758e4a14102a5da604fe754488920043058cace2708d852e
BLAKE2b-256 checksum
How to use checksums
ad997648be082a184790c682d53bb83086a32c834608dab4e991759d69a94748
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 May 28, 2026.

Transparency log

Release files / langchain_google_alloydb_pg-0.15.0-py3-none-any.whl

Download URL langchain_google_alloydb_pg-0.15.0-py3-none-any.whl
Size 50.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cbb467245e4836c1330a7fb3efc7048cce24cbfce379a57a627a39d1064ed540
BLAKE2b-256 checksum
How to use checksums
a05d7230388a6ffc788c6018ff487e09ec50bddace099a2fec2926a39c5cb8ba
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 May 28, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.15.0 This release

2 release files

0.14.0

2 release files

0.13.0

2 release files

0.11.0

1 release file

0.10.0

1 release file

0.9.3

1 release file

0.9.2

1 release file

0.9.1

1 release file

0.9.0

1 release file

0.8.0

1 release file

0.7.0

1 release file

0.6.0

1 release file

0.5.0

1 release file

0.4.1

1 release file

0.4.0

1 release file

0.3.0

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.0

1 release file

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