Improved code

.github/workflows/build.yml

@@ -73,7 +73,6 @@ jobs:
           postgres-version: 14
       - run: |
           call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvars64.bat" && ^
-          cd %TEMP% && ^
           nmake /NOLOGO /F Makefile.win && ^
           nmake /NOLOGO /F Makefile.win install && ^
           nmake /NOLOGO /F Makefile.win installcheck && ^

CHANGELOG.md

@@ -1,10 +1,6 @@
-## 0.7.0 (unreleased)
-
-- Added concatenate operator for vectors
-
 ## 0.6.2 (unreleased)
 
-- Reduced lock contention with parallel HNSW index builds
+- Improved performance of parallel HNSW index builds
 
 ## 0.6.1 (2024-03-04)
 

README.md

@@ -26,7 +26,7 @@ make
 make install # may need sudo
 ```
 
-See the [installation notes](#installation-notes---linux-and-mac) if you run into issues
+See the [installation notes](#installation-notes) if you run into issues
 
 You can also install it with [Docker](#docker), [Homebrew](#homebrew), [PGXN](#pgxn), [APT](#apt), [Yum](#yum), [pkg](#pkg), or [conda-forge](#conda-forge), and it comes preinstalled with [Postgres.app](#postgresapp) and many [hosted providers](#hosted-postgres). There are also instructions for [GitHub Actions](https://github.com/pgvector/setup-pgvector).
 
@@ -44,15 +44,12 @@ Then use `nmake` to build:
 
 ```cmd
 set "PGROOT=C:\Program Files\PostgreSQL\16"
-cd %TEMP%
 git clone --branch v0.6.1 https://github.com/pgvector/pgvector.git
 cd pgvector
 nmake /F Makefile.win
 nmake /F Makefile.win install
 ```
 
-See the [installation notes](#installation-notes---windows) if you run into issues
-
 You can also install it with [Docker](#docker) or [conda-forge](#conda-forge).
 
 ## Getting Started
@@ -413,39 +410,13 @@ You can use [Reciprocal Rank Fusion](https://github.com/pgvector/pgvector-python
 
 ## Performance
 
-### Tuning
-
-Use a tool like [PgTune](https://pgtune.leopard.in.ua/) to set initial values for Postgres server parameters.
-
-### Loading
-
-Use `COPY` for bulk loading data ([example](https://github.com/pgvector/pgvector-python/blob/master/examples/bulk_loading.py)).
-
-```sql
-COPY items (embedding) FROM STDIN WITH (FORMAT BINARY);
-```
-
-Add any indexes *after* loading the initial data for best performance.
-
-### Indexing
-
-See index build time for [HNSW](#index-build-time) and [IVFFlat](#index-build-time-1).
-
-In production environments, create indexes concurrently to avoid blocking writes.
-
-```sql
-CREATE INDEX CONCURRENTLY ...
-```
-
-### Querying
-
 Use `EXPLAIN ANALYZE` to debug performance.
 
 ```sql
 EXPLAIN ANALYZE SELECT * FROM items ORDER BY embedding <-> '[3,1,2]' LIMIT 5;
 ```
 
-#### Exact Search
+### Exact Search
 
 To speed up queries without an index, increase `max_parallel_workers_per_gather`.
 
@@ -459,7 +430,7 @@ If vectors are normalized to length 1 (like [OpenAI embeddings](https://platform
 SELECT * FROM items ORDER BY embedding <#> '[3,1,2]' LIMIT 5;
 ```
 
-#### Approximate Search
+### Approximate Search
 
 To speed up queries with an IVFFlat index, increase the number of inverted lists (at the expense of recall).
 
@@ -467,7 +438,7 @@ To speed up queries with an IVFFlat index, increase the number of inverted lists
 CREATE INDEX ON items USING ivfflat (embedding vector_l2_ops) WITH (lists = 1000);
 ```
 
-### Vacuuming
+## Vacuuming
 
 Vacuuming can take a while for HNSW indexes. Speed it up by reindexing first.
 
@@ -476,41 +447,6 @@ REINDEX INDEX CONCURRENTLY index_name;
 VACUUM table_name;
 ```
 
