Vector store integration for Azure Database for PostgreSQL, including Entra ID authentication and index configuration helpers.
This page contains reference documentation for Azure Database for PostgreSQL. See the docs for conceptual guides, tutorials, and examples.
LangChain VectorStore backed by Azure Database for PostgreSQL (sync).
The store validates or creates the backing table on initialization, and optionally discovers an existing vector index configurati
A single filter condition.
column is never inserted into the query as raw SQL when it is a
str: it names either a JSONB key (when the store's metadata_columns
is a string) or one of the c
LangChain VectorStore backed by Azure Database for PostgreSQL (async).
The store validates or creates the backing table on initialization, and optionally discovers an existing vector index configurat
Base connection information for Azure Database for PostgreSQL connections.
:param host: Hostname of the Azure Database for PostgreSQL server. :type host: str | None :param dbname: Name of the databas
Connection pool for Azure Database for PostgreSQL connections.
SSL mode for Azure Database for PostgreSQL connections.
Basic username/password authentication for Azure Database for PostgreSQL connections.
:param username: Username for the connection. :type username: str :param password: Password for the connection. :
Base connection information for Azure Database for PostgreSQL connections.
:param application_name: Name of the application connecting to the database. :type application_name: str :param host: Hostna
Enumeration for operator classes used in vector indexes.
Enumeration for vector types used in vector similarity search.
Base class for vector index algorithms and their settings.
Subclasses provide index build-time settings via :meth:build_settings and
the default search-time settings via :meth:`default_search_param
Base model for vector index search parameters.
Subclasses must implement :meth:search_settings to expose the parameters
with the proper prefix expected by the underlying index implementation.
Enumeration for DiskANN iterative scan modes.
Search-time parameters for DiskANN indexes.
All settings are exported with the diskann. prefix when used in SQL.
:param l_value_is: The value of the L parameter for DiskANN index searching. :typ
DiskANN algorithm settings.
Provides build-time and (via :class:DiskANNSearchParams) search-time
parameters for DiskANN vector indexes.
:param max_neighbors: The maximum number of edges per node i
Enumeration for HNSW iterative scan modes.
Search-time parameters for HNSW indexes.
All settings are exported with the hnsw. prefix when used in SQL.
:param ef_search: Size of the dynamic candidate list for HNSW index searching. :type ef
HNSW algorithm settings.
Provides build-time and (via :class:HNSWSearchParams) search-time
parameters for HNSW vector indexes.
:param m: The maximum number of connections per layer for HNSW index
Enumeration for IVFFlat iterative scan modes.
Search-time parameters for IVF-Flat indexes.
All settings are exported with the ivfflat. prefix when used in SQL.
:param probes: The number of probes to use during IVF-Flat index searching. :typ
IVF-Flat algorithm settings.
Provides build-time and (via :class:IVFFlatSearchParams) search-time
parameters for IVF-Flat vector indexes.
:param lists: The number of inverted lists to use for IVF-
Model representing a PostgreSQL extension.
:param ext_name: Name of the extension to be created, checked or dropped. :type ext_name: str :param ext_version: Optional version of the extension to be cr
Base connection information for Azure Database for PostgreSQL connections.
:param host: Hostname of the Azure Database for PostgreSQL server. :type host: str | None :param dbname: Name of the databas
Async connection pool for Azure Database for PostgreSQL connections.
Check if the connection to Azure Database for PostgreSQL is valid and required extensions are installed.
:param conn: Connection to the Azure Database for PostgreSQL. :type conn: Connection :param re
Create required extensions in the Azure Database for PostgreSQL connection.
:param conn: Connection to the Azure Database for PostgreSQL. :type conn: Connection :param required_extensions: List of re
Get username and password from credentials.
:param credentials: BasicAuth for username/password or AccessToken for JWT token. :type credentials: BasicAuth | AccessToken :raises ValueError: User name
Check if the connection to Azure Database for PostgreSQL is valid and required extensions are installed.
:param conn: Async connection to the Azure Database for PostgreSQL. :type conn: AsyncConnectio
Create required extensions in the Azure Database for PostgreSQL connection.
:param conn: Async connection to the Azure Database for PostgreSQL. :type conn: AsyncConnection :param required_extensions:
