docs: add async SQLAlchemy + HNSW full example#151
Open
ChunkyTortoise wants to merge 1 commit intopgvector:masterfrom
Open
docs: add async SQLAlchemy + HNSW full example#151ChunkyTortoise wants to merge 1 commit intopgvector:masterfrom
ChunkyTortoise wants to merge 1 commit intopgvector:masterfrom
Conversation
Add a complete working example showing async SQLAlchemy with HNSW indexing and cosine distance queries. The README documents async driver registration and HNSW index creation separately, but lacks a combined example showing the most common production pattern (async engine + HNSW index + cosine nearest-neighbor queries).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README documents async driver registration (Psycopg 3
register_vector_async) and HNSW index creation separately, but there's no combined example showing the end-to-end async pattern that production FastAPI/async Python applications typically use.This adds a complete working example under "Async Full Example" in the SQLAlchemy section showing:
async_sessionmaker)run_sync)vector_cosine_opsMotivation
I use this exact pattern in a production document extraction API (docextract) with 768-dim Gemini embeddings, and had to piece together the async + HNSW workflow from separate README sections and test files. A combined example would have saved significant time.
Test plan
🤖 Generated with Claude Code