# ParadeDB

## Docs

- [ParadeDB BYOC](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/byoc.md): Deploy ParadeDB Bring Your Own Cloud (BYOC) within your cloud environment
- [GitHub Actions](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/ci/github-actions.md): How to run ParadeDB in Github Actions CI
- [GitLab CI](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/ci/gitlab-ci.md): How to run ParadeDB in Gitlab CI
- [Using ParadeDB with Citus](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/citus.md): Distributed full-text search with Citus and ParadeDB
- [ParadeDB Enterprise](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/enterprise.md): Feature comparison between ParadeDB Community and Enterprise
- [Deploying ParadeDB](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/overview.md): Explore the different ways to deploy ParadeDB into production
- [Docker](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/self-hosted/docker.md): How to run the ParadeDB Docker container
- [Extension](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/self-hosted/extension.md): How to install ParadeDB as an extension inside an existing self-managed Postgres
- [Configuring High Availability](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/self-hosted/high-availability/configuration.md): Use read replicas to minimize downtime in production
- [Kubernetes](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/self-hosted/kubernetes.md): How to deploy ParadeDB as a Kubernetes cluster into production
- [Schema Changes](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/self-hosted/logical-replication/configuration.md): Handle DDL/schema changes when running ParadeDB as a logical replica
- [Configuring Logical Replication](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/self-hosted/logical-replication/getting-started.md): Set up ParadeDB as a logical replica of an existing Postgres like Amazon RDS
- [Installing Third Party Extensions](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/third-party-extensions.md): How to install additional extensions into ParadeDB
- [Upgrading ParadeDB](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/deploy/upgrading.md): How to update ParadeDB to the latest version
- [Date Histogram](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/bucket/datehistogram.md): Count the number of occurrences over fixed time intervals
- [Filters](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/bucket/filters.md): Compute aggregations over multiple filters in one query
- [Histogram](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/bucket/histogram.md): Count the number of occurrences over some interval
- [Range](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/bucket/range.md): Count the number of occurrences over user-defined buckets
- [Terms](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/bucket/terms.md): Count the number of occurrences for each value in a result set
- [Facets](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/facets.md): Compute a Top N and aggregate in one query
- [Limitations](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/limitations.md): Caveats for aggregate support
- [Average](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/metrics/average.md): Compute the average value of a field
- [Cardinality](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/metrics/cardinality.md): Compute the number of distinct values in a field
- [Count](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/metrics/count.md): Count the number of values in a field
- [Min/Max](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/metrics/minmax.md): Compute the min/max value of a field
- [Percentiles](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/metrics/percentiles.md): Analyze the distribution of a field
- [Stats](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/metrics/stats.md): Compute several metrics at once
- [Sum](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/metrics/sum.md): Compute the sum of a field
- [Top Hits](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/metrics/tophits.md): Compute the top hits for each bucket in a terms aggregation
- [Aggregate Syntax](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/overview.md): Accelerate aggregates with the ParadeDB index
- [Performance Tuning](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/aggregates/tuning.md): Several settings can be tuned to improve the performance of aggregates in ParadeDB
- [Filtering](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/filtering.md): Filter search results based on metadata from other fields
- [Fuzzy](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/full-text/fuzzy.md): Allow for typos in the query string
- [Highlighting](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/full-text/highlight.md): Generate snippets for portions of the source text that match the query string
- [Match](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/full-text/match.md): Returns documents that match the provided query string, which is tokenized before matching
- [How Text Search Works](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/full-text/overview.md): Understand how ParadeDB uses token matching to efficiently search large corpuses of text
- [Phrase](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/full-text/phrase.md): Phrase queries are like match queries, but with order and position of matching tokens enforced
- [Proximity](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/full-text/proximity.md): Match documents based on token proximity within the source document
- [Term](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/full-text/term.md): Look for exact token matches in the source document, without any further processing of the query string
- [Install ParadeDB](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/getting-started/install.md): How to run the ParadeDB Docker image
- [Load Data from Postgres](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/getting-started/load.md): Dump data from an existing Postgres and load into ParadeDB
- [Quickstart](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/getting-started/quickstart.md): Get started with ParadeDB in five minutes
- [Create an Index](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/indexing/create-index.md): Index a Postgres table for full text search
- [Indexing Text Arrays](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/indexing/indexing-arrays.md): Add text arrays to the index
- [Indexing Expressions](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/indexing/indexing-expressions.md): Add Postgres expressions to the index
- [Indexing JSON](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/indexing/indexing-json.md): Add JSON and JSONB types to the index
- [Reindexing](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/indexing/reindexing.md): Reindex an existing index
- [Index Creation](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/performance-tuning/create-index.md): Settings to make index creation faster
- [Joins](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/performance-tuning/joins.md): Optimize JOIN queries in ParadeDB
- [How to Tune ParadeDB](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/performance-tuning/overview.md): Settings for better read and write performance
- [Read Throughput](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/performance-tuning/reads.md): Settings to improve read performance
- [Write Throughput](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/performance-tuning/writes.md): Settings to improve write performance
- [All](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/query-builder/compound/all.md): Search all rows in the index
- [Query Parser](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/query-builder/compound/query-parser.md): Accept raw user-provided query strings
- [How Advanced Query Functions Work](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/query-builder/overview.md): ParadeDB's query builder functions provide advanced query types
- [Phrase Prefix](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/query-builder/phrase/phrase-prefix.md): Finds documents containing a phrase followed by a term prefix
- [Regex Phrase](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/query-builder/phrase/regex-phrase.md): Matches a specific sequence of regex queries
- [More Like This](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/query-builder/specialized/more-like-this.md): Finds documents that are "like" another document.
- [Range Term](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/query-builder/term/range-term.md): Filters over Postgres range types
- [Regex](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/query-builder/term/regex.md): Searches for terms that match a regex pattern
- [Relevance Tuning](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/sorting/boost.md): Tune the BM25 score by adjusting the weights of individual queries
- [BM25 Scoring](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/sorting/score.md): BM25 scores sort the result set by relevance
- [Top N](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/sorting/topn.md): ParadeDB is optimized for quickly finding the "Top N" results in a table
- [Alpha Numeric Only](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/token-filters/alphanumeric.md): Removes any tokens that contain characters that are not ASCII letters
- [ASCII Folding](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/token-filters/ascii-folding.md): Strips away diacritical marks like accents
- [Lowercase](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/token-filters/lowercase.md): Converts all characters to lowercase
- [How Token Filters Work](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/token-filters/overview.md): Token filters apply additional processing to tokens like lowercasing or stemming
- [Stemmer](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/token-filters/stemming.md): Reduces words to their root form for a given language
- [Remove Stopwords](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/token-filters/stopwords.md): Remove language-specific stopwords from the index
- [Token Length](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/token-filters/token-length.md): Remove tokens that are above or below a certain byte length from the index
- [Trim](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/token-filters/trim.md): Remove trailing and leading whitespace from a token
- [Chinese Compatible](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/available-tokenizers/chinese-compatible.md): A simple tokenizer for Chinese, Japanese, and Korean characters
- [ICU](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/available-tokenizers/icu.md): Splits text according to the Unicode standard
- [Jieba](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/available-tokenizers/jieba.md): The most advanced Chinese tokenizer that leverages both a dictionary and statistical models
- [Lindera](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/available-tokenizers/lindera.md): Uses prebuilt dictionaries to tokenize Chinese, Japanese, and Korean text
- [Literal](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/available-tokenizers/literal.md): Indexes the text in its raw form, without any splitting or processing
- [Literal Normalized](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/available-tokenizers/literal-normalized.md): Like the literal tokenizer, but allows for token filters
- [Ngram](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/available-tokenizers/ngrams.md): Splits text into small chunks called grams, useful for partial matching
- [Regex Patterns](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/available-tokenizers/regex.md): Tokenizes text using a regular expression
- [Simple](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/available-tokenizers/simple.md): Splits on any non-alphanumeric character
- [Source Code](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/available-tokenizers/source-code.md): Tokenizes text that is actually code
- [Unicode](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/available-tokenizers/unicode.md): The default text tokenizer in ParadeDB
- [Whitespace](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/available-tokenizers/whitespace.md): Tokenizes text by splitting on whitespace
- [Multiple Tokenizers Per Field](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/multiple-per-field.md): Apply different token configurations to the same field
- [How Tokenizers Work](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/documentation/tokenizers/overview.md): Tokenizers split large chunks of text into small, searchable units called tokens
- [Architecture](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/welcome/architecture.md): A deep dive into how ParadeDB is built on Postgres
- [Guarantees](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/welcome/guarantees.md): ParadeDB ensures ACID compliance, concurrency, data integrity, and replication safety
- [Simple, Elastic-Quality Search for Postgres](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/welcome/introduction.md): ParadeDB is the modern Elastic alternative built as a Postgres extension.
- [Limitations & Tradeoffs](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/welcome/limitations.md): Understand ParadeDB's key limitations and tradeoffs
- [Roadmap](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/welcome/roadmap.md): The main features that we are currently working on
- [Help and Support](https://paradedb-ankitml-legacy-docs-remove.mintlify.app/welcome/support.md): How to obtain support for ParadeDB