Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/honhimw/meilisearch-rest-client
Reactive meilisearch rest client powered by reactor-netty-http
https://github.com/honhimw/meilisearch-rest-client
gson jackson java8 meilisearch project-reactor
Last synced: about 1 month ago
JSON representation
Reactive meilisearch rest client powered by reactor-netty-http
- Host: GitHub
- URL: https://github.com/honhimw/meilisearch-rest-client
- Owner: honhimW
- License: apache-2.0
- Created: 2023-12-31T07:39:48.000Z (12 months ago)
- Default Branch: v1.11
- Last Pushed: 2024-10-29T11:03:03.000Z (about 2 months ago)
- Last Synced: 2024-10-29T12:11:33.958Z (about 2 months ago)
- Topics: gson, jackson, java8, meilisearch, project-reactor
- Language: Java
- Homepage:
- Size: 3.25 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Meilisearch Rest Client
[](https://github.com/honhimW/meilisearch-rest-client?tab=Apache-2.0-1-ov-file#readme)
[](https://central.sonatype.com/artifact/io.github.honhimw/meilisearch-rest-client)
[](https://github.com/honhimW/meilisearch-rest-client/actions)
[](https://app.codecov.io/github/honhimW/meilisearch-rest-client)
---
Doc Repository |
Documentation
[Meilisearch](https://github.com/meilisearch/meilisearch) is a lightning-fast search engine that fits effortlessly into
your apps, websites, and workflow.
> The goal of this library is to provide a `object-oriented`, `semantic`, `reactive`, and `streamlined`
> meilisearch-rest-client, supporting reactivity through reactor-netty-http.
### Version
The version number of this library is named by appending `.X` to the version number in the official documentation.
| Doc's Version | Library's Version |
|---------------|-------------------|
| V1.11(latest) | 1.11.X.X |
| V1.10 | 1.10.X.X |
| V1.9 | 1.9.X.X |
| V1.8 | 1.8.X.X |
| V1.7 | 1.7.X.X |
| V1.6 | 1.6.X.X |
| V1.5 | 1.5.X.X |
### Dependencies
**By default**, this library depends on libraries as fallows:
- reactor-netty-http(required)
- jackson(replaceable by providing implementation of `io.github.honhimw.ms.JsonHandler`)
## Installation
```shell
# build from sources
$ ./gradlew clean build -x test
# publish to maven local
$ ./gradlew publishToMavenLocal
```
```groovy
// Gradle
implementation 'io.github.honhimw:meilisearch-rest-client:1.11.0.0'
```
```xml
io.github.honhimw
meilisearch-rest-client
1.11.0.0
```
**[Copy Snippets here.](https://central.sonatype.com/artifact/io.github.honhimw/meilisearch-rest-client)**
---
## Run Tests
```shell
$ ./gradlew test
```
Create file named `profile-test.properties` under project root directory.
```properties
./meilisearch-rest-client
└── profile-test.properties
meili-search.host=127.0.0.1
meili-search.port=7700
meili-search.api-key=MASTER_KEY
```
**Note**: You may also set `profiles.active` in gradle.properties for loading different properties file such as:
> profile-alpha.properties: by setting profiles.active=alpha
> profile-beta.properties: by setting profiles.active=beta
---
## Usage
### Searching
```java
public static void reactive() {
JsonHandler jsonHandler = new JacksonJsonHandler();
@Cleanup
ReactiveMSearchClient client = ReactiveMSearchClient.create(builder -> builder
.enableSSL(false) // true: https, false: http
.host("{{meilisearch-server-host}}") // server host
.port(7700) // server port
.jsonHandler(jsonHandler)
.httpClient(ReactiveHttpUtils.getInstance(http -> http.readTimeout(Duration.ofMillis(100)))));
String indexUid = "movies";
Mono> searchResponse = client.indexes(indexes -> indexes
.search(indexUid, search -> search
.find("hello world", Movie.class)));
List hits = searchResponse.block().getHits();
// or
List hits2 = client.indexes(indexes -> indexes
.search(indexUid, Movie.class, search -> search
.find(q -> q
.q("hello world")
.limit(1)
)
.map(SearchResponse::getHits)
)
).block();
}
public static void blocking() {
JsonHandler jsonHandler = new JacksonJsonHandler();
@Cleanup
MSearchClient client = MSearchClient.create(builder -> builder
.enableSSL(false) // true: https, false: http
.host("{{meilisearch-server-host}}") // server host
.port(7700) // server port
.jsonHandler(jsonHandler)
.httpClient(ReactiveHttpUtils.getInstance(http -> http.readTimeout(Duration.ofMillis(100)))));
String indexUid = "movies";
SearchResponse searchResponse = client.indexes(indexes -> indexes
.search(indexUid, search -> search
.find("hello world", Movie.class)));
List hits = searchResponse.getHits();
// or
List hits2 = client.indexes(indexes -> indexes
.search(indexUid, Movie.class, search -> search
.find(q -> q
.q("hello world")
.limit(1)
)
.getHits()
)
);
}
```
### Search With Details API
```java
public static void reactive() {
ReactiveTypedDetailsSearch searcher = client.indexes().searchWithDetails("movies", Movie.class);
searcher.find(builder -> builder
.q("hello world")
.filter("id < 10")
.showRankingScore(true)
)
.map(response -> {
Integer estimatedTotalHits = response.getEstimatedTotalHits();
Long processingTimeMs = response.getProcessingTimeMs();
return response.getHits();
})
.doOnNext(hitDetails -> {
for (HitDetails hitDetail : hitDetails) {
SearchDetails details = hitDetail.getDetails(); // Search Details
Movie source = hitDetail.getSource(); // Source Document
Map formatted = details.get_formatted();
SearchDetails.Geo geo = details.get_geo();
Double rankingScore = details.get_rankingScore();
}
})
.subscribe()
}
public static void blocking() {
TypedDetailsSearch searcher = client.indexes().searchWithDetails("movies", Movie.class);
SearchDetailsResponse response = searcher.find(builder -> builder
.q("hello world")
.filter("id < 10")
.showRankingScore(true)
);
Integer estimatedTotalHits = response.getEstimatedTotalHits();
Long processingTimeMs = response.getProcessingTimeMs();
List> hitDetails = response.getHits();
for (HitDetails hitDetail : hitDetails) {
SearchDetails details = hitDetail.getDetails(); // Search Details
Movie source = hitDetail.getSource(); // Source Document
Map formatted = details.get_formatted();
SearchDetails.Geo geo = details.get_geo();
Double rankingScore = details.get_rankingScore();
}
}
```
### Await On TaskInfo, Only in blocking
```java
public static void blocking() {
TaskInfo saveTask = client.indexes(indexes -> indexes
.documents("movies").save(jsonQuote("{'id':100}")));
TaskView taskView = saveTask.await();
TaskStatus status = taskView.getStatus();
assert status == TaskStatus.SUCCEEDED || status == TaskStatus.FAILED;
}
```