Skip to content

Commit 9ce1980

Browse files
committed
update documentation adding client README.md and client common principles
1 parent 04b805b commit 9ce1980

18 files changed

+1090
-35
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
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, updating, deleting, mapping, aliases, refreshing, and more. 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, 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.
1515

1616
- `JestClientApi`: For Elasticsearch 6 using the open-source [Jest client](https://github.com/searchbox-io/Jest).
1717
- `RestHighLevelClientApi`: For Elasticsearch 6 and 7 using the official high-level REST client.
@@ -20,7 +20,7 @@ This project provides a trait-based interface (`ElasticClientApi`) that aggregat
2020
By relying on these concrete implementations, developers can switch between versions with minimal changes to their business logic.
2121

2222
**SQL to Elasticsearch Query Translation**
23-
Elastic Client includes a parser capable of translating SQL `SELECT` queries into Elasticsearch queries. The parser produces an intermediate representation, which is then converted into [Elastic4s](https://github.com/sksamuel/elastic4s) DSL queries and ultimately into native Elasticsearch queries. This allows data engineers and analysts to express queries in familiar [SQL](documentation/README.md) syntax.
23+
Elastic Client includes a parser capable of translating SQL `SELECT` queries into Elasticsearch queries. The parser produces an intermediate representation, which is then converted into [Elastic4s](https://github.com/sksamuel/elastic4s) DSL queries and ultimately into native Elasticsearch queries. This allows data engineers and analysts to express queries in familiar [SQL](documentation/sql/README.md) syntax.
2424

2525
**Dynamic Mapping Migration**
2626
Elastic Client provides tools to analyze and compare existing mappings with new ones. If differences are detected, it can automatically perform safe migrations. This includes creating temporary indices, reindexing, and renaming — all while preserving data integrity. This eliminates the need for manual mapping migrations and reduces downtime.

documentation/client/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Client Engine Documentation
2+
3+
Welcome to the Client Engine Documentation. Navigate through the sections below:
4+
5+
- [Client Common Principles](common_principles.md)
6+
-

0 commit comments

Comments
 (0)