Manticore Java client
❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-java/tree/10.3.0
Manticore Search Client
Requirements
Building the API client library requires:
- Java 1.8+
- Maven/Gradle
Compatibility Table
| manticoresearch-java |
Manticore Search |
Compatibility |
dev |
dev (latest development version) |
✅ Fully Compatible |
| 10.2.0 or newer |
28.6.6 or newer |
✅ Fully Compatible |
| 10.2.0 or newer |
17.5.1 to 28.6.6 |
⚠️ Partially Compatible |
| 10.0.0 to 10.2.0 |
28.6.6 or newer |
⚠️ Partially Compatible |
| 10.0.0 to 10.2.0 |
17.5.1 to 28.6.6 |
✅ Fully Compatible |
| 8.0.0 to 10.0.0 |
17.5.1 to 28.6.6 |
⚠️ Partially Compatible |
| 8.0.0 to 10.0.0 |
9.2.14 to 17.5.1 |
✅ Fully Compatible |
| 6.0.0 to 8.0.0 |
9.2.14 or newer |
⚠️ Partially Compatible |
| 6.0.0 to 8.0.0 |
7.0.0 to 9.2.14 |
✅ Fully Compatible |
| 6.0.0 to 8.0.0 |
2.5.1 to 7.0.0 |
⚠️ Partially Compatible |
| 5.0.0 to 6.0.0 |
6.3.6 to 7.0.0 |
✅ Fully Compatible |
| 5.0.0 to 6.0.0 |
2.5.1 to 6.3.6 |
⚠️ Partially Compatible |
| 3.3.1 to 5.0.0 |
6.2.0 to 6.3.6 |
✅ Fully Compatible |
| 3.3.1 to 5.0.0 |
2.5.1 to 6.2.0 |
⚠️ Partially Compatible |
| 2.0.2 to 3.3.1 |
2.5.1 to 6.2.0 |
✅ Fully Compatible |
Installation
To install the API client library to your local Maven repository, simply execute:
mvn clean install
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deploy
Refer to the OSSRH Guide for more information.
Maven users
Add this dependency to your project's POM:
<dependency>
<groupId>com.manticoresearch</groupId>
<artifactId>manticoresearch-dev</artifactId>
<version>10.3.0</version>
<scope>compile</scope>
</dependency>
Gradle users
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:10.3.0"
}
Others
At first generate the JAR by executing:
mvn clean package
Then manually install the following JARs:
target/manticoresearch-10.3.0.jar
target/lib/*.jar
Getting Started
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");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
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 requests |
| UtilsApi |
token |
POST /token |
Create or rotate a bearer token |
Documentation for Models
Documentation for Authorization
Authentication schemes defined for the API:
basicAuth
- Type: HTTP basic authentication
bearerAuth
- Type: HTTP basic authentication
Recommendation
It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.