joerg/elx
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README

Browse source
This commit is contained in:
Jörg Prante 2016-11-15 21:06:04 +01:00
parent 4f1ce83167
commit e576738762
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.adoc
View file

@ -13,14 +13,14 @@ The Elasticsearch node client and transport client APIs are unified in a `Client
bulk services and index management under the hood, like index creation, alias managent, and retention policies. bulk services and index management under the hood, like index creation, alias managent, and retention policies.
Two classes `BulkNodeClient` and `BulkTransportClient` combine the client methods with the `BulkProcessor`, Two classes `BulkNodeClient` and `BulkTransportClient` combine the client methods with the `BulkProcessor`,
and still offer the `Client` interface of Elasticsearch by using the `client()` method. provide some logging convenience, and still offer the `Client` interface of Elasticsearch by using the `client()` method.
A `MockTransportClient` implements the `BulkTransportClient` API but does not need a running Elasticsearch node A `MockTransportClient` implements the `BulkTransportClient` API but does not need a running Elasticsearch node
to connect to. This is useful for unit testing. to connect to. This is useful for unit testing.
The client classes are enriched by metrics that can measure document count, size, and speed. The client classes are enriched by metrics that can measure document count, size, and speed.
A `ClientBuilder` helps to build client instances. For exmaple A `ClientBuilder` helps to build client instances. For example
[source,java] [source,java]
---- ----
@ -35,6 +35,8 @@ A `ClientBuilder` helps to build client instances. For exmaple
BulkTransportClient client = clientBuilder.toBulkTransportClient(); BulkTransportClient client = clientBuilder.toBulkTransportClient();
---- ----
For more examples, consult the integration etsts at `src/integration-test/java`.
A re-implemented `BulkProcessor` allows flushing of documents before closing. A re-implemented `BulkProcessor` allows flushing of documents before closing.
Also, a light-weight re-implementation of the `TransportClient` class is provided with the following differences to the original `TransportClient`: Also, a light-weight re-implementation of the `TransportClient` class is provided with the following differences to the original `TransportClient`:
@ -50,7 +52,7 @@ Also, a light-weight re-implementation of the `TransportClient` class is provide
#### Some interesting methods #### Some interesting methods
Here are some methods from the `ClientMethods` API, these are not all methods, but maybe Here are some methods from the `ClientMethods` API, these are not all methods, but maybe
some of which can demonstrate the convencience. some of which can demonstrate the convenience.
Create new index, use settings and mappings from input streams. Create new index, use settings and mappings from input streams.
---- ----