Born To Simplify Development
What is Easy-Es?
Easy-Es is a powerfully enhanced toolkit of RestHighLevelClient for simplify development. This toolkit provides some efficient, useful, out-of-the-box features for ElasticSearch. By using Easy-Es, you can use MySQL syntax to complete Es queries. Use it can effectively save your development time.
Official website
Links
Features
- Auto configuration on startup
- Out-of-the-box interfaces for operate es
- Powerful and flexible where condition wrapper
- Lambda-style API
- Automatic paging operation
- Support high-level syntax such as highlighting and weighting and Geo etc
- ...
Compare
Demand: Query all documents with title equals "Hi" and author equals "Guy"
// Use Easy-Es to complete the query with only 3 lines of code
LambdaEsQueryWrapper<Document> wrapper = new LambdaEsQueryWrapper<>();
wrapper.eq(Document::getTitle, "Hi").eq(Document::getCreator, "Guy");
List<Document> documents = documentMapper.selectList(wrapper);
// Query with RestHighLevelClient requires 11 lines of code, not including parsing JSON code
String indexName = "document";
SearchRequest searchRequest = new SearchRequest(indexName);
BoolQueryBuilder boolQueryBuilder = QueryBuilders.boolQuery();
TermQueryBuilder titleTerm = QueryBuilders.termQuery("title", "Hi");
TermsQueryBuilder creatorTerm = QueryBuilders.termsQuery("creator", "Guy");
boolQueryBuilder.must(titleTerm);
boolQueryBuilder.must(creatorTerm);
SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();
searchSourceBuilder.query(boolQueryBuilder);
searchRequest.source(searchSourceBuilder);
try {
SearchResponse searchResponse = restHighLevelClient.search(searchRequest, RequestOptions.DEFAULT);
// Then parse the DocumentList from searchResponse in various ways, omitting these codes...
} catch (IOException e) {
e.printStackTrace();
}
The above is just a simple query demonstration. The more complex the actual query scene, the better the effect, which can save 3-5 times the amount of code on average.
Getting started
-
Add Easy-Es dependency
- Latest Version:
- Maven:
<dependency> <groupId>io.github.xpc1024groupId> <artifactId>easy-es-boot-starterartifactId> <version>Latest Versionversion> dependency>
- Gradle
compile group: 'io.github.xpc1024', name: 'easy-es-boot-starter', version: 'Latest Version'
- Latest Version:
-
Add mapper file extends BaseEsMapper interface
public interface DocumentMapper extends BaseMapper<Document> { }
-
Use it
documentList = documentMapper.selectList(); ">LambdaEsQueryWrapper<Document> wrapper = new LambdaEsQueryWrapper<>(); wrapper.eq(Document::getTitle,"Hello World") .eq(Document::getCreator,"Guy"); List<Document> documentList = documentMapper.selectList();
Easy-Es will execute the following Query:
{"query":{"bool":{"must":[{"term":{"title":{"value":"Hello World","boost":1.0}}},{"term":{"creator":{"value":"Guy","boost":1.0}}}],"adjust_pure_negative":true,"boost":1.0}}}The syntax of this query in MySQL is:
SELECT * FROM document WHERE title = 'Hello World' AND creator = 'Guy'
This showcase is just a small part of Easy-Es features. If you want to learn more, please refer to the documentation.
SUPPORT
In the early stage of project promotion, I hope everyone can give a little bit of three links:
Syntax comparison with MySQL
| MySQL | Easy-Es |
|---|---|
| and | and |
| or | or |
| = | eq |
| != | ne |
| > | gt |
| >= | ge |
| < | lt |
| <= | le |
| like '%field%' | like |
| not like '%field%' | notLike |
| like '%field' | likeLeft |
| like 'field%' | likeRight |
| between | between |
| notBetween | notBetween |
| is null | isNull |
| is notNull | isNotNull |
| in | in |
| not in | notIn |
| group by | groupBy |
| order by | orderBy |
| min | min |
| max | max |
| avg | avg |
| sum | sum |
| sum | sum |
| - | orderByAsc |
| - | orderByDesc |
| - | match |
| - | highLight |
| ... | ... |
Donate
License
Easy-Es is under the Apache 2.0 license. See the Apache License 2.0 file for details.
18 Jan 5, 2023
11.1k Dec 31, 2022
976 Jan 9, 2023
413 Jan 5, 2023
300 Dec 4, 2022
69 Dec 17, 2022
2.3k Dec 31, 2022
37 Dec 26, 2022
10 Jun 1, 2021
23 Sep 1, 2022
73 Jan 1, 2023
3 Jan 10, 2022
28 Nov 25, 2022
1 Nov 11, 2021
59 Nov 30, 2022
44 Nov 12, 2022
9 Oct 15, 2022
24.4k Jan 1, 2023
32 Dec 15, 2022