/manticoresearch-python

Official Python client for Manticore Search

Primary LanguagePythonMIT LicenseMIT

manticoresearch

Low-level client for Manticore Search.

Requirements.

Python 2.7 and 3.4+.

Minimum Manticore Search version is > 4.0.2 with HTTP protocol enabled.

Installation & Usage

pip install

Install the manticoresearch package with pip

pip install manticoresearch

Then import the package:

import manticoresearch

Setuptools

Install 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 manticoresearch

Getting Started

Please 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)
    

Documentation

Full documentation is available in docs folder.

Manticore Search server documentation: https://manual.manticoresearch.com.

Documentation for API Endpoints

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

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Manticore Search 4.x.

Author

info@manticoresearch.com