Skip to main content

PostgreSQL pgvector VectorStore adapter for Astrocyte

Project description

astrocyte-pgvector

PostgreSQL + pgvector implementation of the Astrocyte VectorStore SPI (provider-spi.md).

Install

From the monorepo (with astrocyte available):

cd adapters-py/astrocyte-pgvector
uv sync
# or: pip install -e ../../astrocyte-py && pip install -e .

Entry point name: pgvector (group astrocyte.vector_stores).

PostgreSQL with Docker

Use the combined Compose stack in ../../astrocyte-services-py/docker-compose.yml to run Postgres (pgvector) + the reference REST service together:

cd astrocyte-services-py
docker compose up -d

For Postgres only (no HTTP), start only postgres:

cd astrocyte-services-py
docker compose up -d postgres

Default DSN from your host (port 5433 maps to Postgres in the compose file):

postgresql://astrocyte:astrocyte@127.0.0.1:5433/astrocyte

Schema migrations (production)

DDL is shipped as plain SQL under migrations/ and applied with psql via scripts/migrate.sh (no Python migration framework).

export DATABASE_URL='postgresql://astrocyte:astrocyte@127.0.0.1:5433/astrocyte'
cd adapters-py/astrocyte-pgvector
./scripts/migrate.sh

Requirements: PostgreSQL 15+ (for CREATE INDEX CONCURRENTLY IF NOT EXISTS), psql on PATH.

After migrations are applied, set bootstrap_schema: false in vector_store_config so the app does not run CREATE TABLE / indexes at runtime (see configuration table below). For a single command that starts Postgres, runs migrations, then starts the stack with runbook config, use runbook-up.sh (see Runbook).

Embedding width: migrations/002_astrocyte_vectors.sql defines vector(128). That must match embedding_dimensions in config. For another width, add a new migration (or edit before first deploy) and keep the Python config aligned.

Custom table_name: The shipped SQL targets astrocyte_vectors. If you use another table name, copy and adjust the migration files accordingly.

Configuration

Constructor / YAML vector_store_config Meaning
dsn PostgreSQL connection URI (or set DATABASE_URL / ASTROCYTES_PG_DSN)
table_name Table name (default astrocyte_vectors; alphanumeric + underscore only)
embedding_dimensions Fixed vector(N) width; must match your embedding model and the vector(N) in SQL migrations (default 128)
bootstrap_schema If true (default), create extension / table / btree index on first use (dev-friendly; no HNSW). If false, assume migrate.sh already applied migrations/ (production).

How this fits astrocyte_rest

  1. astrocyte-py defines the VectorStore protocol and discovers adapters by entry point (astrocyte.vector_stores).
  2. astrocyte-pgvector registers pgvectorPgVectorStore. Installing this package makes the name pgvector available to resolve_provider().
  3. astrocyte_rest/wiring.py calls resolve_vector_store(config), which loads the class from the entry point and passes vector_store_config from YAML (or env-only defaults).
  4. astrocyte_rest/brain.py builds Astrocyte + PipelineOrchestrator with that store and your chosen llm_provider (still mock unless you configure a real LLM).

Example ASTROCYTES_CONFIG_PATH snippet:

provider_tier: storage
vector_store: pgvector
llm_provider: mock
vector_store_config:
  dsn: postgresql://astrocyte:astrocyte@127.0.0.1:5433/astrocyte
  embedding_dimensions: 128
  bootstrap_schema: false

Then run the REST service (from repo layout):

export ASTROCYTES_CONFIG_PATH=/path/to/that.yaml
cd astrocyte-services-py/astrocyte-rest && uv run astrocyte-rest

Or set only env (no YAML file):

export ASTROCYTES_VECTOR_STORE=pgvector
export DATABASE_URL=postgresql://astrocyte:astrocyte@127.0.0.1:5433/astrocyte
# embedding_dimensions default 128 — override via YAML if you add a file
cd astrocyte-services-py/astrocyte-rest && uv sync --extra pgvector

Note: vector_store_config for dimensions is only merged from YAML today; for env-only mode, add a small YAML or extend brain.py to pass ASTROCYTES_EMBEDDING_DIMENSIONS (future improvement).

Production notes

  • HNSW parameters (m, ef_construction) live in migrations/003_indexes.sql; tune with DBA guidance as load grows.
  • Embedding dimension must match the LLMProvider.embed() output used by the pipeline.
  • Use secrets for dsn, not committed YAML.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

astrocyte_pgvector-0.7.3.tar.gz (32.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

astrocyte_pgvector-0.7.3-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file astrocyte_pgvector-0.7.3.tar.gz.

File metadata

  • Download URL: astrocyte_pgvector-0.7.3.tar.gz
  • Upload date:
  • Size: 32.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for astrocyte_pgvector-0.7.3.tar.gz
Algorithm Hash digest
SHA256 c2d497e928355404611e52dbff69f9690b3570eca63567b1be54fe5a8fb4f9df
MD5 b02c5e3e2b2c1f62a9d8e692d3820e1e
BLAKE2b-256 959a248c0f54753449267a71d388cf4d2a757fd82d5911f7dbf53272424abfb7

See more details on using hashes here.

File details

Details for the file astrocyte_pgvector-0.7.3-py3-none-any.whl.

File metadata

File hashes

Hashes for astrocyte_pgvector-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 acad0fd0ffeb6805b4865d41963062221485e30f459fc4433186c1b6c54aa017
MD5 89cfa3101e4e5236d4467ee9ec7d52f1
BLAKE2b-256 dc4118853b98be12a443b01c2710a4471245cb0a788915107037a9db64367a69

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page