Skip to main content

astrocyte-postgres

PostgreSQL implementation of the Astrocyte VectorStore and WikiStore SPIs (provider-spi.md). Uses pgvectorscale (DiskANN) for ANN indexing — pgvectorscale CASCADE-installs pgvector, so pgvector's vector type and <=> operator are available too. The shipped Docker image bakes pgvectorscale in; for self-host, use that image, Supabase, Neon, or Timescale Cloud.

Install

From the monorepo (with astrocyte available):

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

Entry point names:

  • postgres (group astrocyte.vector_stores) for raw/compiled memory vectors.
  • postgres (group astrocyte.document_stores) for BM25 keyword retrieval over the same table.
  • postgres (group astrocyte.wiki_stores) for durable wiki pages/revisions/provenance.

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-storage-py/astrocyte-postgres
./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 creates vector(${ASTROCYTE_EMBEDDING_DIMENSIONS:-128}). That must match embedding_dimensions in config. For OpenAI text-embedding-3-small, run migrations with ASTROCYTE_EMBEDDING_DIMENSIONS=1536.

ANN backend (DiskANN via pgvectorscale): vector indexes are created with USING diskann (embedding vector_cosine_ops) WITH (num_neighbors = 50). pgvectorscale CASCADE-installs pgvector, so application code using pgvector's <=> operator works unchanged. Astrocyte standardized on pgvectorscale in 2026-05 — the LongMemEval bench surfaced HNSW per-page write-lock drift (~1.0s → 2.0s/session as the index grew under concurrent retain), and DiskANN's graph layout serializes less aggressively. pgvectorscale is OSS under the PostgreSQL License with no feature gates.

./scripts/migrate.sh

Supported deployment targets: the shipped ghcr.io/astrocyteai/astrocyte-postgres image (bakes pgvectorscale in), Supabase, Neon, Timescale Cloud, or any Postgres with postgresql-16-pgvectorscale from Timescale's apt repo. AWS RDS, GCP Cloud SQL, and Azure Database for PostgreSQL do not ship pgvectorscale and are not supported targets — run the shipped image on ECS / GCE / a VM instead.

The DiskANN index DDL is in migrations/003_indexes.sql and migrations/009_entities_trigram_embedding.sql; the CREATE EXTENSION vectorscale CASCADE lives in migrations/001_extension.sql.

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

The later migrations add the Hindsight-comparable Postgres substrate around vectors: bank metadata and access grants, lifecycle columns (retained_at, forgotten_at), durable wiki pages/revisions/provenance, canonical entity/link tables, and normalized temporal facts.

Configuration

Constructor / YAML vector_store_config Meaning
dsn PostgreSQL connection URI (or set DATABASE_URL / ASTROCYTE_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 DiskANN). If false, assume migrate.sh already applied migrations/ (production).

How this fits astrocyte_gateway

  1. astrocyte-py defines the VectorStore protocol and discovers adapters by entry point (astrocyte.vector_stores).
  2. astrocyte-postgres registers postgres → PostgresStore. Installing this package makes the name postgres available to resolve_provider().
  3. astrocyte_gateway/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_gateway/brain.py builds Astrocyte + PipelineOrchestrator with that store and your chosen llm_provider (still mock unless you configure a real LLM).

Example ASTROCYTE_CONFIG_PATH snippet:

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

Then run the REST service (from repo layout):

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

Or set only env (no YAML file):

export ASTROCYTE_VECTOR_STORE=postgres
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-gateway-py && uv sync --extra postgres

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 ASTROCYTE_EMBEDDING_DIMENSIONS (future improvement).

Production notes

  • DiskANN parameters (num_neighbors) 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.

Metadata

Release files for astrocyte-postgres 0.18.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 astrocyte-postgres 0.18.0
File Size Uploaded Provenance Actions
astrocyte_postgres-0.18.0.tar.gz 139.9 kB Without provenance Details for astrocyte_postgres-0.18.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for astrocyte-postgres 0.18.0
File Interpreter ABI Platform Actions
astrocyte_postgres-0.18.0-py3-none-any.whl Python 3 none any Details for astrocyte_postgres-0.18.0-py3-none-any.whl

Total release size: 193.5 kB

Release files / astrocyte_postgres-0.18.0.tar.gz

Download URL astrocyte_postgres-0.18.0.tar.gz
Size 139.9 kB
Tags Source
SHA-256 checksum
How to use checksums
b625dc98e6244fcaa4759203793477acc36dd486a53d9c1e4951339c23d040f0
BLAKE2b-256 checksum
How to use checksums
2e81471a0f2255a223de855b90523b395c04b4aa359c27b12c1517bc9f1945a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / astrocyte_postgres-0.18.0-py3-none-any.whl

Download URL astrocyte_postgres-0.18.0-py3-none-any.whl
Size 53.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
327cbbb80fb259c413ecb2e41594ee7cced4a35f033f5e8ea03a94c5ae5b2ad7
BLAKE2b-256 checksum
How to use checksums
3df2e0caef73275583f255e55d45dbea0b8c4eb37ff5f1844cb0abd3fe3029bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Security for astrocyte-postgres 0.18.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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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