Manticore Search Documentation Release 3.0.2 The Manticore Search team Apr 01, 2021 Manticore Documentation 1 Introduction 1 2 Gettting Started 5 2.1 Getting started using Docker container.................................5 2.2 Getting Started using official packages................................. 10 2.3 Migrating from Manticore or Sphinx Search 2.x............................ 15 2.4 A guide on configuration file....................................... 17 2.5 A guide on connectivity......................................... 19 2.6 A guide on indexes............................................ 21 2.7 A guide on searching........................................... 24 3 Installation 31 3.1 Installing Manticore packages on Debian and Ubuntu.......................... 31 3.2 Installing Manticore packages on RedHat and CentOS......................... 32 3.3 Installing Manticore on Windows.................................... 33 3.4 Upgrading from Sphinx Search..................................... 34 3.5 Running Manticore Search in a Docker Container............................ 34 3.6 Compiling Manticore from source.................................... 35 3.7 Quick Manticore usage tour....................................... 38 4 Indexing 43 4.1 Indexes.................................................. 43 4.2 Data Types................................................ 47 4.3 Full-text fields.............................................. 49 4.4 Attributes................................................. 49 4.5 MVA (multi-valued attributes)...................................... 50 4.6 Restrictions on the source data...................................... 51 4.7 Charsets, case folding, translation tables, and replacement rules.................... 51 4.8 Data sources............................................... 51 4.9 SQL data sources (MySQL, PostgreSQL)................................ 52 4.10 xmlpipe2 data source........................................... 53 4.11 TSV/CSV data source.......................................... 55 4.12 Live index updates............................................ 55 4.13 Delta index updates........................................... 56 4.14 Index merging.............................................. 57 5 Real-time indexes 59 i 5.1 RT indexes overview........................................... 59 5.2 Known caveats with RT indexes..................................... 61 5.3 RT index internals............................................ 61 5.4 Binary logging.............................................. 62 6 Searching 63 6.1 Matching modes............................................. 63 6.2 Boolean query syntax.......................................... 64 6.3 Escaping characters in search queries.................................. 65 6.4 Extended query syntax.......................................... 65 6.5 Search results ranking.......................................... 69 6.6 Expressions, functions, and operators.................................. 75 6.7 Sorting modes.............................................. 85 6.8 Grouping (clustering) search results................................... 87 6.9 Distributed searching........................................... 88 6.10 Query log formats............................................ 88 6.11 MySQL protocol support and SphinxQL................................ 90 6.12 Multi-queries............................................... 91 6.13 Faceted search.............................................. 92 6.14 Geo Searching.............................................. 97 6.15 Collations................................................. 98 6.16 Query cache............................................... 100 6.17 MySQL storage engine (SphinxSE)................................... 101 6.18 MySQL FEDERATED storage engine support............................. 108 6.19 Percolate query.............................................. 109 7 Extending 115 7.1 UDFs (User Defined Functions)..................................... 115 7.2 Plugins.................................................. 118 7.3 Ranker plugins.............................................. 119 7.4 Token filter plugins............................................ 120 8 Replication 123 8.1 Replication cluster............................................ 124 8.2 Creating a cluster............................................. 124 8.3 Joining a cluster............................................. 124 8.4 Deleting a cluster............................................. 125 8.5 Managing indexes............................................ 125 8.6 Managing nodes............................................. 125 8.7 Write statements............................................. 126 8.8 Cluster status............................................... 126 8.9 Cluster parameters............................................ 127 8.10 Restarting a cluster............................................ 127 8.11 Cluster with diverged nodes....................................... 128 9 Command line tools reference 131 9.1 index_converter command reference............................... 131 9.2 indexer command reference...................................... 132 9.3 indextool command reference.................................... 135 9.4 searchd command reference...................................... 136 9.5 spelldump command reference.................................... 140 9.6 wordbreaker command reference.................................. 141 10 SphinxQL reference 143 10.1 ALTER syntax.............................................. 143 ii 10.2 ATTACH INDEX syntax......................................... 144 10.3 BEGIN, COMMIT, and ROLLBACK syntax.............................. 146 10.4 BEGIN syntax.............................................. 146 10.5 CALL KEYWORDS syntax....................................... 146 10.6 CALL PQ syntax............................................. 147 10.7 CALL QSUGGEST syntax....................................... 150 10.8 CALL SNIPPETS syntax........................................ 151 10.9 CALL SUGGEST syntax........................................ 151 10.10 Comment syntax............................................. 151 10.11 CREATE FUNCTION syntax...................................... 151 10.12 CREATE PLUGIN syntax........................................ 152 10.13 DEBUG syntax.............................................. 152 10.14 DELETE syntax............................................. 153 10.15 DESCRIBE syntax............................................ 154 10.16 Percolate index schemas......................................... 155 10.17 DROP FUNCTION syntax........................................ 155 10.18 DROP PLUGIN syntax......................................... 156 10.19 FLUSH ATTRIBUTES syntax...................................... 156 10.20 FLUSH HOSTNAMES syntax...................................... 156 10.21 FLUSH LOGS syntax.......................................... 156 10.22 FLUSH RAMCHUNK syntax...................................... 157 10.23 FLUSH RTINDEX syntax........................................ 157 10.24 INSERT and REPLACE syntax..................................... 157 10.25 List of SphinxQL reserved keywords.................................. 158 10.26 Multi-statement queries......................................... 159 10.27 OPTIMIZE INDEX syntax........................................ 160 10.28 RELOAD INDEX syntax........................................ 160 10.29 RELOAD INDEXES syntax....................................... 161 10.30 RELOAD PLUGINS syntax....................................... 161 10.31 REPLACE syntax............................................ 161 10.32 ROLLBACK syntax........................................... 161 10.33 SELECT syntax............................................. 162 10.34 SELECT @@system_variable syntax.................................. 169 10.35 SET syntax................................................ 169 10.36 SET TRANSACTION syntax...................................... 171 10.37 SHOW AGENT STATUS........................................ 171 10.38 SHOW CHARACTER SET syntax................................... 173 10.39 SHOW COLLATION syntax....................................... 174 10.40 SHOW DATABASES syntax....................................... 174 10.41 SHOW INDEX SETTINGS syntax................................... 174 10.42 SHOW INDEX STATUS syntax..................................... 174 10.43 SHOW META syntax.......................................... 175 10.44 SHOW PLAN syntax........................................... 176 10.45 SHOW PLUGINS syntax........................................ 177 10.46 SHOW PROFILE syntax......................................... 177 10.47 SHOW STATUS syntax......................................... 179 10.48 SHOW TABLES syntax......................................... 180 10.49 SHOW THREADS syntax........................................ 180 10.50 SHOW VARIABLES syntax....................................... 181 10.51 SHOW WARNINGS syntax....................................... 182 10.52 TRUNCATE RTINDEX syntax..................................... 182 10.53 UPDATE syntax............................................. 182 11 HTTP API reference 185 iii 11.1 /search API................................................ 185 11.2 /sql API.................................................. 186 11.3 /json API................................................. 187 12 API reference 211 12.1 General API functions.........................................