• ☝ Introduction
• ❗ Read this first
• 1️⃣ Installation
  • • Docker
  • • RedHat and Centos
  • • Debian and Ubuntu
  • • MacOS
  • • Windows
  • • Compiling from sources
  • • Migration from Sphinx
• 🔰 Quick start guide
• 2️⃣ Starting the server
  • • In Linux
  • • Manually
  • • In Docker
  • • In Windows
  • • In MacOS
• 3️⃣ Creating a table
  • • Data types
    • • Row-wise and columnar attribute storages
  • Creating a local table
    • ✔ Real-time table
    • • Plain table
    • • Plain and real-time table settings
    • • Percolate table
    • • Template table
  • [⪢ NLP and tokenization]
    • • Data tokenization
    • • Supported languages
    • • CJK
    • • Low-level tokenization
    • • Wildcard searching settings
    • • Ignoring stop words
    • • Word forms
    • • Exceptions
    • • Morphology
    • • Advanced HTML tokenization
  • ⪢ Creating a distributed table
    • • Creating a local distributed table
    • • Remote tables
• • Listing tables
• • Deleting a table
• • Emptying a table
• ⪢ Creating a cluster
  • Adding a new node
  • ⪢ Remote nodes
    • Mirroring
    • Load balancing
  • ⪢ Setting up replication
    • Creating a replication cluster
    • Joining a replication cluster
    • Deleting a replication cluster
    • Adding and removing a table from a replication cluster
    • Managing replication nodes
    • Replication cluster status
    • Restarting a cluster
    • Cluster recovery
• 4️⃣ Connecting to the server
  • MySQL protocol
  • HTTP
  • SQL over HTTP
• ⪢ Data creation and modification
  • [⪢ Adding documents to a table]
    • ✔ Adding documents to a real-time table
    • Adding rules to a percolate table
  • [⪢ Adding data from external storages]
    • Plain tables creation
    • [⪢ Fetching from databases]
      • Introduction
      • Database connection
      • Execution of fetch queries
      • Processing fetched data
      • Ranged queries
    • Fetching from XML stream
    • • Fetching from CSV,TSV
    • • Main+delta schema
    • [⪢ Adding data from tables]
      • • Merging tables
      • • Killlists in plain tables
      • • Attaching a plain table to RT table
      • • Importing RT table
    • • Rotating a table
  • [⪢ Updating documents]
    • • REPLACE vs UPDATE
    • • REPLACE
    • • UPDATE
  • • Deleting documents
  • • Transactions
• [5️⃣ Searching]
  • • Intro
  • [⪢ Full-text matching]
    • • Basic usage
    • • Operators
    • • Escaping
    • • Search profiling
    • • Boolean optimization
  • • Search results
  • • Filters
  • • Expressions
  • • Search options
  • • Highlighting
  • • Sorting and ranking
  • • Pagination
  • • Distributed searching
  • • Multi-queries
  • • Sub-selects
  • • Grouping
  • • Faceted search
  • • Geo search
  • • Percolate query
  • • Autocomplete
  • • Spell correction
  • • Query cache
  • • Collations
  • • Cost-based optimizer
  • • K-nearest neighbor vector search
• • Updating table schema and settings
• ⪢ Functions
  • • Mathematical functions
  • • Searching and ranking functions
  • • Type casting functions
  • • Functions to handle arrays and conditions
  • • Date and time functions
  • • Geo-spatial functions
  • • String functions
  • • Other functions
• [⪢ Securing and compacting a table]
  • • Backup and restore
  • • Few words about RT table structure
  • • Flushing RAM chunk to a new disk chunk
  • • Flushing RT table to disk
  • • Compacting a table
  • • Isolation during flushing and merging
  • • Freezing a table
  • • Flushing attributes
  • • Flushing hostnames
• [⪢ Security]
  • • SSL
  • • Read-only
• [⪢ Logging]
  • • Query logging
  • • Server logging
  • • Binary logging
  • • Docker logging
  • • Rotating query and server logs
• [⪢ Node info and management]
  • • Node status
  • • SHOW META
  • • SHOW THREADS
  • • SHOW QUERIES
  • • SHOW VERSION
  • • KILL
  • • SHOW WARNINGS
  • • SHOW VARIABLES
  • [⪢ Profiling]
    • • Query profiling
    • • Query plan
  • [⪢ Table settings and status]
    • • SHOW TABLE STATUS
    • • SHOW TABLE SETTINGS
• [⪢ Server settings]
  • • Searchd
  • • Common
  • • Special suffixes
  • • Scripted configuration
  • • Comments
  • • Inheritance of table and source declarations
  • • Setting variables online
• [⪢ Integration]
  • Logstash
  • Filebeat
• [⪢ Extensions]
  • SphinxSE
  • FEDERATED
  • ⪢ UDFs and Plugins
    • Listing plugins
    • ⪢ UDF
      • Creating a function
      • Deleting a function
    • [⪢ Plugins]
      • • Creating a plugin
      • • Deleting a plugin
      • • Reloading plugins
      • • Ranker plugins
      • • Token filter plugins
• • Miscellaneous tools
• • OpenAPI specification
• • Telemetry
• • Changelog
• 🐞 Reporting bugs
• 📖 References
  • • Previous versions