org.xbib.elasticsearch.plugin.jdbc.client.transport

Class BulkTransportClient

java.lang.Object

org.xbib.elasticsearch.plugin.jdbc.client.BaseTransportClient

org.xbib.elasticsearch.plugin.jdbc.client.BaseIngestTransportClient

org.xbib.elasticsearch.plugin.jdbc.client.transport.BulkTransportClient

All Implemented Interfaces:

Ingest

public class BulkTransportClient
extends BaseIngestTransportClient
implements Ingest

Client using the BulkProcessor of Elasticsearch

Field Summary

Fields inherited from class org.xbib.elasticsearch.plugin.jdbc.client.BaseTransportClient

client, configHelper

Constructor Summary

Constructors

Constructor and Description
BulkTransportClient()

Method Summary

Methods

Modifier and Type	Method and Description
BulkTransportClient	bulkDelete(org.elasticsearch.action.delete.DeleteRequest deleteRequest) Bulked delete request.
BulkTransportClient	bulkIndex(org.elasticsearch.action.index.IndexRequest indexRequest) Bulked index request.
org.elasticsearch.client.Client	client()
BulkTransportClient	delete(String index, String type, String id) Delete document
BulkTransportClient	deleteIndex(String index) Delete index
BulkTransportClient	flush(String index) Flush the index
BulkTransportClient	flushIngest() Flush ingest, move all pending documents to the bulk indexer
BulkTransportClient	flushIngestInterval(org.elasticsearch.common.unit.TimeValue flushInterval) Set the flush interval for automatic flushing outstanding ingest requests
Metric	getMetric()
Throwable	getThrowable() Return last throwable if exists.
boolean	hasThrowable()
BulkTransportClient	index(String index, String type, String id, String source) Index document
BulkTransportClient	maxActionsPerBulkRequest(int maxActionsPerBulkRequest) Set the maximum number of actions per bulk request
BulkTransportClient	maxConcurrentBulkRequests(int maxConcurrentBulkRequests) Set the maximum concurent bulk requests
BulkTransportClient	maxRequestWait(org.elasticsearch.common.unit.TimeValue timeout) Set request timeout.
BulkTransportClient	maxVolumePerBulkRequest(org.elasticsearch.common.unit.ByteSizeValue maxVolumePerBulkRequest) Set the maximum volume for bulk request before flush
BulkTransportClient	newClient(org.elasticsearch.client.Client client)
BulkTransportClient	newClient(Map<String,String> settings)
BulkTransportClient	newClient(org.elasticsearch.common.settings.Settings settings)
BulkTransportClient	newIndex(String index) Create a new index
BulkTransportClient	refresh(String index) Refresh the index.
BulkTransportClient	replica(int value) The number of replica for index creation
void	resume()
BulkTransportClient	shards(int value) The number of shards for index creation
void	shutdown() Shutdown the ingesting
BulkTransportClient	startBulk(String index) Start bulk mode
BulkTransportClient	stopBulk(String index) Stops bulk mode.
void	suspend()
int	updateReplicaLevel(String index, int level) Add replica level.
BulkTransportClient	waitForCluster(org.elasticsearch.action.admin.cluster.health.ClusterHealthStatus status, org.elasticsearch.common.unit.TimeValue timeValue) Wait for cluster being healthy.
int	waitForRecovery(String index) Wait for index recovery (after replica change)
BulkTransportClient	waitForResponses(org.elasticsearch.common.unit.TimeValue maxWaitTime) Wait for all outstanding responses

Methods inherited from class org.xbib.elasticsearch.plugin.jdbc.client.BaseIngestTransportClient

deleteMapping, newIndex, newIndex, putMapping

Methods inherited from class org.xbib.elasticsearch.plugin.jdbc.client.BaseTransportClient

addSetting, addSetting, addSetting, connect, createClient, findSettings, getConnectedNodes, getMappings, getSettings, getSettingsBuilder, isShutdown, mapping, mapping, resetSettings, setSettings, setting

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xbib.elasticsearch.plugin.jdbc.client.Ingest

