sirius.db.es

Class LowLevelClient

java.lang.Object

sirius.db.es.LowLevelClient

public class LowLevelClient
extends Object

Provides a low-level client against Elasticsearch.

This is mainly used to build and execute HTTP requests and process their response.

Constructor Summary

Constructors

Constructor and Description
LowLevelClient(org.elasticsearch.client.RestClient restClient) Creates a new client based on the given REST client which handle load balancing and connection management.

Method Summary

Modifier and Type	Method and Description
com.alibaba.fastjson.JSONObject	bulk(List<com.alibaba.fastjson.JSONObject> bulkData) Executes a list of bulk statements.
com.alibaba.fastjson.JSONObject	closeScroll(String scrollId) Closes a scroll query.
com.alibaba.fastjson.JSONObject	continueScroll(int ttlSeconds, String scrollId) Continues a scroll query.
com.alibaba.fastjson.JSONObject	count(List<String> indices, String type, String routing, com.alibaba.fastjson.JSONObject query) Determines the number of hits for a given query.
com.alibaba.fastjson.JSONObject	createIndex(String index, int numberOfShards, int numberOfReplicas) Creates the given index.
com.alibaba.fastjson.JSONObject	createScroll(List<String> indices, String type, String routing, int from, int sizePerShard, int ttlSeconds, com.alibaba.fastjson.JSONObject query) Creates a scroll search.
com.alibaba.fastjson.JSONObject	delete(String index, String type, String id, String routing, Integer version) Deletes the given document.
com.alibaba.fastjson.JSONObject	deleteByQuery(List<String> indices, String type, String routing, com.alibaba.fastjson.JSONObject query) Deletes all documents matched by the given query.
com.alibaba.fastjson.JSONObject	exists(List<String> indices, String type, String routing, com.alibaba.fastjson.JSONObject query) Determines if a given query has at least one result.
com.alibaba.fastjson.JSONObject	get(String index, String type, String id, String routing, boolean withSource) Performs a lookup for the given document.
org.elasticsearch.client.RestClient	getRestClient() Returns the underlying REST client.
protected org.apache.http.HttpEntity	handleNotFoundAsResponse(org.elasticsearch.client.ResponseException e)
com.alibaba.fastjson.JSONObject	index(String index, String type, String id, String routing, Integer version, com.alibaba.fastjson.JSONObject data) Tells Elasticsearch to create or update the given document with the given data.
boolean	indexExists(String index) Determines if the given index exists.
sirius.db.es.RequestBuilder	performDelete() Builds a DELETE request.
sirius.db.es.RequestBuilder	performGet() Builds a GET request.
sirius.db.es.RequestBuilder	performPost() Builds a POST request.
sirius.db.es.RequestBuilder	performPut() Builds a PUT request.
com.alibaba.fastjson.JSONObject	putMapping(String index, String type, com.alibaba.fastjson.JSONObject data) Creates the given mapping.
com.alibaba.fastjson.JSONObject	search(List<String> indices, String type, String routing, int from, int size, com.alibaba.fastjson.JSONObject query) Executes a search.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LowLevelClient

public LowLevelClient(org.elasticsearch.client.RestClient restClient)

Creates a new client based on the given REST client which handle load balancing and connection management.

Parameters:

restClient - the underlying REST client to use

Method Detail

getRestClient

public org.elasticsearch.client.RestClient getRestClient()

Returns the underlying REST client.

Returns:

the underlying REST client

performGet

public sirius.db.es.RequestBuilder performGet()

Builds a GET request.

Returns:

a request builder used to execute the request

performPost

public sirius.db.es.RequestBuilder performPost()

Builds a POST request.

Returns:

a request builder used to execute the request

performPut

public sirius.db.es.RequestBuilder performPut()

Builds a PUT request.

Returns:

a request builder used to execute the request

performDelete

public sirius.db.es.RequestBuilder performDelete()

Builds a DELETE request.

Returns:

a request builder used to execute the request

index

public com.alibaba.fastjson.JSONObject index(String index,
                                             String type,
                                             String id,
                                             @Nullable
                                             String routing,
                                             @Nullable
                                             Integer version,
                                             com.alibaba.fastjson.JSONObject data)
                                      throws OptimisticLockException

Tells Elasticsearch to create or update the given document with the given data.

Parameters:

index - the target index

type - the target type

id - the ID to use

routing - the routing to use

version - the version to use for optimistic locking during the update

data - the actual payload to store

Returns:

the response of the call

Throws:

OptimisticLockException - in case of an optimistic locking error (wrong version provided)

get

