Log in Get started

Back to Manticoresearch

README

manual/english/README.md

28.6.316.2 KB

Original Source

☝ Introduction
❗ Read this first
1️⃣ Installation
- • Docker
- • RedHat and Centos
- • Debian and Ubuntu
- • MacOS
- • Windows
- • Compiling from sources
- • Manticore Buddy
- • 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
- [≫ NLP and tokenization]
- ≫ Creating a distributed table
  - • Creating a local distributed table
  - • Remote tables
- ⪢ Creating a sharded table
  - • Table sharding: current limitations
• Listing tables
• Deleting a table
• Emptying a table
≫ Creating a cluster
- Adding a new node
- ≫ Remote nodes
  - Load balancing
  - Mirroring
- ≫ Setting up replication
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]
  - Fetching from XML stream
  - • Fetching from CSV,TSV
  - • Main+delta schema
  - [≫ Adding data from tables]
  - • Rotating a table
- [≫ Updating documents]
- • Deleting documents
- • Transactions
[5️⃣ Searching]
- • Intro
- [≫ Full-text matching]
  - • Basic usage
  - • Operators
  - • Escaping
  - • Search profiling
  - • Boolean optimization
- • Search results
- • Filters
- • Joining
- • Expressions
- • Search options
- • Highlighting
- • Sorting and ranking
- • Pagination
- • Distributed searching
- • Multi-queries
- • Sub-selects
- • Grouping
- • Faceted search
- • Geo search
- • Percolate query
- • Autocomplete
- • Spell correction
  - • Fuzzy search
- • Query cache
- • Collations
- • Cost-based optimizer
- • K-nearest neighbor vector search
- • Hybrid search
- • Conversational search
• Updating table schema and settings
- • Updating table schema in RT mode
- • Updating table FT settings in RT mode
- • Renaming a real-time table
- • Updating table FT settings in plain mode
- • Reindexing existing documents after changing FT settings
- • Rebuilding a secondary index
- • Changing a distributed table
[≫ 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 and locking a table
- • Flushing attributes
- • Flushing hostnames
[≫ Security]
- • SSL
- • Authentication and authorization
- • 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]
[≫ Server settings]
- • Searchd
- • Common
- • Special suffixes
- • Scripted configuration
- • Comments
- • Inheritance of table and source declarations
- • Setting variables online
[≫ Integration]
- Logstash
- Filebeat
- Fluent Bit
- Vector.dev
- Grafana
- Kibana
- Opensearch Dashboards
- Kafka
- DBeaver
- Apache Superset
[≫ Extensions]
- SphinxSE
- FEDERATED
- ≫ UDFs and Plugins
• Miscellaneous tools
• OpenAPI specification
• Telemetry
• Changelog
🐞 Reporting bugs
📖 References
- • Previous versions