addSetting, addSetting, addSetting, deleteMapping, getConnectedNodes, getMappings, getSettings, getSettingsBuilder, isShutdown, mapping, mapping, newIndex, newIndex, putMapping, setSettings, setting

Constructor Detail

BulkTransportClient

public BulkTransportClient()

Method Detail

maxActionsPerBulkRequest

public BulkTransportClient maxActionsPerBulkRequest(int maxActionsPerBulkRequest)

Description copied from interface: Ingest

Set the maximum number of actions per bulk request

Specified by:

maxActionsPerBulkRequest in interface Ingest

Parameters:

maxActionsPerBulkRequest - maximum number of bulk actions

Returns:

this ingest

maxConcurrentBulkRequests

public BulkTransportClient maxConcurrentBulkRequests(int maxConcurrentBulkRequests)

Description copied from interface: Ingest

Set the maximum concurent bulk requests

Specified by:

maxConcurrentBulkRequests in interface Ingest

Parameters:

maxConcurrentBulkRequests - maximum number of concurrent ingest requests

Returns:

this Ingest

maxVolumePerBulkRequest

public BulkTransportClient maxVolumePerBulkRequest(org.elasticsearch.common.unit.ByteSizeValue maxVolumePerBulkRequest)

Description copied from interface: Ingest

Set the maximum volume for bulk request before flush

Specified by:

maxVolumePerBulkRequest in interface Ingest

Parameters:

maxVolumePerBulkRequest - maximum volume

Returns:

this ingest

maxRequestWait

public BulkTransportClient maxRequestWait(org.elasticsearch.common.unit.TimeValue timeout)

Description copied from interface: Ingest

Set request timeout. Default is 60s.

Specified by:

maxRequestWait in interface Ingest

Parameters:

timeout - timeout

Returns:

this ingest

flushIngestInterval

public BulkTransportClient flushIngestInterval(org.elasticsearch.common.unit.TimeValue flushInterval)

Description copied from interface: Ingest

Set the flush interval for automatic flushing outstanding ingest requests

Specified by:

flushIngestInterval in interface Ingest

Parameters:

flushInterval - the flush interval, default is 30 seconds

Returns:

this ingest

newClient

public BulkTransportClient newClient(org.elasticsearch.client.Client client)

Specified by:

newClient in interface Ingest

newClient

public BulkTransportClient newClient(Map<String,String> settings)

Specified by:

newClient in interface Ingest

newClient

public BulkTransportClient newClient(org.elasticsearch.common.settings.Settings settings)

Specified by:

newClient in interface Ingest

Overrides:

newClient in class BaseIngestTransportClient

client

public org.elasticsearch.client.Client client()

Specified by:

client in interface Ingest

Overrides:

client in class BaseTransportClient

shards

public BulkTransportClient shards(int value)

Description copied from interface: Ingest

The number of shards for index creation

Specified by:

shards in interface Ingest

Overrides:

shards in class BaseIngestTransportClient

Parameters:

value - the number of shards

Returns:

this

replica

public BulkTransportClient replica(int value)

Description copied from interface: Ingest

The number of replica for index creation

Specified by:

replica in interface Ingest

Overrides:

replica in class BaseIngestTransportClient

Parameters:

value - the number of replica

Returns:

this

newIndex

public BulkTransportClient newIndex(String index)

Description copied from interface: Ingest

Create a new index

Specified by:

newIndex in interface Ingest

Overrides:

newIndex in class BaseIngestTransportClient

Returns:

this ingest

deleteIndex

public BulkTransportClient deleteIndex(String index)

Description copied from interface: Ingest

Delete index

Specified by:

deleteIndex in interface Ingest

Overrides:

deleteIndex in class BaseIngestTransportClient

Returns:

this ingest

startBulk

public BulkTransportClient startBulk(String index)
                              throws IOException

Description copied from interface: Ingest

Start bulk mode

Specified by:

startBulk in interface Ingest

Returns:

this ingest

Throws:

IOException

stopBulk

public BulkTransportClient stopBulk(String index)
                             throws IOException

