feat: integrate vectorchord for migration

BREAKING CHANGE: adds new extension vchord

Author: muhlba91

.github/workflows/release.yml

@@ -63,9 +63,9 @@ jobs:
           POSTGRESQL_IMAGE=$(cat Dockerfile | grep 'FROM ghcr.io/cloudnative-pg/postgresql:')
           POSTGRESQL_FROM_TAG=$(echo $POSTGRESQL_IMAGE | cut -d':' -f2 | cut -d'@' -f1)
           echo "postgresql=${POSTGRESQL_FROM_TAG}" >> "$GITHUB_OUTPUT"
-          PGVECTO_IMAGE=$(cat Dockerfile | grep 'FROM tensorchord/pgvecto-rs-binary:')
-          PGVECTO_FROM_TAG=$(echo $PGVECTO_IMAGE | cut -d'-' -f4)
-          echo "pgvecto=${PGVECTO_FROM_TAG}" >> "$GITHUB_OUTPUT"
+          VECTORCHORD_IMAGE=$(cat Dockerfile | grep 'FROM tensorchord/vchord-binary:')
+          VECTORCHORD_FROM_TAG=$(echo $VECTORCHORD_IMAGE | cut -d'-' -f4)
+          echo "vchord=${VECTORCHORD_FROM_TAG}" >> "$GITHUB_OUTPUT"
 
       - uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
         with:
@@ -75,10 +75,10 @@ jobs:
           tags: |
             ghcr.io/muhlba91/postgresql-pgvecto:latest
             ghcr.io/muhlba91/postgresql-pgvecto:${{ github.sha }}
-            ghcr.io/muhlba91/postgresql-pgvecto:${{ steps.from_tag.outputs.postgresql }}-${{ steps.from_tag.outputs.pgvecto }}
-            ghcr.io/muhlba91/postgresql-pgvecto:${{ steps.from_tag.outputs.postgresql }}-${{ steps.from_tag.outputs.pgvecto }}-${{ needs.release.outputs.tag_name }}
+            ghcr.io/muhlba91/postgresql-pgvecto:${{ steps.from_tag.outputs.postgresql }}-${{ steps.from_tag.outputs.vchord }}
+            ghcr.io/muhlba91/postgresql-pgvecto:${{ steps.from_tag.outputs.postgresql }}-${{ steps.from_tag.outputs.vchord }}-${{ needs.release.outputs.tag_name }}
           build-args: |
             CI_COMMIT_TIMESTAMP=${{ github.event.repository.updated_at }}
             CI_COMMIT_SHA=${{ github.sha }}
-            CI_COMMIT_TAG=${{ steps.from_tag.outputs.postgresql }}-${{ steps.from_tag.outputs.pgvecto }}-${{ needs.release.outputs.tag_name }}
-            CI_UPSTREAM_VERSION=${{ steps.from_tag.outputs.postgresql }}-${{ steps.from_tag.outputs.pgvecto }}
+            CI_COMMIT_TAG=${{ steps.from_tag.outputs.postgresql }}-${{ steps.from_tag.outputs.vchord }}-${{ needs.release.outputs.tag_name }}
+            CI_UPSTREAM_VERSION=${{ steps.from_tag.outputs.postgresql }}-${{ steps.from_tag.outputs.vchord }}

.github/workflows/verify.yml

@@ -69,9 +69,9 @@ jobs:
           POSTGRESQL_IMAGE=$(cat Dockerfile | grep 'FROM ghcr.io/cloudnative-pg/postgresql:')
           POSTGRESQL_FROM_TAG=$(echo $POSTGRESQL_IMAGE | cut -d':' -f2 | cut -d'@' -f1)
           echo "postgresql=${POSTGRESQL_FROM_TAG}" >> "$GITHUB_OUTPUT"
-          PGVECTO_IMAGE=$(cat Dockerfile | grep 'FROM tensorchord/pgvecto-rs-binary:')
-          PGVECTO_FROM_TAG=$(echo $PGVECTO_IMAGE | cut -d'-' -f4)
-          echo "pgvecto=${PGVECTO_FROM_TAG}" >> "$GITHUB_OUTPUT"
+          VECTORCHORD_IMAGE=$(cat Dockerfile | grep 'FROM tensorchord/vchord-binary:')
+          VECTORCHORD_FROM_TAG=$(echo $VECTORCHORD_IMAGE | cut -d'-' -f4)
+          echo "vchord=${VECTORCHORD_FROM_TAG}" >> "$GITHUB_OUTPUT"
 
       - uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
         with:
@@ -85,4 +85,4 @@ jobs:
             CI_COMMIT_TIMESTAMP=${{ github.event.repository.updated_at }}
             CI_COMMIT_SHA=${{ github.sha }}
             CI_COMMIT_TAG=latest
-            CI_UPSTREAM_VERSION=${{ steps.from_tag.outputs.postgresql }}-${{ steps.from_tag.outputs.pgvecto }}
+            CI_UPSTREAM_VERSION=${{ steps.from_tag.outputs.postgresql }}-${{ steps.from_tag.outputs.vchord }}

Dockerfile

@@ -4,7 +4,10 @@ ARG CI_COMMIT_TAG
 ARG CI_UPSTREAM_VERSION
 
 # pgvecto.rs binary container
-FROM tensorchord/pgvecto-rs-binary:pg16-v0.3.0-${TARGETARCH} as binary
+FROM tensorchord/pgvecto-rs-binary:pg16-v0.3.0-${TARGETARCH} as pgvectors
+
+# vchord binary container
+FROM tensorchord/vchord-binary:pg16-v0.4.3-${TARGETARCH} as vchord
 
 # main container
 FROM ghcr.io/cloudnative-pg/postgresql:16.8-14@sha256:ed9bd4a26b152cf35f2c64e15f48126e3477ad222cfb04794562bdc999b8f0be
