Skip to content

Commit 9470c6f

Browse files
committed
Updated documentation and Readme
1 parent e288ae9 commit 9470c6f

File tree

136 files changed

+752
-638
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

136 files changed

+752
-638
lines changed

README.md

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# manticoresearch
22

3-
❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-java/tree/3.3.0
43

54
Manticore Search Client
65

76
- API version: 3.3.0
87

9-
- Build date: 2023-04-19T16:54:33.962336Z[Etc/UTC]
8+
- Build date: 2023-04-21T13:25:16.289613Z[Etc/UTC]
109

11-
Low-level client for Manticore Search.
10+
Сlient for Manticore Search.
1211

1312

1413
For more information, please visit [https://manticoresearch.com/contact-us/](https://manticoresearch.com/contact-us/)
@@ -81,7 +80,7 @@ Then manually install the following JARs:
8180

8281
## Usage
8382

84-
To add a HTTP proxy for the API client, use `ClientConfig`:
83+
To add an HTTP proxy for the API client, use `ClientConfig`:
8584
```java
8685

8786
import org.glassfish.jersey.apache.connector.ApacheConnectorProvider;
@@ -114,8 +113,9 @@ import com.manticoresearch.client.*;
114113
import com.manticoresearch.client.auth.*;
115114
import com.manticoresearch.client.model.*;
116115
import com.manticoresearch.client.api.IndexApi;
116+
import com.manticoresearch.client.api.;
117117

118-
public class IndexApiExample {
118+
public class ApiExample {
119119

120120
public static void main(String[] args) {
121121
ApiClient defaultClient = Configuration.getDefaultApiClient();
@@ -133,6 +133,26 @@ public class IndexApiExample {
133133
System.err.println("Response headers: " + e.getResponseHeaders());
134134
e.printStackTrace();
135135
}
136+
137+
SearchApi searchApi = new SearchApi(client);
138+
try {
139+
// Create SearchRequest
140+
SearchRequest searchRequest = new SearchRequest();
141+
searchRequest.setIndex("test");
142+
QueryFilter queryFilter = new QueryFilter();
143+
queryFilter.setQueryString("Title 1");
144+
searchRequest.setFulltextFilter(queryFilter);
145+
146+
// Perform a search
147+
SearchResponse searchResponse = searchApi.search(searchRequest);
148+
System.out.println( searchResponse.toString() );
149+
} catch (ApiException e) {
150+
System.err.println("Exception when calling SearchApi#search");
151+
System.err.println("Status code: " + e.getCode());
152+
System.err.println("Reason: " + e.getResponseBody());
153+
System.err.println("Response headers: " + e.getResponseHeaders());
154+
e.printStackTrace();
155+
}
136156
}
137157
}
138158

@@ -144,13 +164,13 @@ All URIs are relative to *http://127.0.0.1:9308*
144164

145165
Class | Method | HTTP request | Description
146166
------------ | ------------- | ------------- | -------------
147-
*IndexApi* | [**bulk**](docs/IndexApi.md#bulk) | **POST** /json/bulk | Bulk index operations
148-
*IndexApi* | [**delete**](docs/IndexApi.md#delete) | **POST** /json/delete | Delete a document in an index
149-
*IndexApi* | [**insert**](docs/IndexApi.md#insert) | **POST** /json/insert | Create a new document in an index
150-
*IndexApi* | [**replace**](docs/IndexApi.md#replace) | **POST** /json/replace | Replace new document in an index
151-
*IndexApi* | [**update**](docs/IndexApi.md#update) | **POST** /json/update | Update a document in an index
152-
*SearchApi* | [**percolate**](docs/SearchApi.md#percolate) | **POST** /json/pq/{index}/search | Perform reverse search on a percolate index
153-
*SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /json/search | Performs a search
167+
*IndexApi* | [**bulk**](docs/IndexApi.md#bulk) | **POST** /bulk | Bulk index operations
168+
*IndexApi* | [**delete**](docs/IndexApi.md#delete) | **POST** /delete | Delete a document in an index
169+
*IndexApi* | [**insert**](docs/IndexApi.md#insert) | **POST** /insert | Create a new document in an index
170+
*IndexApi* | [**replace**](docs/IndexApi.md#replace) | **POST** /replace | Replace new document in an index
171+
*IndexApi* | [**update**](docs/IndexApi.md#update) | **POST** /update | Update a document in an index
172+
*SearchApi* | [**percolate**](docs/SearchApi.md#percolate) | **POST** /pq/{index}/search | Perform reverse search on a percolate index
173+
*SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Performs a search on an index
154174
*UtilsApi* | [**sql**](docs/UtilsApi.md#sql) | **POST** /sql | Perform SQL requests
155175

156176

docs/Aggregation.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,8 @@ Query aggregation object
1212
|**field** | **String** | | |
1313
|**size** | **Integer** | | [optional] |
1414

15+
[[Using in search requests]](SearchRequest.md#Aggregation)
16+
17+
1518

1619

docs/BoolFilter.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,8 @@ Boolean attribute filter
1212
|**must** | **List<Object>** | | [optional] |
1313
|**mustNot** | **List<Object>** | | [optional] |
1414

15+
[[Using in search requests]](SearchRequest.md#BoolFilter)
16+
17+
1518

1619

docs/BulkResponse.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ Success bulk response
1313

1414

1515

16+
17+

docs/DeleteDocumentRequest.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ Payload for delete request. Documents can be deleted either one by one by specif
1515

1616

1717

18+
19+

docs/DeleteResponse.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ Success response
1515

1616

1717

18+
19+

docs/EqualsFilter.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,8 @@ Equals attribute filter
1111
|**field** | **String** | | |
1212
|**value** | **Object** | | |
1313

14+
[[Using in search requests]](SearchRequest.md#EqualsFilter)
15+
16+
1417

1518

docs/ErrorResponse.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ Error response
1313

1414

1515

16+
17+

docs/Facet.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,5 @@ Query FACET expression
1414

1515

1616

17+
18+

docs/FilterBoolean.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,5 @@ Query filter
1414

1515

1616

17+
18+

0 commit comments

Comments
 (0)