Description copied from interface: Ingest

Stops bulk mode. Enables refresh.

Specified by:

stopBulk in interface Ingest

Returns:

this Ingest

Throws:

IOException

flush

public BulkTransportClient flush(String index)

Description copied from interface: Ingest

Flush the index

Specified by:

flush in interface Ingest

refresh

public BulkTransportClient refresh(String index)

Description copied from interface: Ingest

Refresh the index.

Specified by:

refresh in interface Ingest

Returns:

this ingest

index

public BulkTransportClient index(String index,
                        String type,
                        String id,
                        String source)

Description copied from interface: Ingest

Index document

Specified by:

index in interface Ingest

Parameters:

index - the index

type - the type

id - the id

source - the source

Returns:

this

bulkIndex

public BulkTransportClient bulkIndex(org.elasticsearch.action.index.IndexRequest indexRequest)

Description copied from interface: Ingest

Bulked index request. Each request will be added to a queue for bulking requests. Submitting request will be done when bulk limits are exceeded.

Specified by:

bulkIndex in interface Ingest

Parameters:

indexRequest - the index request to add

Returns:

this ingest

delete

public BulkTransportClient delete(String index,
                         String type,
                         String id)

Description copied from interface: Ingest

Delete document

Specified by:

delete in interface Ingest

Parameters:

index - the index

type - the type

id - the id

Returns:

this

bulkDelete

public BulkTransportClient bulkDelete(org.elasticsearch.action.delete.DeleteRequest deleteRequest)

Description copied from interface: Ingest

Bulked delete request. Each request will be added to a queue for bulking requests. Submitting request will be done when bulk limits are exceeded.

Specified by:

bulkDelete in interface Ingest

Parameters:

deleteRequest - the delete request to add

Returns:

this ingest

flushIngest

public BulkTransportClient flushIngest()

Description copied from interface: Ingest

Flush ingest, move all pending documents to the bulk indexer

Specified by:

flushIngest in interface Ingest

Returns:

this

waitForResponses

public BulkTransportClient waitForResponses(org.elasticsearch.common.unit.TimeValue maxWaitTime)
                                     throws InterruptedException

Description copied from interface: Ingest

Wait for all outstanding responses

Specified by:

waitForResponses in interface Ingest

Parameters:

maxWaitTime - maximum wait time

Returns:

this ingest

Throws:

InterruptedException

waitForCluster

public BulkTransportClient waitForCluster(org.elasticsearch.action.admin.cluster.health.ClusterHealthStatus status,
                                 org.elasticsearch.common.unit.TimeValue timeValue)
                                   throws IOException

Description copied from interface: Ingest

Wait for cluster being healthy.

Specified by:

waitForCluster in interface Ingest

Overrides:

waitForCluster in class BaseIngestTransportClient

Throws:

IOException

waitForRecovery

public int waitForRecovery(String index)
                    throws IOException

Description copied from interface: Ingest

Wait for index recovery (after replica change)

Specified by:

waitForRecovery in interface Ingest

Returns:

number of shards found

Throws:

IOException

updateReplicaLevel

public int updateReplicaLevel(String index,
                     int level)
                       throws IOException

Description copied from interface: Ingest

Add replica level.

Specified by:

updateReplicaLevel in interface Ingest

level - the replica level

Returns:

number of shards after updating replica level

Throws:

IOException

shutdown

public void shutdown()

Description copied from interface: Ingest

Shutdown the ingesting

Specified by:

shutdown in interface Ingest

Overrides:

shutdown in class BaseTransportClient

suspend

public void suspend()

Specified by:

suspend in interface Ingest

resume

public void resume()

Specified by:

resume in interface Ingest

getMetric

public Metric getMetric()

Specified by:

getMetric in interface Ingest

hasThrowable

public boolean hasThrowable()

Specified by:

hasThrowable in interface Ingest

getThrowable

public Throwable getThrowable()

Description copied from interface: Ingest

Return last throwable if exists.

Specified by:

getThrowable in interface Ingest

Returns:

last throwable