Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.paradedb.com/llms.txt

Use this file to discover all available pages before exploring further.

The all query means “search all rows in the index.” The primary use case for the all query is to force the query to be executed by the ParadeDB index instead of Postgres’ other execution methods. Because ParadeDB executes a query only when a ParadeDB operator is present in the query, the all query injects an operator into the query without changing the query’s meaning. To use it, pass the key field to the left-hand side of @@@ and pdb.all() to the right-hand side. 
-- Top K executed by standard Postgres
SELECT id, description, rating, category
FROM mock_items
WHERE rating IS NOT NULL
ORDER BY rating
LIMIT 5;

-- Top K executed by ParadeDB
SELECT id, description, rating, category
FROM mock_items
WHERE rating IS NOT NULL AND id @@@ pdb.all()
ORDER BY rating
LIMIT 5;
This is useful for cases where queries that don’t contain a ParadeDB operator can be more efficiently executed by ParadeDB vs. standard Postgres, like Top K or aggregate queries.