You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@
36
36
37
37
## ParadeDB for Rails
38
38
39
-
The official ActiveRecord integration for [ParadeDB](https://paradedb.com) (powered by the [`pg_search`](https://github.com/paradedb/paradedb) Postgres extension), including first-class support for managing BM25 indexes and running queries using the full ParadeDB API. Follow the [getting started guide](https://docs.paradedb.com/documentation/getting-started/environment#rails) to begin.
39
+
The official ActiveRecord integration for [ParadeDB](https://paradedb.com) (powered by the [`pg_search`](https://github.com/paradedb/paradedb) Postgres extension), including first-class support for managing ParadeDB indexes and running queries using the full ParadeDB API. The integration covers both full-text (BM25) and vector search — vector search indexes pgvector `vector(n)` columns directly. Follow the [getting started guide](https://docs.paradedb.com/documentation/getting-started/environment#rails) to begin.
40
40
41
41
## Requirements & Compatibility
42
42
@@ -46,17 +46,18 @@ The official ActiveRecord integration for [ParadeDB](https://paradedb.com) (powe
46
46
| Rails | 7.2+ |
47
47
| ParadeDB | 0.22.0+ |
48
48
| PostgreSQL | 15+ (PostgreSQL adapter with ParadeDB extension) |
49
+
| pgvector | Required for vector search (ships with ParadeDB) |
49
50
50
51
## Vector Search
51
52
52
-
rails-paradedb natively supports pgvector `vector(n)` columns — no `neighbor` or other pgvector gem required. Declare the column, list it in the BM25 index with a distance metric, and run Top-K queries:
53
+
rails-paradedb natively supports pgvector `vector(n)` columns — no `neighbor` or other pgvector gem required. Declare the column, list it in the ParadeDB index with a distance metric, and run Top-K queries:
Top-K index pushdown requires a `LIMIT`, and the query metric must match the index opclass metric — a mismatch still returns correct results but silently falls back to a plain sort. Vector columns inside BM25 indexes require a ParadeDB build with bm25 vector opclasses (not yet in a released ParadeDB version); the plain `vector(n)` column type and distance expressions work on any ParadeDB or Postgres with pgvector.
77
+
Top-K index pushdown requires a `LIMIT`, and the query metric must match the index opclass metric — a mismatch still returns correct results but silently falls back to a plain sort. Vector columns inside ParadeDB indexes require pg_search 0.25.0+ (unreleased); the plain `vector(n)` column type and distance expressions work on any ParadeDB or Postgres with pgvector.
0 commit comments