Manticore Search Client
API version: 8.0.0
Build date: 2025-04-01T10:45:30.595251539Z[Etc/UTC]
Building the API client library requires:
To install the API client library to your local Maven repository, simply execute:
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
Refer to the OSSRH Guide for more information.
Add this dependency to your project's POM:
<dependency> <groupId>com.manticoresearch</groupId> <artifactId>manticoresearch</artifactId> <version>8.0.0</version> <scope>compile</scope> </dependency>
Add this dependency to your project's build file:
repositories { mavenCentral() // Needed if the 'manticoresearch' jar has been published to maven central. mavenLocal() // Needed if the 'manticoresearch' jar has been published to the local maven repo. } dependencies { implementation "com.manticoresearch:manticoresearch:8.0.0" }
At first generate the JAR by executing:
Then manually install the following JARs:
target/manticoresearch-8.0.0.jar
target/lib/*.jar
Please follow the installation instruction and execute the following Java code:
import com.manticoresearch.client.*; import com.manticoresearch.client.auth.*; import com.manticoresearch.client.model.*; import com.manticoresearch.client.api.*; public class ApiExample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://127.0.0.1:9308"); IndexApi apiInstance = new IndexApi(defaultClient); String body = "body_example"; // String | # Perform insert and search operations SearchApi searchApi = new SearchApi(client); IndexApi indexApi = new IndexApi(client); try { String tableName = "products"; InsertDocumentRequest indexRequest = new InsertDocumentRequest(); HashMap<String,Object> doc = new HashMap<String,Object>(); indexRequest.index(tableName).id(1L).setDoc(doc); indexApi.insert(indexRequest); Highlight highlight = new Highlight(); List<String> highlightFields = new ArrayList<String>(); highlightFields.add("title"); highlight.setFields(highlightFields); SearchQuery query = new SearchQuery(); query.setQueryString("@title Bag"); SearchRequest searchRequest = new SearchRequest(); searchRequest.index(tableName).query(query).setHighlight(highlight); SearchResponse searchResponse = searchApi.search(searchRequest); System.out.println(searchResponse); } catch (ApiException e) { System.err.println("Exception when calling Api function"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } }Documentation for API Endpoints
All URIs are relative to http://127.0.0.1:9308
Class Method HTTP request Description IndexApi bulk POST /bulk Bulk table operations IndexApi delete POST /delete Delete a document in a table IndexApi insert POST /insert Create a new document in a table IndexApi partialReplace POST /{table}/_update/{id} Partially replaces a document in a table IndexApi replace POST /replace Replace new document in a table IndexApi update POST /update Update a document in a table SearchApi autocomplete POST /autocomplete Performs an autocomplete search on a table SearchApi percolate POST /pq/{table}/search Perform reverse search on a percolate table SearchApi search POST /search Performs a search on a table UtilsApi sql POST /sql Perform SQL requestsAll endpoints do not require authorization. Authentication schemes defined for the API:
It's recommended to create an instance of ApiClient
per thread in a multithreaded environment to avoid any potential issues.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4