From 6b31e333bbc1d480abbfb02ebc1608e218566fa0 Mon Sep 17 00:00:00 2001 From: Matthew Momjian <50788000+mmomjian@users.noreply.github.com> Date: Wed, 21 May 2025 12:48:11 -0400 Subject: [PATCH] fix(docs): vchord migration (#18418) * vector * add up top * fix vector * pg version --- .../administration/postgres-standalone.md | 22 ++++++++++++------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/docs/administration/postgres-standalone.md b/docs/docs/administration/postgres-standalone.md index 41743899a7..06a29a12fe 100644 --- a/docs/docs/administration/postgres-standalone.md +++ b/docs/docs/administration/postgres-standalone.md @@ -10,10 +10,14 @@ Running with a pre-existing Postgres server can unlock powerful administrative f ## Prerequisites +You must install `pgvector` (`>= 0.7.0, < 1.0.0`), as it is a prerequisite for `vchord`. +The easiest way to do this on Debian/Ubuntu is by adding the [PostgreSQL Apt repository][pg-apt] and then +running `apt install postgresql-NN-pgvector`, where `NN` is your Postgres version (e.g., `16`). + You must install VectorChord into your instance of Postgres using their [instructions][vchord-install]. After installation, add `shared_preload_libraries = 'vchord.so'` to your `postgresql.conf`. If you already have some `shared_preload_libraries` set, you can separate each extension with a comma. For example, `shared_preload_libraries = 'pg_stat_statements, vchord.so'`. :::note -Immich is known to work with Postgres versions 14, 15, 16 and 17. Earlier versions are unsupported. +Immich is known to work with Postgres versions `>= 14, < 18`. Make sure the installed version of VectorChord is compatible with your version of Immich. The current accepted range for VectorChord is `>= 0.3.0, < 1.0.0`. ::: @@ -73,13 +77,14 @@ Support for pgvecto.rs will be dropped in a later release, hence we recommend al The easiest option is to have both extensions installed during the migration: 1. Ensure you still have pgvecto.rs installed -2. [Install VectorChord][vchord-install] -3. Add `shared_preload_libraries= 'vchord.so, vectors.so'` to your `postgresql.conf`, making sure to include _both_ `vchord.so` and `vectors.so`. You may include other libraries here as well if needed -4. If Immich does not have superuser permissions, run the SQL command `CREATE EXTENSION vchord CASCADE;` using psql or your choice of database client -5. Start Immich and wait for the logs `Reindexed face_index` and `Reindexed clip_index` to be output -6. If Immich does not have superuser permissions, run the SQL command `DROP EXTENSION vectors;` -7. Remove the `vectors.so` entry from the `shared_preload_libraries` setting -8. Uninstall pgvecto.rs (e.g. `apt-get purge vectors-pg14` on Debian-based environments, replacing `pg14` as appropriate) +2. Install `pgvector` (`>= 0.7.0, < 1.0.0`). The easiest way to do this is on Debian/Ubuntu by adding the [PostgreSQL Apt repository][pg-apt] and then running `apt install postgresql-NN-pgvector`, where `NN` is your Postgres version (e.g., `16`) +3. [Install VectorChord][vchord-install] +4. Add `shared_preload_libraries= 'vchord.so, vectors.so'` to your `postgresql.conf`, making sure to include _both_ `vchord.so` and `vectors.so`. You may include other libraries here as well if needed +5. If Immich does not have superuser permissions, run the SQL command `CREATE EXTENSION vchord CASCADE;` using psql or your choice of database client +6. Start Immich and wait for the logs `Reindexed face_index` and `Reindexed clip_index` to be output +7. If Immich does not have superuser permissions, run the SQL command `DROP EXTENSION vectors;` +8. Remove the `vectors.so` entry from the `shared_preload_libraries` setting +9. Uninstall pgvecto.rs (e.g. `apt-get purge vectors-pg14` on Debian-based environments, replacing `pg14` as appropriate). `pgvector` must remain install as it provides the data types used by `vchord` If it is not possible to have both VectorChord and pgvecto.rs installed at the same time, you can perform the migration with more manual steps: @@ -131,3 +136,4 @@ Note that VectorChord itself uses pgvector types, so you should not uninstall pg If you get the error `driverError: error: permission denied for view pg_vector_index_stat`, you can fix this by connecting to the Immich database and running `GRANT SELECT ON TABLE pg_vector_index_stat TO ;`. [vchord-install]: https://docs.vectorchord.ai/vectorchord/getting-started/installation.html +[pg-apt]: https://www.postgresql.org/download/linux/#generic