public com.alibaba.fastjson.JSONObject get(String index,
                                           String type,
                                           String id,
                                           @Nullable
                                           String routing,
                                           boolean withSource)

Performs a lookup for the given document.

Parameters:

index - the index to search in

type - the type to search in

id - the ID to search by

routing - the routing value to use

withSource - true to also load the _source of the document, false otherwise

Returns:

the response of the call

delete

public com.alibaba.fastjson.JSONObject delete(String index,
                                              String type,
                                              String id,
                                              String routing,
                                              Integer version)
                                       throws OptimisticLockException

Deletes the given document.

Parameters:

index - the target index

type - the target type

id - the ID to use

routing - the routing to use

version - the version to use for optimistic locking during the update

Returns:

the response of the call

Throws:

OptimisticLockException - in case of an optimistic locking error (wrong version provided)

handleNotFoundAsResponse

protected org.apache.http.HttpEntity handleNotFoundAsResponse(org.elasticsearch.client.ResponseException e)

deleteByQuery

public com.alibaba.fastjson.JSONObject deleteByQuery(List<String> indices,
                                                     String type,
                                                     @Nullable
                                                     String routing,
                                                     com.alibaba.fastjson.JSONObject query)

Deletes all documents matched by the given query.

Parameters:

indices - the indices to search in

type - the document type to search

routing - the routing to use

query - the query to execute

Returns:

the response of the call

search

public com.alibaba.fastjson.JSONObject search(List<String> indices,
                                              String type,
                                              @Nullable
                                              String routing,
                                              int from,
                                              int size,
                                              com.alibaba.fastjson.JSONObject query)

Executes a search.

Parameters:

indices - the indices to search in

type - the document type to search

routing - the routing to use

from - the number of items to skip

size - the maximal result length

query - the query to execute

Returns:

the response of the call

createScroll

public com.alibaba.fastjson.JSONObject createScroll(List<String> indices,
                                                    String type,
                                                    String routing,
                                                    int from,
                                                    int sizePerShard,
                                                    int ttlSeconds,
                                                    com.alibaba.fastjson.JSONObject query)

Creates a scroll search.

Parameters:

indices - the indices to search in

type - the document type to search

routing - the routing to use

from - the number of items to skip

sizePerShard - the maximal number of results per shard

ttlSeconds - the ttl of the scroll cursor in seconds

query - the query to execute

Returns:

the response of the call

continueScroll

public com.alibaba.fastjson.JSONObject continueScroll(int ttlSeconds,
                                                      String scrollId)

Continues a scroll query.

Parameters:

ttlSeconds - the ttl of the scroll cursor in seconds

scrollId - the id of the scroll cursor

Returns:

the response of the call

closeScroll

public com.alibaba.fastjson.JSONObject closeScroll(String scrollId)

Closes a scroll query.

Parameters:

scrollId - the id of the scroll cursor

Returns:

the response of the call

exists

public com.alibaba.fastjson.JSONObject exists(List<String> indices,
                                              String type,
                                              String routing,
                                              com.alibaba.fastjson.JSONObject query)

Determines if a given query has at least one result.

Parameters:

indices - the indices to search in

type - the document type to search

routing - the routing to use

query - the query to execute

Returns:

the response of the call

count

public com.alibaba.fastjson.JSONObject count(List<String> indices,
                                             String type,
                                             String routing,
                                             com.alibaba.fastjson.JSONObject query)

Determines the number of hits for a given query.

Parameters:

indices - the indices to search in

type - the document type to search

routing - the routing to use

query - the query to execute

Returns:

the response of the call

bulk

public com.alibaba.fastjson.JSONObject bulk(List<com.alibaba.fastjson.JSONObject> bulkData)

Executes a list of bulk statements.

Parameters:

bulkData - the statements to execute.

Returns:

the response of the call

See Also:

BulkContext

createIndex

public com.alibaba.fastjson.JSONObject createIndex(String index,
                                                   int numberOfShards,
                                                   int numberOfReplicas)

Creates the given index.

Parameters:

index - the name of the index

numberOfShards - the number of shards to use

numberOfReplicas - the number of replicas per shard

Returns:

the response of the call

putMapping

public com.alibaba.fastjson.JSONObject putMapping(String index,
                                                  String type,
                                                  com.alibaba.fastjson.JSONObject data)

Creates the given mapping.

Parameters:

index - the name of the index

type - the name of the type

data - the mapping to create

Returns:

the response of the call

indexExists

public boolean indexExists(String index)

Determines if the given index exists.

Parameters:

index - the name of the index

Returns:

true if the index exists, false otherwise