Skip to content

Commit 38ac608

Browse files
committed
add documentation for get api, update main README adding scroll api
1 parent 48238f6 commit 38ac608

File tree

5 files changed

+1927
-6
lines changed

5 files changed

+1927
-6
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@
1111
## Key Features
1212

1313
**Unified Elasticsearch API**
14-
This project provides a trait-based interface (`ElasticClientApi`) that aggregates the core functionalities of Elasticsearch: indexing, searching, scrolling, updating, deleting, mapping, aliases, refreshing, and [more](documentation/client/README.md). This design abstracts the underlying client implementation and ensures compatibility across different Elasticsearch versions.
14+
This project provides a trait-based interface (`ElasticClientApi`) that aggregates the core functionalities of Elasticsearch: [indexing](documentation/client/index.md), [updating](documentation/client/update.md), [deleting](documentation/client/delete.md), [bulk](documentation/client/bulk.md), [searching](documentation/client/search.md), [scrolling](documentation/client/scroll.md), [mapping](documentation/client/mappings.md), [aliases](documentation/client/aliases.md), [refreshing](documentation/client/refresh.md), and [more](documentation/client/README.md).
15+
This design abstracts the underlying client implementation and ensures compatibility across different Elasticsearch versions.
1516

16-
- `JestClientApi`: For Elasticsearch 6 using the open-source [Jest client](https://github.com/searchbox-io/Jest).
17+
- `JavaClientApi`: For Elasticsearch 8 and 9 using the official Java client.
1718
- `RestHighLevelClientApi`: For Elasticsearch 6 and 7 using the official high-level REST client.
18-
- `ElasticsearchClientApi`: For Elasticsearch 8 and 9 using the official Java client.
19+
- `JestClientApi`: For Elasticsearch 6 using the open-source [Jest client](https://github.com/searchbox-io/Jest).
1920

2021
By relying on these concrete implementations, developers can switch between versions with minimal changes to their business logic.
2122

@@ -28,12 +29,16 @@ Elastic Client provides tools to analyze and compare existing mappings with new
2829
**High-Performance Bulk API with Akka Streams**
2930
Bulk operations leverage the power of Akka Streams to efficiently process and index large volumes of data. This stream-based approach improves performance, resilience, and backpressure handling, especially for real-time or high-throughput indexing scenarios.
3031

32+
**Scroll API with automatic Scroll Strategy detection**
33+
The Scroll API is also integrated with Akka Streams, enabling efficient retrieval of large datasets in a streaming fashion. This allows applications to process search results incrementally, reducing memory consumption and improving responsiveness.
34+
It automatically selects the optimal scrolling strategy (PIT + search_after, search_after, or classic scroll) based on your query and Elasticsearch version.
35+
3136
**Akka Persistence Integration**
3237
The project offers seamless integration with Akka Persistence. This enables Elasticsearch indices to be updated reactively based on persistent events, offering a robust pattern for event-sourced systems.
3338

3439
## Roadmap
3540

36-
Future enhancements include expanding the SQL parser to support additional operations such as `INSERT`, `UPDATE`, and `DELETE`. The long-term vision is to deliver a fully functional, open-source **JDBC connector for Elasticsearch**, empowering users to interact with their data using standard SQL tooling.
41+
Future enhancements include expanding the SQL parser to support additional operations such as `CREATE`, `ALTER`, `INSERT`, `UPDATE`, and `DELETE`. The long-term vision is to deliver a fully functional, open-source **JDBC connector for Elasticsearch**, empowering users to interact with their data using standard SQL tooling.
3742

3843
## License
3944

documentation/client/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Welcome to the Client Engine Documentation. Navigate through the sections below:
1414
- [Update Documents](update.md)
1515
- [Delete Documents](delete.md)
1616
- [Bulk Operations](bulk.md)
17+
- [Get Documents](get.md)
1718
- [Search Documents](search.md)
1819
- [Scroll Search](scroll.md)
1920
- [Aggregations](aggregations.md)

documentation/client/bulk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1563,4 +1563,4 @@ client.bulkWithResult(
15631563

15641564
---
15651565

1566-
[Back to index](README.md) | [Next: Search Documents](search.md)
1566+
[Back to index](README.md) | [Next: Get Documents](get.md)

0 commit comments

Comments
 (0)