{ "$schema": "https://mintlify.com/docs.json", "theme": "willow", "name": "ParadeDB", "colors": { "primary": "#4f46e5", "light": "#4f46e5", "dark": "#818cf8" }, "favicon": "/favicon.png", "navigation": { "versions": [ { "version": "v0.19.0", "anchors": [ { "anchor": "Documentation", "icon": "book-open", "groups": [ { "group": "Documentation", "pages": [ { "group": "Why ParadeDB?", "pages": [ "welcome/introduction", "welcome/architecture", "welcome/guarantees", "welcome/limitations", "welcome/roadmap" ] }, { "group": "Getting Started", "pages": [ "documentation/getting-started/install", "documentation/getting-started/quickstart", "documentation/getting-started/load" ] }, { "group": "Reference", "pages": [ "documentation/overview", { "group": "Indexing", "pages": [ "documentation/indexing/create_index", "documentation/indexing/inspect_index", { "group": "Index Tuning", "pages": [ "documentation/configuration/overview", "documentation/configuration/index_build", "documentation/configuration/write_throughput", "documentation/configuration/read_throughput" ] }, { "group": "Feature Flags", "pages": [ "documentation/configuration/custom_scan" ] } ] }, { "group": "Field Configuration", "pages": [ "documentation/indexing/field_options", "documentation/indexing/tokenizers", "documentation/indexing/token_filters", "documentation/indexing/fast_fields", "documentation/indexing/record" ] }, { "group": "Full Text Search", "pages": [ "documentation/full-text/overview", "documentation/full-text/boolean", "documentation/full-text/phrase", "documentation/full-text/filtering", "documentation/full-text/pagination", "documentation/full-text/scoring", "documentation/full-text/highlighting", "documentation/full-text/sorting", "documentation/full-text/boosting" ] }, { "group": "Query Builder", "pages": [ "documentation/advanced/overview", { "group": "Full Text Queries", "pages": [ "documentation/advanced/full-text/match" ] }, { "group": "Term-Level Queries", "pages": [ "documentation/advanced/term/exists", "documentation/advanced/term/fuzzy_term", "documentation/advanced/term/range", "documentation/advanced/term/range_term", "documentation/advanced/term/regex", "documentation/advanced/term/term", "documentation/advanced/term/term_set" ] }, { "group": "Phrase-Level Queries", "pages": [ "documentation/advanced/phrase/phrase", "documentation/advanced/phrase/phrase_prefix" ] }, { "group": "JSON Queries", "pages": [ "documentation/advanced/json/overview", "documentation/advanced/json/arrays", "documentation/advanced/json/range" ] }, { "group": "Compound Queries", "pages": [ "documentation/advanced/compound/overview", "documentation/advanced/compound/all", "documentation/advanced/compound/boolean", "documentation/advanced/compound/boost", "documentation/advanced/compound/const", "documentation/advanced/compound/disjunction_max", "documentation/advanced/compound/empty", "documentation/advanced/compound/parse" ] }, { "group": "Specialized Queries", "pages": [ "documentation/advanced/specialized/more_like_this" ] } ] }, { "group": "Aggregates", "pages": [ "documentation/aggregates/overview", { "group": "Bucket", "pages": [ "documentation/aggregates/bucket/terms" ] }, { "group": "Metrics", "pages": [ "documentation/aggregates/metrics/count", "documentation/aggregates/metrics/sum", "documentation/aggregates/metrics/minmax", "documentation/aggregates/metrics/average" ] }, "documentation/aggregates/tuning", "documentation/aggregates/limitations" ] }, { "group": "Similarity Search", "pages": [ "documentation/similarity/overview", "documentation/similarity/index", "documentation/similarity/search" ] } ] }, { "group": "Tutorials", "pages": [ "documentation/guides/overview", "documentation/guides/autocomplete", "documentation/guides/hybrid" ] }, { "group": "Concepts", "pages": [ "documentation/concepts/bm25", "documentation/concepts/index", "documentation/concepts/matching", "documentation/concepts/phrase", "documentation/concepts/search", "documentation/concepts/stemming", "documentation/concepts/tantivy", "documentation/concepts/term" ] }, "welcome/support" ] } ] }, { "anchor": "Docs v2 (beta)", "icon": "sparkles", "groups": [ { "group": "Documentation (v2)", "pages": [ "v2/overview", { "group": "Getting Started", "pages": [ "v2/getting-started/install", "v2/getting-started/quickstart", "v2/getting-started/load" ] }, { "group": "Reference", "pages": [ { "group": "Indexing", "pages": [ "v2/indexing/create_index", "v2/indexing/indexing_expressions", "v2/indexing/indexing_json", "v2/indexing/reindexing" ] }, { "group": "Tokenizers", "pages": [ "v2/tokenizers/overview", { "group": "Available Tokenizers", "pages": [ "v2/tokenizers/available_tokenizers/simple", "v2/tokenizers/available_tokenizers/exact", "v2/tokenizers/available_tokenizers/literal_normalized", "v2/tokenizers/available_tokenizers/whitespace", "v2/tokenizers/available_tokenizers/ngrams", "v2/tokenizers/available_tokenizers/regex", "v2/tokenizers/available_tokenizers/chinese_compatible", "v2/tokenizers/available_tokenizers/lindera", "v2/tokenizers/available_tokenizers/icu", "v2/tokenizers/available_tokenizers/jieba", "v2/tokenizers/available_tokenizers/source_code" ] }, "v2/tokenizers/multiple_per_field" ] }, { "group": "Token Filters", "pages": [ "v2/token_filters/overview", "v2/token_filters/alpha_numeric", "v2/token_filters/ascii_folding", "v2/token_filters/lowercase", "v2/token_filters/stopwords", "v2/token_filters/stemming", "v2/token_filters/token_length" ] }, { "group": "Full Text Search", "pages": [ "v2/full-text/overview", "v2/full-text/match", "v2/full-text/phrase", "v2/full-text/term", "v2/full-text/term_set", "v2/full-text/fuzzy", "v2/full-text/highlight", "v2/full-text/proximity" ] }, { "group": "Sorting", "pages": [ "v2/sorting/score", "v2/sorting/boost", "v2/sorting/topn" ] }, { "group": "Query Builder", "pages": [ "v2/query-builder/overview", "v2/query-builder/match", { "group": "Phrase", "pages": [ "v2/query-builder/phrase/phrase", "v2/query-builder/phrase/phrase_prefix", "v2/query-builder/phrase/regex_phrase" ] }, { "group": "Term", "pages": [ "v2/query-builder/term/exists", "v2/query-builder/term/fuzzy_term", "v2/query-builder/term/range", "v2/query-builder/term/range_term", "v2/query-builder/term/regex", "v2/query-builder/term/term", "v2/query-builder/term/term_set" ] }, { "group": "Specialized", "pages": [ "v2/query-builder/specialized/more_like_this" ] }, "v2/query-builder/json" ] }, { "group": "Aggregates", "pages": [ "v2/aggregates/overview" ] } ] }, "welcome/support", { "group": "Latest Version: v0.17.3", "pages": [] } ] } ] }, { "anchor": "Deploy", "icon": "server", "groups": [ { "group": "Deploy", "pages": [ "deploy/overview", { "group": "ParadeDB Self-Hosted", "pages": [ "deploy/self-hosted/kubernetes", "deploy/self-hosted/docker", "deploy/self-hosted/extension", { "group": "Logical Replication", "pages": [ "deploy/self-hosted/logical-replication/getting-started", "deploy/self-hosted/logical-replication/configuration" ] }, { "group": "High Availability", "pages": [ "deploy/self-hosted/high-availability/getting-started", "deploy/self-hosted/high-availability/configuration" ] } ] }, "deploy/byoc", "deploy/enterprise", "deploy/upgrading", "deploy/third-party-extensions", { "group": "Continuous Integration", "pages": [ "deploy/ci/overview", "deploy/ci/github-actions", "deploy/ci/gitlab-ci" ] } ] } ] }, { "anchor": "Changelog", "icon": "clock", "groups": [ { "group": "Changelog", "pages": [ "changelog/0.19.0", "changelog/0.18.11", "changelog/0.18.10", "changelog/0.18.9", "changelog/0.18.8", "changelog/0.18.7", "changelog/0.18.6", "changelog/0.18.5", "changelog/0.18.4", "changelog/0.18.3", "changelog/0.18.2", "changelog/0.18.1", "changelog/0.18.0", "changelog/0.17.12", "changelog/0.17.10", "changelog/0.17.9", "changelog/0.17.8", "changelog/0.17.7", "changelog/0.17.6", "changelog/0.17.5", "changelog/0.17.4", "changelog/0.17.3", "changelog/0.17.2", "changelog/0.17.1", "changelog/0.17.0", "changelog/0.16.5", "changelog/0.16.4", "changelog/0.16.3", "changelog/0.16.2", "changelog/0.16.1", "changelog/0.16.0", "changelog/0.15.26", "changelog/0.15.25", "changelog/0.15.24", "changelog/0.15.23", "changelog/0.15.22", "changelog/0.15.21", "changelog/0.15.20", "changelog/0.15.19", "changelog/0.15.18", "changelog/0.15.17", "changelog/0.15.16", "changelog/0.15.15", "changelog/0.15.14", "changelog/0.15.13", "changelog/0.15.12", "changelog/0.15.11", "changelog/0.15.10", "changelog/0.15.9", "changelog/0.15.8", "changelog/0.15.7", "changelog/0.15.6", "changelog/0.15.5", "changelog/0.15.4", "changelog/0.15.3", "changelog/0.15.2", "changelog/0.15.1", "changelog/0.15.0", "changelog/0.14.1", "changelog/0.14.0", "changelog/deprecated" ] } ] } ] } ] }, "logo": { "light": "/logo/light.svg", "dark": "/logo/dark.svg", "href": "https://paradedb.com" }, "appearance": { "strict": false }, "background": { "image": "/images/background.png" }, "navbar": { "links": [ { "label": "Community", "href": "https://join.slack.com/t/paradedbcommunity/shared_invite/zt-32abtyjg4-yoYoi~RPh9MSW8tDbl0BQw" }, { "label": "Blog", "href": "https://paradedb.com/blog" } ], "primary": { "type": "github", "href": "https://github.com/paradedb/paradedb" } }, "footer": { "socials": { "github": "https://github.com/paradedb/paradedb", "slack": "https://join.slack.com/t/paradedbcommunity/shared_invite/zt-32abtyjg4-yoYoi~RPh9MSW8tDbl0BQw", "twitter": "https://twitter.com/paradedb" } }, "integrations": { "gtm": { "tagId": "GTM-KMGRG564" }, "posthog": { "apiKey": "phc_KiWfPSoxQLmFxY5yOODDBzzP3EcyPbn9oSVtsCBbasj", "apiHost": "https://app.posthog.com" } }, "seo": { "metatags": { "robots": "index, follow", "charset": "UTF-8", "viewport": "width=device-width, initial-scale=1.0", "description": "Developer docs for ParadeDB, the transactional alternative to Elasticsearch built on Postgres", "keywords": "paradedb, postgres, search, analytics, bm25, full-text search, hybrid search, faceted search, columnar, olap", "author": "ParadeDB", "googlebot": "index, follow", "google": "notranslate", "generator": "Mintlify", "theme-color": "#000000", "color-scheme": "light dark", "canonical": "https://docs.paradedb.com", "referrer": "origin", "refresh": "30", "rating": "general", "revisit-after": "7 days", "language": "en", "copyright": "ParadeDB, Inc. 2025", "reply-to": "support@paradedb.com", "distribution": "global", "coverage": "Worldwide", "category": "Technology", "target": "all", "HandheldFriendly": "True", "MobileOptimized": "320", "apple-mobile-web-app-capable": "yes", "apple-mobile-web-app-status-bar-style": "black", "apple-mobile-web-app-title": "ParadeDB Docs", "application-name": "ParadeDB Docs", "og:title": "ParadeDB Docs", "og:type": "website", "og:url": "https://docs.paradedb.com", "og:image": "https://www.paradedb.com/opengraph-image.png", "og:description": "Developer docs for ParadeDB, the transactional alternative to Elasticsearch built on Postgres", "og:site_name": "ParadeDB Docs", "og:locale": "en_US", "twitter:card": "summary_large_image", "twitter:site": "@paradedb", "twitter:creator": "@paradedb", "twitter:title": "ParadeDB Docs", "twitter:description": "Developer docs for ParadeDB, the transactional alternative to Elasticsearch built on Postgres.", "twitter:image": "https://www.paradedb.com/twitter-image.png", "twitter:image:alt": "ParadeDB: The transactional alternative to Elasticsearch built on Postgres." }, "indexing": "navigable" }, "redirects": [ { "source": "/blog", "destination": "https://paradedb.com/blog" }, { "source": "/blog/introducing_analytics", "destination": "https://paradedb.com/blog/introducing_lakehouse" }, { "source": "/blog/introducing_sparse", "destination": "https://paradedb.com/blog/introducing_sparse" }, { "source": "/blog/introducing_bm25", "destination": "https://paradedb.com/blog/introducing_search" }, { "source": "/blog/introducing_paradedb", "destination": "https://paradedb.com/blog/introducing_paradedb" } ] }