-## Monitoring
-
-Monitor performance with [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) (be sure to add it to `shared_preload_libraries`).
-
-```sql
-CREATE EXTENSION pg_stat_statements;
-```
-
-Get the most time-consuming queries with:
-
-```sql
-SELECT query, calls, ROUND((total_plan_time + total_exec_time) / calls) AS avg_time_ms,
-    ROUND((total_plan_time + total_exec_time) / 60000) AS total_time_min
-    FROM pg_stat_statements ORDER BY total_plan_time + total_exec_time DESC LIMIT 20;
-```
-
-Note: Replace `total_plan_time + total_exec_time` with `total_time` for Postgres < 13
-
-Monitor recall by comparing results from approximate search with exact search.
-
-```sql
-BEGIN;
-SET LOCAL enable_indexscan = off; -- use exact search
-SELECT ...
-COMMIT;
-```
-
-## Scaling
-
-Scale pgvector the same way you scale Postgres.
-
-Scale vertically by increasing memory, CPU, and storage on a single instance. Use existing tools to [tune parameters](#tuning) and [monitor performance](#monitoring).
-
-Scale horizontally with [replicas](https://www.postgresql.org/docs/current/hot-standby.html), or use [Citus](https://github.com/citusdata/citus) or another approach for sharding ([example](https://github.com/pgvector/pgvector-python/blob/master/examples/citus.py)).
-
 ## Languages
 
 Use pgvector from any language with a Postgres client. You can even generate and store vectors in one language and query them in another.
@@ -616,17 +552,7 @@ SELECT pg_size_pretty(pg_relation_size('index_name'));
 
 #### Why isn’t a query using an index?
 
-The query needs to have an `ORDER BY` and `LIMIT`, and the `ORDER BY` must be the result of a distance operator, not an expression.
+The cost estimation in pgvector < 0.4.3 does not always work well with the planner. You can encourage the planner to use an index for a query with:
-
-```sql
--- index
-ORDER BY embedding <=> '[3,1,2]' LIMIT 5;
-
--- no index
-ORDER BY 1 - (embedding <=> '[3,1,2]') DESC LIMIT 5;
-```
-
-You can encourage the planner to use an index for a query with:
 
 ```sql
 BEGIN;
@@ -682,7 +608,6 @@ Operator | Description | Added
 \+ | element-wise addition |
 \- | element-wise subtraction |
 \* | element-wise multiplication | 0.5.0
-\|\| | concatenate | 0.7.0
 <-> | Euclidean distance |
 <#> | negative inner product |
 <=> | cosine distance |
@@ -705,7 +630,7 @@ Function | Description | Added
 avg(vector) → vector | average |
 sum(vector) → vector | sum | 0.5.0
 
-## Installation Notes - Linux and Mac
+## Installation Notes
 
 ### Postgres Location
 
@@ -747,24 +672,12 @@ If compilation fails and the output includes `warning: no such sysroot directory
 
 ### Portability
 
-By default, pgvector compiles with `-march=native` on some platforms for best performance. However, this can lead to `Illegal instruction` errors if trying to run the compiled extension on a different machine.
-
 To compile for portability, use:
 
 ```sh
 make OPTFLAGS=""
 ```
 
-## Installation Notes - Windows
-
-### Missing Header
-
-If compilation fails with `Cannot open include file: 'postgres.h': No such file or directory`, make sure `PGROOT` is correct.
-
-### Permissions
-
-If installation fails with `Access is denied`, re-run the installation instructions as an administrator.
-
 ## Additional Installation Methods
 
 ### Docker
@@ -949,12 +862,6 @@ make installcheck REGRESS=functions                            # regression test
 make prove_installcheck PROVE_TESTS=test/t/001_ivfflat_wal.pl  # TAP test
 ```
 
-To enable assertions:
-
-```sh
-make clean && PG_CFLAGS="-DUSE_ASSERT_CHECKING" make && make install
-```
-
 To enable benchmarking:
 
 ```sh
@@ -967,6 +874,12 @@ To show memory usage:
 make clean && PG_CFLAGS="-DHNSW_MEMORY -DIVFFLAT_MEMORY" make && make install
 ```
 
+To enable assertions:
+
+```sh
+make clean && PG_CFLAGS="-DUSE_ASSERT_CHECKING" make && make install
+```
+
 To get k-means metrics:
 
 ```sh

sql/vector--0.6.2--0.7.0.sql

@@ -1,9 +0,0 @@
--- complain if script is sourced in psql, rather than via CREATE EXTENSION
-\echo Use "ALTER EXTENSION vector UPDATE TO '0.7.0'" to load this file. \quit
-
-CREATE FUNCTION vector_concat(vector, vector) RETURNS vector
-	AS 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT PARALLEL SAFE;
-
-CREATE OPERATOR || (
-	LEFTARG = vector, RIGHTARG = vector, PROCEDURE = vector_concat
-);

sql/vector.sql

@@ -99,9 +99,6 @@ CREATE FUNCTION vector_avg(double precision[]) RETURNS vector
 CREATE FUNCTION vector_combine(double precision[], double precision[]) RETURNS double precision[]
 	AS 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT PARALLEL SAFE;
 
-CREATE FUNCTION vector_concat(vector, vector) RETURNS vector
-	AS 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT PARALLEL SAFE;
-
 -- aggregates
 
 CREATE AGGREGATE avg(vector) (
@@ -227,10 +224,6 @@ CREATE OPERATOR > (
 	RESTRICT = scalargtsel, JOIN = scalargtjoinsel
 );
 
-CREATE OPERATOR || (
-	LEFTARG = vector, RIGHTARG = vector, PROCEDURE = vector_concat
-);
-
 -- access methods
 
 CREATE FUNCTION ivfflathandler(internal) RETURNS index_am_handler

src/hnsw.h

@@ -129,7 +129,7 @@ HnswPtrDeclare(HnswNeighborArray, HnswNeighborArrayRelptr, HnswNeighborArrayPtr)
 HnswPtrDeclare(HnswNeighborArrayPtr, HnswNeighborsRelptr, HnswNeighborsPtr);
 HnswPtrDeclare(char, DatumRelptr, DatumPtr);
 
-struct HnswElementData
+typedef struct HnswElementData
 {
 	HnswElementPtr next;
 	ItemPointerData heaptids[HNSW_HEAPTIDS];
@@ -144,7 +144,7 @@ struct HnswElementData
 	BlockNumber neighborPage;
 	DatumPtr	value;
 	LWLock		lock;
-};
+}			HnswElementData;
 
 typedef HnswElementData * HnswElement;
 
@@ -155,12 +155,12 @@ typedef struct HnswCandidate
 	bool		closer;
 }			HnswCandidate;
 
-struct HnswNeighborArray
+typedef struct HnswNeighborArray
 {
 	int			length;
 	bool		closerSet;
 	HnswCandidate items[FLEXIBLE_ARRAY_MEMBER];
-};
+}			HnswNeighborArray;
 
 typedef struct HnswPairingHeapNode
 {
@@ -185,7 +185,6 @@ typedef struct HnswGraph
 
 	/* Entry state */
 	LWLock		entryLock;
-	LWLock		entryWaitLock;
 	HnswElementPtr entryPoint;
 
 	/* Allocations state */

src/hnswbuild.c

@@ -400,7 +400,7 @@ UpdateNeighborsInMemory(char *base, FmgrInfo *procinfo, Oid collation, HnswEleme
  * Update graph in memory
  */
 static void
-UpdateGraphInMemory(FmgrInfo *procinfo, Oid collation, HnswElement element, int m, int efConstruction, HnswElement entryPoint, HnswBuildState * buildstate)
+UpdateGraphInMemory(FmgrInfo *procinfo, Oid collation, HnswElement element, int m, int efConstruction, bool updateEntryPoint, HnswBuildState * buildstate)
 {
 	HnswGraph  *graph = buildstate->graph;
 	char	   *base = buildstate->hnswarea;
@@ -416,7 +416,7 @@ UpdateGraphInMemory(FmgrInfo *procinfo, Oid collation, HnswElement element, int
 	UpdateNeighborsInMemory(base, procinfo, collation, element, m);
 
 	/* Update entry point if needed (already have lock) */
-	if (entryPoint == NULL || element->level > entryPoint->level)
+	if (updateEntryPoint)
 		HnswPtrStore(base, graph->entryPoint, element);
 }
 
@@ -431,42 +431,32 @@ InsertTupleInMemory(HnswBuildState * buildstate, HnswElement element)
 	HnswGraph  *graph = buildstate->graph;
 	HnswElement entryPoint;
 	LWLock	   *entryLock = &graph->entryLock;
-	LWLock	   *entryWaitLock = &graph->entryWaitLock;
 	int			efConstruction = buildstate->efConstruction;
 	int			m = buildstate->m;
 	char	   *base = buildstate->hnswarea;
-
+	bool		updateEntryPoint;
-	/* Wait if another process needs exclusive lock on entry lock */
-	LWLockAcquire(entryWaitLock, LW_EXCLUSIVE);
-	LWLockRelease(entryWaitLock);
 
 	/* Get entry point */
-	LWLockAcquire(entryLock, LW_SHARED);
+	LWLockAcquire(entryLock, LW_EXCLUSIVE);
 	entryPoint = HnswPtrAccess(base, graph->entryPoint);
 
-	/* Prevent concurrent inserts when likely updating entry point */
+	/* Pause new inserts when updating entry point */
-	if (entryPoint == NULL || element->level > entryPoint->level)
+	/* May still be in-flight inserts */
-	{
+	updateEntryPoint = entryPoint == NULL || element->level > entryPoint->level;
-		/* Release shared lock */
+
+	/* Release entry lock */
+	if (!updateEntryPoint)
 		LWLockRelease(entryLock);
 
-		/* Tell other processes to wait and get exclusive lock */
-		LWLockAcquire(entryWaitLock, LW_EXCLUSIVE);
-		LWLockAcquire(entryLock, LW_EXCLUSIVE);
-		LWLockRelease(entryWaitLock);
-
-		/* Get latest entry point after lock is acquired */
-		entryPoint = HnswPtrAccess(base, graph->entryPoint);
-	}
-
 	/* Find neighbors for element */
 	HnswFindElementNeighbors(base, element, entryPoint, NULL, procinfo, collation, m, efConstruction, false);
 
 	/* Update graph in memory */
-	UpdateGraphInMemory(procinfo, collation, element, m, efConstruction, entryPoint, buildstate);
+	UpdateGraphInMemory(procinfo, collation, element, m, efConstruction, updateEntryPoint, buildstate);
 
 	/* Release entry lock */
-	LWLockRelease(entryLock);
+	if (updateEntryPoint)
+		LWLockRelease(entryLock);
 }
 
 /*
@@ -619,7 +609,6 @@ InitGraph(HnswGraph * graph, char *base, long memoryTotal)
 	graph->indtuples = 0;
 	SpinLockInit(&graph->lock);
 	LWLockInitialize(&graph->entryLock, hnsw_lock_tranche_id);
-	LWLockInitialize(&graph->entryWaitLock, hnsw_lock_tranche_id);
 	LWLockInitialize(&graph->allocatorLock, hnsw_lock_tranche_id);
 	LWLockInitialize(&graph->flushLock, hnsw_lock_tranche_id);
 }

src/vector.c

@@ -1160,28 +1160,3 @@ vector_avg(PG_FUNCTION_ARGS)
 
 	PG_RETURN_POINTER(result);
 }
-
-/*
- * Concat vectors
- */
-PGDLLEXPORT PG_FUNCTION_INFO_V1(vector_concat);
-Datum
-vector_concat(PG_FUNCTION_ARGS)
-{
-	Vector	   *a = PG_GETARG_VECTOR_P(0);
-	Vector	   *b = PG_GETARG_VECTOR_P(1);
-	Vector	   *result;
-	int			dim = a->dim + b->dim;
-
-	CheckDim(dim);
-
-	result = InitVector(dim);
-
-	for (int i = 0; i < a->dim; i++)
-		result->x[i] = a->x[i];
-
-	for (int i = 0; i < b->dim; i++)
-		result->x[i + a->dim] = b->x[i];
-
-	PG_RETURN_POINTER(result);
-}

test/expected/functions.out

@@ -24,14 +24,6 @@ SELECT '[1e37]'::vector * '[1e37]';
 ERROR:  value out of range: overflow
 SELECT '[1e-37]'::vector * '[1e-37]';
 ERROR:  value out of range: underflow
-SELECT '[1,2,3]'::vector || '[4,5]'::vector;
-  ?column?   
--------------
- [1,2,3,4,5]
-(1 row)
-
-SELECT array_fill(0, ARRAY[16000])::vector || '[1]'::vector;
-ERROR:  vector cannot have more than 16000 dimensions
 SELECT '[1,2,3]'::vector = '[1,2,3]';
  ?column? 
 ----------

test/sql/functions.sql

@@ -6,9 +6,6 @@ SELECT '[1,2,3]'::vector * '[4,5,6]';
 SELECT '[1e37]'::vector * '[1e37]';
 SELECT '[1e-37]'::vector * '[1e-37]';
 
-SELECT '[1,2,3]'::vector || '[4,5]'::vector;
-SELECT array_fill(0, ARRAY[16000])::vector || '[1]'::vector;
-
 SELECT '[1,2,3]'::vector = '[1,2,3]';
 SELECT '[1,2,3]'::vector = '[1,2]';