Component
core/datastore/pgvector
A vector database on the PostgreSQL engine: PostgreSQL with the pgvector extension, which adds a vector column type, distance operators and approximate nearest-neighbour indexes, so embeddings are stored beside ordinary rows and queried by similarity in SQL. The server runs the pgvector project's own image, which carries the extension, and the database the component creates has it enabled. Wire here when an application retrieves by similarity and keeps its vectors in PostgreSQL; core/datastore/postgres is the general-purpose relational store, and core/datastore/qdrant, core/datastore/weaviate and core/datastore/chroma are vector stores with APIs of their own. It presents the standard PostgreSQL wire contract (POSTGRES_USER / POSTGRES_PASSWORD / POSTGRES_DB) and exports its host, port, user, database and protocol, and an endpoint joining them into a connection URI that carries no password, so a socket selecting vector stores admits it and a consumer reaches it with a PostgreSQL client. Realized two ways, both self-hosted and both fetching nothing: reach for the Helm Recipe on Kubernetes, which synthesizes a StatefulSet with a persistent volume, and for the Compose Recipe for local development. Its Recipes are verified by their rendered output, not by a started server storing and querying vectors. RDS for PostgreSQL offers pgvector on PostgreSQL 12-19, but no setting of the database instance enables it in a database, only a CREATE EXTENSION statement, so no RDS Recipe realizes this component. Use core/datastore/postgres on its RDS Recipes, the application running CREATE EXTENSION vector in its database; vector-store sockets do not admit it, as nothing the build sees enables the extension.
Provenance
- Content digest
- sha256:89f7d967c4cd85f0d2580c187330c84d304d1ad806488f725a3b698f21c3fbca
- Published
- 2026-11-10T10:11:02Z
- Signing identity
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Signature
- Officialapplication/vnd.dev.sigstore.bundle.v0.3+json
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
sha256:a37dcb2454ced0e154e7ad4f9950f74284503035f55d397c2dd3cf039c2c4214
Reference at this version
oci://hub.aggrega.ai/component/core/datastore/pgvector:1.0.0Developer parameters
Values the developer sets in the Aggregate.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| database | string | appdb | no | Logical database name created on startup (POSTGRES_DB), with the vector extension enabled in it. |
| user | string | appuser | no | Bootstrap superuser role created on startup (POSTGRES_USER), owner of the initial database. |
| encoding | string | — | no | Database encoding passed to initdb (e.g. UTF8). Omit to use the image default. |
| locale | string | — | no | Database locale passed to initdb (e.g. en_US.utf8). Omit to use the image default. |
| custom_config | string | — | no | Raw server configuration block (postgresql.conf format), applied as the server's configuration file in place of the image's own, so a setting it omits takes the server's built-in default. listen_addresses is the one worth naming: its built-in default accepts local connections only, so a block for a server other workloads reach sets it, for example listen_addresses = '*'. The listen port comes from infra.port; a port setting here takes precedence and moves the server off the port the component publishes. |
Operator sizing
Infrastructure sizing the operator tunes per environment.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| port | integer (min 1024, max 65535) | 5432 | no | Server listen port. Most operators should omit this and let the Recipe assign the default (5432). Every Recipe hands it to the server as its own port, so the server, its health checks and the published address all follow it. |
| engine_version | string | 0.8.7-pg18-trixie | no | Tag of the pgvector/pgvector image the Recipes run. One compound coordinate carries three parts: the extension version, the PostgreSQL major version it is built for, and the Debian release it is built on — so an operator supplies a value shaped like 0.8.7-pg18-trixie rather than a bare major version, for which the image publishes no tag. The build halts on a value naming no PostgreSQL major, or a major below 18, because the Recipes keep the data where the PostgreSQL 18 and later builds place it. |
| compute | object | — | no | — |
| storage | object | — | no | — |
| overrides | object (open) | — | no | Provider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Output contract
Values this component publishes to consumers over the uses topology.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| host | string | — | yes | Address a client opens its database connection to. On Kubernetes it is the Service's DNS name, and on Compose the service name. |
| port | integer | — | yes | TCP port the server accepts connections on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming 5432. |
| user | string | — | no | Name of the login role a consumer authenticates as. The matching password arrives through the credential attached to the component, never through this contract. |
| database | string | — | no | Name of the logical database created at startup, the one the vector extension is enabled in. A consumer names it in its connection string to land in the right database rather than the server's default. |
| protocol | string | — | no | Wire protocol the published address speaks — `postgres`, so a consumer stores and queries vectors with an ordinary PostgreSQL driver. |
| endpoint | string | — | no | Connection URI of the component's database, postgresql://<user>@<host>:<port>/<database>, for a consumer that takes one address rather than its parts. It carries no password, which arrives through the credential attached to the component. The user and the database are written into it as given, so a name holding a character a URI reserves, such as @, : or /, breaks it. |
Uses sockets
The dependency sockets this component connects through. The target of every connection wired through a socket must satisfy its label selector, and each connection may carry an attachment in the slots the socket declares. A required slot is owed by each connection the Aggregate or the Release wires through the socket.
No uses sockets declared.
Attachment slots
Named binding points at which a Feature attaches to this component. A slot's selector constrains which Feature may fill it and its inject list names how the Feature's material may be delivered. A required slot must be bound on every instance, by an attachment on the instance or at a scope above it, and a sensitive slot is declared to handle secret material. A Feature may also attach under a name no slot declares.
| Slot | Selector | Required | Inject | Sensitive | Description |
|---|---|---|---|---|---|
| password | feature.aggrega.ai/kind=secret | no | env | yes | Optional database password credential. When attached, supplies POSTGRES_PASSWORD via the credential subsystem. Unattached, compose/pgvector and helm/pgvector set POSTGRES_PASSWORD to the development literal `apppass`, which this catalog publishes, so every Release that leaves the slot unattached shares that password. |
Self-inject allowlist
env
Relationships
Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.
Uses
This entity uses nothing in the catalog.
Used by
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «backend»
uses socket «cache»
uses socket «queue»
uses socket «knowledge_base»
uses socket «backend»
uses socket «cache»
uses socket «vector_store»
uses socket «backend»
uses socket «cache»
uses socket «vector_store»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «vector_store»
uses socket «backend»
uses socket «cache»
uses socket «vector_store»
uses socket «backend»
uses socket «cache»
uses socket «backend»
uses socket «cache»
uses socket «state_store»
uses socket «vector_store»
uses socket «vector_store»
uses socket «task_memory»
uses socket «document_store»
uses socket «vector_store»
uses socket «vector_store»
uses socket «checkpointer_db»
uses socket «checkpointer_db»
uses socket «backend»
uses socket «backend»
uses socket «backend»
uses socket «vector_store»
uses socket «vector_store»
uses socket «storage»
uses socket «knowledge_base»
uses socket «data_store»
uses socket «metadata_store»
uses socket «target_datastore»
uses socket «target_datastore»
uses socket «target_datastore»
uses socket «backend»
uses socket «databases»
uses socket «etcd»
uses socket «backend»
uses socket «backend»
uses socket «cache»
uses socket «state_store»
uses socket «forward_target»
uses socket «backend»
uses socket «cache»
uses socket «chunk_cache»
uses socket «scrape_target»
uses socket «backend»
uses socket «backend»
uses socket «database»
applies to
applies to
applies to
implements
implements