Low-level client for Manticore Search.
❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-python/tree/2.2.0
Python 2.7 and 3.4+.
Minimum Manticore Search version is > 2.5.1 with HTTP protocol enabled.
| Manticore Search | manticoresearch-python | Python |
|---|---|---|
| >= 4.2.1 | 2.0.x | >= 3.4 |
| >= 4.0.2 < 4.2.1 | 1.0.6 | >= 3.4 |
| >= 2.5.1 < 4.0.2 | 1.0.5 | >= 2.7 |
Install the manticoresearch package with pip
pip install manticoresearchThen import the package:
import manticoresearchInstall via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import manticoresearchPlease follow the installation procedure and then run the following:
from __future__ import print_function
import time
import manticoresearch
from manticoresearch import *
from manticoresearch.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://127.0.0.1:9308
# See configuration.py for a list of all supported configuration parameters.
configuration = manticoresearch.Configuration(
host = "http://127.0.0.1:9308"
)
# Enter a context with an instance of the API client
with manticoresearch.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = manticoresearch.IndexApi(api_client)
body = "["'{\"insert\": {\"index\": \"test\", \"id\": 1, \"doc\": {\"title\": \"Title 1\"}}},\\n{\"insert\": {\"index\": \"test\", \"id\": 2, \"doc\": {\"title\": \"Title 2\"}}}'"]" # str |
try:
# Bulk index operations
api_response = api_instance.bulk(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IndexApi->bulk: %s\n" % e)
Full documentation is available in docs folder.
Manticore Search server documentation: https://manual.manticoresearch.com.
All URIs are relative to http://127.0.0.1:9308
| Class | Method | HTTP request | Description |
|---|---|---|---|
| IndexApi | bulk | POST /json/bulk | Bulk index operations |
| IndexApi | delete | POST /json/delete | Delete a document in an index |
| IndexApi | insert | POST /json/insert | Create a new document in an index |
| IndexApi | replace | POST /json/replace | Replace new document in an index |
| IndexApi | update | POST /json/update | Update a document in an index |
| SearchApi | percolate | POST /json/pq/{index}/search | Perform reverse search on a percolate index |
| SearchApi | search | POST /json/search | Performs a search |
| UtilsApi | sql | POST /sql | Perform SQL requests |
- Aggregation
- AttrFilter
- BoolFilter
- BulkResponse
- DeleteDocumentRequest
- DeleteResponse
- EqualsFilter
- ErrorResponse
- Facet
- FilterBoolean
- FilterNumber
- FilterString
- FulltextFilter
- GeoDistanceFilter
- GeoDistanceFilterLocationAnchor
- Highlight
- HighlightField
- InFilter
- InsertDocumentRequest
- MatchFilter
- MatchOp
- MatchOpFilter
- MatchPhraseFilter
- NotFilterBoolean
- NotFilterNumber
- NotFilterString
- Option
- PercolateRequest
- QueryFilter
- RangeFilter
- SearchRequest
- SearchResponse
- SearchResponseHits
- SortMVA
- SortMultiple
- SortOrder
- SourceByRules
- SourceMultiple
- SqlResponse
- SuccessResponse
- UpdateDocumentRequest
- UpdateResponse
All endpoints do not require authorization.