@@ -13,16 +16,24 @@ LABEL org.opencontainers.image.authors="Daniel Muehlbachler-Pietrzykowski <danie
 LABEL org.opencontainers.image.vendor="Daniel Muehlbachler-Pietrzykowski"
 LABEL org.opencontainers.image.source="https://github.com/muhlba91/postgresql-pgvecto-container"
 LABEL org.opencontainers.image.created="${CI_COMMIT_TIMESTAMP}"
-LABEL org.opencontainers.image.title="postgresql-pgvecto"
-LABEL org.opencontainers.image.description="A container integrating pgvecto.rs into CloudNativePG PostgreSQL"
+LABEL org.opencontainers.image.title="cloudnativepg-postgresql-vchord"
+LABEL org.opencontainers.image.description="A container integrating VectorChord into CloudNativePG PostgreSQL"
 LABEL org.opencontainers.image.revision="${CI_COMMIT_SHA}"
 LABEL org.opencontainers.image.version="${CI_COMMIT_TAG}"
 LABEL org.opencontainers.image.upstream="${CI_UPSTREAM_VERSION}"
 
+# use root to install binaries
 USER root
+
 # taken from https://github.com/tensorchord/pgvecto.rs/
-COPY --from=binary /pgvecto-rs-binary-release.deb /tmp/vectors.deb
+COPY --from=pgvectors /pgvecto-rs-binary-release.deb /tmp/vectors.deb
 RUN apt-get install --yes --no-install-recommends /tmp/vectors.deb && rm -f /tmp/vectors.deb
+
+# taken from https://github.com/tensorchord/VectorChord/
+COPY --from=vchord /workspace/postgresql-*.deb /tmp/vchord.deb
+RUN apt-get install --yes --no-install-recommends /tmp/vchord.deb && rm -f /tmp/vchord.deb
+
+# set user back to postgres
 USER 26
 
-CMD ["postgres", "-c" ,"shared_preload_libraries=vectors.so", "-c", "search_path=\"$user\", public, vectors", "-c", "logging_collector=on"]
+CMD ["postgres", "-c" ,"shared_preload_libraries=vchord.so,vectors.so", "-c", "search_path=\"$user\", public, vectors", "-c", "logging_collector=on"]

README.md

@@ -1,4 +1,4 @@
-# PostgreSQL with pgvecto.rs Container
+# PostgreSQL with VectorChord Container
 
 [![](https://img.shields.io/github/license/muhlba91/postgresql-pgvecto-container?style=for-the-badge)](LICENSE)
 [![](https://img.shields.io/github/actions/workflow/status/muhlba91/postgresql-pgvecto-container/release.yml?style=for-the-badge)](https://github.com/muhlba91/postgresql-pgvecto-container/actions/workflows/release.yml)
@@ -7,7 +7,7 @@
 [![](https://img.shields.io/github/release-date/muhlba91/postgresql-pgvecto-container?style=for-the-badge)](https://github.com/muhlba91/postgresql-pgvecto-container/releases)
 <a href="https://www.buymeacoffee.com/muhlba91" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="28" width="150"></a>
 
-A container integrating [pgvecto.rs](https://github.com/tensorchord/pgvecto.rs) into [CloudNativePG's PostgreSQL container](https://github.com/cloudnative-pg/postgres-containers).
+A container integrating [VectorChord](https://github.com/tensorchord/VectorChord) into [CloudNativePG's PostgreSQL container](https://github.com/cloudnative-pg/postgres-containers).
 
 ---
 
@@ -16,6 +16,11 @@ A container integrating [pgvecto.rs](https://github.com/tensorchord/pgvecto.rs)
 >
 > The chosen upstream versions follow the [Immich requirements](https://github.com/immich-app/immich/blob/main/docker/docker-compose.yml).
 
+> [!WARNING]
+> **This container is being migrated from pgvecto.rs to VectorChord!**
+>
+> Immich is migrating to VectorChord and, hence, this container will transition to only including VectorChord in upcoming releases.
+
 ---
 
 ## Installation Notes
@@ -27,10 +32,10 @@ Instead of using the upstream [CloudNativePG container](https://github.com/cloud
 The container images are tagged according to CloudNativePG's [image tag requirements](https://cloudnative-pg.io/documentation/1.23/container_images/#image-tag-requirements_1).
 Additionally, `latest` and `<GIT_COMMIT_SHA>` tags are created which are **not** compatible with CloudNativePG!
 
-The tagging scheme is `<CLOUDNATIVEPG_POSTGRESQL_TAG>-<PGVECTO_TAG>[-<RELEASE_TAG>]` with:
+The tagging scheme is `<CLOUDNATIVEPG_POSTGRESQL_TAG>-<VECTORCHORD_TAG>[-<RELEASE_TAG>]` with:
 
 - `<CLOUDNATIVEPG_POSTGRESQL_TAG>`: the upstream [CloudNativePG container](https://github.com/cloudnative-pg/postgres-containers/pkgs/container/postgresql) version
-- `<PGVECTO_TAG>`: the [pgvecto.rs](https://github.com/tensorchord/pgvecto.rs/releases) version
+- `<VECTORCHORD_TAG>`: the [VectorChord](https://github.com/tensorchord/VectorChord/releases) version
 - `<RELEASE_TAG>`: the release version of this container (used to version internal changes; optional to specify)
 
 ---