{ "$schema": "https://mintlify.com/docs.json", "theme": "aspen", "name": "ParadeDB", "colors": { "primary": "#4f46e5", "light": "#4f46e5", "dark": "#818cf8" }, "favicon": "/favicon.png", "banner": { "content": "[ParadeDB Cloud is now available in private preview](https://auth.paradedb.com/sign-up)", "dismissible": false }, "navigation": { "versions": [ { "version": "v0.26.0", "tabs": [ { "tab": "Start", "icon": "rocket", "pages": [ "start/introduction", { "group": "Getting Started", "pages": [ "start/install", "start/configure-your-environment", "start/create-your-first-index", "start/run-queries" ] }, { "group": "Next Steps", "pages": [ "start/load-data", "start/ai-agents", "start/go-to-production" ] } ] }, { "tab": "Reference", "icon": "book-open", "pages": [ "reference/overview", { "group": "Indexing", "pages": [ { "group": "Creating an Index", "pages": [ "reference/indexing/create-index", "reference/indexing/indexing-partial", "reference/indexing/columnar", "reference/indexing/partition-by", "reference/indexing/faster-bm25-queries" ] }, { "group": "Specialized Indexing", "pages": [ "reference/indexing/indexing-expressions", "reference/indexing/indexing-json", "reference/indexing/indexing-arrays", "reference/indexing/indexing-composite", "reference/indexing/indexing-vectors" ] } ] }, { "group": "Full-Text / Lexical Search", "pages": [ "reference/full-text/overview", { "group": "Text Analysis", "pages": [ "reference/tokenizers/overview", { "group": "Tokenizers", "pages": [ "reference/tokenizers/available-tokenizers/unicode", "reference/tokenizers/available-tokenizers/literal", "reference/tokenizers/available-tokenizers/literal-normalized", "reference/tokenizers/available-tokenizers/whitespace", "reference/tokenizers/available-tokenizers/ngrams", "reference/tokenizers/available-tokenizers/edge-ngrams", "reference/tokenizers/available-tokenizers/simple", "reference/tokenizers/available-tokenizers/regex", "reference/tokenizers/available-tokenizers/chinese-compatible", "reference/tokenizers/available-tokenizers/lindera", "reference/tokenizers/available-tokenizers/icu", "reference/tokenizers/available-tokenizers/jieba", "reference/tokenizers/available-tokenizers/source-code" ] }, { "group": "Token Filters", "pages": [ "reference/token-filters/overview", "reference/token-filters/alphanumeric", "reference/token-filters/ascii-folding", "reference/token-filters/lowercase", "reference/token-filters/stopwords", "reference/token-filters/stemming", "reference/token-filters/token-length", "reference/token-filters/trim" ] }, "reference/tokenizers/multiple-per-field", "reference/tokenizers/search-tokenizer" ] }, { "group": "Query Types", "pages": [ "reference/full-text/query-builder", "reference/full-text/match", "reference/full-text/term", { "group": "Phrase and Proximity", "pages": [ "reference/full-text/phrase", "reference/full-text/proximity", "reference/full-text/phrase-prefix", "reference/full-text/regex-phrase" ] }, "reference/full-text/fuzzy", "reference/full-text/regex", "reference/full-text/range-term", "reference/full-text/more-like-this", "reference/full-text/query-parser", "reference/full-text/all" ] }, { "group": "Filtering and Sorting", "pages": [ { "group": "Filtering", "pages": [ "reference/filtering/overview", "reference/filtering/indexed", "reference/filtering/external-indexes" ] }, "reference/full-text/top-k" ] }, { "group": "Relevance Tuning", "pages": [ "reference/full-text/score", "reference/full-text/relevance-tuning", "reference/full-text/highlight" ] } ] }, { "group": "Vector / Semantic Search", "pages": [ "reference/vector/overview", "reference/vector/querying", "reference/vector/tuning" ] }, { "group": "Hybrid Search", "pages": [ "reference/hybrid/overview", "reference/hybrid/rrf" ] }, { "group": "Aggregations", "pages": [ "reference/aggregates/overview", { "group": "Bucket", "pages": [ "reference/aggregates/bucket/terms", "reference/aggregates/bucket/filters", "reference/aggregates/bucket/histogram", "reference/aggregates/bucket/datehistogram", "reference/aggregates/bucket/range" ] }, { "group": "Metrics", "pages": [ "reference/aggregates/metrics/average", "reference/aggregates/metrics/cardinality", "reference/aggregates/metrics/count", "reference/aggregates/metrics/minmax", "reference/aggregates/metrics/percentiles", "reference/aggregates/metrics/stats", "reference/aggregates/metrics/sum", "reference/aggregates/metrics/tophits" ] }, "reference/aggregates/facets", "reference/aggregates/limitations" ] }, { "group": "JOINs", "pages": [ "reference/joins/overview" ] }, { "group": "Sharding", "pages": [ "reference/sharding/citus" ] }, { "group": "Cheatsheets", "pages": [ "reference/operators-and-functions", "reference/configuration", "reference/sql-functions" ], "expanded": false } ] }, { "tab": "Concepts", "icon": "lightbulb", "pages": [ "concepts/architecture", "concepts/guarantees", "concepts/full-text/overview", "concepts/vector/overview", "concepts/hybrid/overview", "concepts/limitations" ] }, { "tab": "Operate", "icon": "server", "pages": [ "operate/deploy/enterprise", { "group": "Deployment", "pages": [ "operate/deploy/overview", "operate/deploy/cloud", "operate/deploy/byoc", "operate/deploy/self-hosted/kubernetes", "operate/deploy/self-hosted/extension", { "group": "PaaS Providers", "pages": [ "operate/deploy/cloud-platforms/railway", "operate/deploy/cloud-platforms/render", "operate/deploy/cloud-platforms/fly", "operate/deploy/cloud-platforms/dokku", "operate/deploy/cloud-platforms/digitalocean" ] } ] }, { "group": "Replication", "pages": [ "operate/deploy/self-hosted/high-availability", { "group": "Logical Replication", "pages": [ "operate/deploy/logical-replication/getting-started", "operate/deploy/logical-replication/bootstrapping", "operate/deploy/logical-replication/configuration", "operate/deploy/logical-replication/schema-changes", "operate/deploy/logical-replication/monitoring-and-troubleshooting", "operate/deploy/logical-replication/multi-database" ] } ] }, { "group": "Index Maintenance", "pages": [ "operate/index-maintenance/reindexing", "operate/index-maintenance/verify-index" ] }, { "group": "Performance", "pages": [ "operate/performance-tuning/overview", "operate/performance-tuning/create-index", "operate/performance-tuning/reads", "operate/performance-tuning/writes" ] }, { "group": "Administration", "pages": [ "operate/deploy/upgrading" ] }, { "group": "Continuous Integration", "pages": [ "operate/deploy/ci/github-actions", "operate/deploy/ci/gitlab-pipelines" ] } ] }, { "tab": "Project", "icon": "flag", "pages": [ "project/roadmap", { "group": "Changelog", "pages": [ "project/changelog", { "group": "v0.26", "pages": [ "project/changelog/0.26.0" ], "expanded": false }, { "group": "Older", "pages": [ { "group": "v0.25", "pages": [ "project/changelog/0.25.11", "project/changelog/0.25.10", "project/changelog/0.25.9", "project/changelog/0.25.8", "project/changelog/0.25.7", "project/changelog/0.25.6", "project/changelog/0.25.5", "project/changelog/0.25.4", "project/changelog/0.25.3", "project/changelog/0.25.2", "project/changelog/0.25.1", "project/changelog/0.25.0" ], "expanded": false }, { "group": "v0.24", "pages": [ "project/changelog/0.24.3", "project/changelog/0.24.2", "project/changelog/0.24.1", "project/changelog/0.24.0" ], "expanded": false }, { "group": "v0.23", "pages": [ "project/changelog/0.23.5", "project/changelog/0.23.4", "project/changelog/0.23.3", "project/changelog/0.23.2", "project/changelog/0.23.1", "project/changelog/0.23.0" ], "expanded": false }, { "group": "v0.22", "pages": [ "project/changelog/0.22.6", "project/changelog/0.22.5", "project/changelog/0.22.4", "project/changelog/0.22.3", "project/changelog/0.22.2", "project/changelog/0.22.1", "project/changelog/0.22.0" ], "expanded": false }, { "group": "v0.21", "pages": [ "project/changelog/0.21.16", "project/changelog/0.21.15", "project/changelog/0.21.14", "project/changelog/0.21.13", "project/changelog/0.21.12", "project/changelog/0.21.11", "project/changelog/0.21.10", "project/changelog/0.21.9", "project/changelog/0.21.8", "project/changelog/0.21.7", "project/changelog/0.21.6", "project/changelog/0.21.5", "project/changelog/0.21.4", "project/changelog/0.21.3", "project/changelog/0.21.2", "project/changelog/0.21.1", "project/changelog/0.21.0" ], "expanded": false }, { "group": "v0.20", "pages": [ "project/changelog/0.20.11", "project/changelog/0.20.10", "project/changelog/0.20.9", "project/changelog/0.20.8", "project/changelog/0.20.7", "project/changelog/0.20.6", "project/changelog/0.20.5", "project/changelog/0.20.4", "project/changelog/0.20.3", "project/changelog/0.20.2", "project/changelog/0.20.1", "project/changelog/0.20.0" ], "expanded": false }, { "group": "v0.19", "pages": [ "project/changelog/0.19.11", "project/changelog/0.19.10", "project/changelog/0.19.9", "project/changelog/0.19.8", "project/changelog/0.19.7", "project/changelog/0.19.6", "project/changelog/0.19.5", "project/changelog/0.19.4", "project/changelog/0.19.3", "project/changelog/0.19.2", "project/changelog/0.19.1", "project/changelog/0.19.0" ], "expanded": false }, { "group": "v0.18", "pages": [ "project/changelog/0.18.15", "project/changelog/0.18.14", "project/changelog/0.18.13", "project/changelog/0.18.12", "project/changelog/0.18.11", "project/changelog/0.18.10", "project/changelog/0.18.9", "project/changelog/0.18.8", "project/changelog/0.18.7", "project/changelog/0.18.6", "project/changelog/0.18.5", "project/changelog/0.18.4", "project/changelog/0.18.3", "project/changelog/0.18.2", "project/changelog/0.18.1", "project/changelog/0.18.0" ], "expanded": false }, { "group": "v0.17", "pages": [ "project/changelog/0.17.12", "project/changelog/0.17.10", "project/changelog/0.17.9", "project/changelog/0.17.8", "project/changelog/0.17.7", "project/changelog/0.17.6", "project/changelog/0.17.5", "project/changelog/0.17.4", "project/changelog/0.17.3", "project/changelog/0.17.2", "project/changelog/0.17.1", "project/changelog/0.17.0" ], "expanded": false }, { "group": "v0.16", "pages": [ "project/changelog/0.16.5", "project/changelog/0.16.4", "project/changelog/0.16.3", "project/changelog/0.16.2", "project/changelog/0.16.1", "project/changelog/0.16.0" ], "expanded": false }, { "group": "v0.15", "pages": [ "project/changelog/0.15.26", "project/changelog/0.15.25", "project/changelog/0.15.24", "project/changelog/0.15.23", "project/changelog/0.15.22", "project/changelog/0.15.21", "project/changelog/0.15.20", "project/changelog/0.15.19", "project/changelog/0.15.18", "project/changelog/0.15.17", "project/changelog/0.15.16", "project/changelog/0.15.15", "project/changelog/0.15.14", "project/changelog/0.15.13", "project/changelog/0.15.12", "project/changelog/0.15.11", "project/changelog/0.15.10", "project/changelog/0.15.9", "project/changelog/0.15.8", "project/changelog/0.15.7", "project/changelog/0.15.6", "project/changelog/0.15.5", "project/changelog/0.15.4", "project/changelog/0.15.3", "project/changelog/0.15.2", "project/changelog/0.15.1", "project/changelog/0.15.0" ], "expanded": false }, { "group": "v0.14", "pages": [ "project/changelog/0.14.1", "project/changelog/0.14.0" ], "expanded": false }, "project/changelog/deprecated" ], "expanded": false } ] }, { "group": "Resources", "pages": [ "project/support", "project/resources/slack", "project/resources/blog", "project/resources/learn" ] } ] } ] } ] }, "logo": { "light": "/logo/light.svg", "dark": "/logo/dark.svg", "href": "https://www.paradedb.com" }, "appearance": { "strict": false }, "navbar": { "links": [ { "type": "github", "href": "https://github.com/paradedb/paradedb" }, { "label": "Log In", "href": "https://app.paradedb.com" } ], "primary": { "type": "button", "label": "Sign Up", "href": "https://auth.paradedb.com/sign-up" } }, "contextual": { "options": [ "copy", "mcp", "cursor", "vscode", "perplexity", "chatgpt", "claude", { "title": "Share on X", "description": "Share this page on X", "icon": "x", "iconType": "brands", "href": { "base": "https://x.com/intent/tweet", "query": [ { "key": "text", "value": "Check out this ParadeDB doc!" }, { "key": "url", "value": "https://www.paradedb.com/docs$path" } ] } } ] }, "footer": { "socials": { "github": "https://github.com/paradedb/paradedb", "twitter": "https://x.com/paradedb", "linkedin": "https://www.linkedin.com/company/paradedb", "slack": "https://paradedb.com/slack" } }, "integrations": { "gtm": { "tagId": "GTM-KMGRG564" }, "posthog": { "apiKey": "phc_KiWfPSoxQLmFxY5yOODDBzzP3EcyPbn9oSVtsCBbasj", "apiHost": "https://app.posthog.com" } }, "seo": { "metatags": { "charset": "UTF-8", "viewport": "width=device-width, initial-scale=1.0", "keywords": "paradedb, postgres, search, analytics, bm25, full-text search, vector search, semantic search, hybrid search, faceted search, columnar, olap", "author": "ParadeDB", "google": "notranslate", "generator": "Mintlify", "theme-color": "#000000", "color-scheme": "light dark", "referrer": "origin", "rating": "general", "revisit-after": "7 days", "language": "en", "copyright": "ParadeDB, Inc. 2026", "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", "og:type": "website", "og:locale": "en_US", "og:description": "You should just use Postgres.", "og:image": "https://www.paradedb.com/opengraph-image.png", "og:image:alt": "ParadeDB: Just use Postgres.", "twitter:card": "summary_large_image", "twitter:site": "@paradedb", "twitter:creator": "@paradedb", "twitter:description": "You should just use Postgres.", "twitter:image": "https://www.paradedb.com/twitter-image.png", "twitter:image:alt": "ParadeDB: Just use Postgres." }, "indexing": "navigable" }, "redirects": { "$ref": "./redirects.json" } }