You can connect to Manticore Search using the HTTP protocol.
The HTTP protocol is by default available on port 9308.
In the searchd section of the configuration file the HTTP port can be defined with directive listen like this:
searchd {
...
listen = 127.0.0.1:9308:http
...
}There are no special requirements and any HTTP client can be used to connect to Manticore.
All endpoints respond with application/json content type. Most endpoints use JSON payload for requests, however there are some exceptions that use NDJSON or simple URL encoded payload.
There is no user authentication implemented at the moment, so make sure the HTTP interface is not reachable by anyone outside your network. Since Manticore acts like any other web server, you can use a reverse proxy like Nginx to add HTTP auth or caching.
The HTTP protocol also supports SSL encryption.
A separate HTTP interface can be used to perform 'VIP' connections. A connection to this port bypasses the thread pool and always forcibly creates a new dedicated thread. That's useful for managing in case of a severe overload when the server would either stall or not let you connect via a regular port.
searchd {
...
listen = 127.0.0.1:9308:http
listen = 127.0.0.1:9318:http_vip
...
}The HTTP protocol also supports SSL encryption. In this case the connection type used will be https:
searchd {
...
listen = 127.0.0.1:9308:http
listen = 127.0.0.1:9443:https
...
}Performing a quick search is as easy as:
POST /search
-d '{"index":"test","query":{"match":{"title":"keyword"}}}'Endpoint /sql allows running an SQL SELECT query via HTTP JSON interface.
The query payload must be URL encoded, otherwise query statements with = (filtering or setting options) will result in an error.
POST /sql
--data-urlencode "query=select id,subject,author_id from forum where match('@subject php manticore') group by
author_id order by id desc limit 0,5"The response is in JSON format and contains hits information and time of execution. The response shares the same format as json/search endpoint.
{
"took":10
"timed_out": false,
"hits":
{
"total": 2,
"hits":
[
{
"_id": "1",
"_score": 1,
"_source": { "gid": 11 }
},
{
"_id": "2",
"_score": 1,
"_source": { "gid": 12 }
}
]
}
}For comfortable debugging in your browser you can set HTTP parameter mode to raw, and then the rest of the query after 'query=' will be passed inside without any substitutions/url decoding.
POST /sql -d "query=select id,packedfactors() from movies where match('star') option ranker=expr('1')"{"error":"query missing"}POST /sql -d "mode=raw&query=query=select id,packedfactors() from movies where match('star') option ranker=expr('1')"{
"took":0,
"timed_out":false,
"hits":{
"total":72,
"hits":[
{
"_id":"5",
"_score":1,
"_source":{
"packedfactors()":{
"bm25":612,
"bm25a":0.69104159,
"field_mask":32,
"doc_word_count":1,
"fields":[
{
"field":5,
"lcs":1,
"hit_count":1,
"word_count":1,
"tf_idf":0.24835411,
"min_idf":0.24835411,
"max_idf":0.24835411,
"sum_idf":0.24835411,
"min_hit_pos":1,
"min_best_span_pos":1,
"exact_hit":0,
"max_window_hits":1,
"min_gaps":0,
"exact_order":1,
"lccs":1,
"wlccs":0.24835411,
"atc":0.000000
}
],
"words":[
{
"tf":1,
"idf":0.24835411
}
]
}
}
},
...
]
}
}