From e576738762558d8b98ce9494828663f2fdc03dd2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=CC=88rg=20Prante?= Date: Tue, 15 Nov 2016 21:06:04 +0100 Subject: [PATCH] README --- README.adoc | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.adoc b/README.adoc index 9426fc3..b4d8de8 100644 --- a/README.adoc +++ b/README.adoc @@ -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. 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 to connect to. This is useful for unit testing. 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] ---- @@ -35,6 +35,8 @@ A `ClientBuilder` helps to build client instances. For exmaple 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. 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 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. ----