org.xbib.elasticsearch.plugin.jdbc.client

Interface Ingest

All Known Implementing Classes:

BaseIngestTransportClient, BulkNodeClient, BulkTransportClient

public interface Ingest

Interface for providing convenient administrative methods for ingesting data into Elasticsearch.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSetting(String key, Boolean value) Create a key/value in the settings
void	addSetting(String key, Integer value) Create a key/value in the settings
void	addSetting(String key, String value) Create a key/value in the settings
Ingest	bulkDelete(org.elasticsearch.action.delete.DeleteRequest deleteRequest) Bulked delete request.
Ingest	bulkIndex(org.elasticsearch.action.index.IndexRequest indexRequest) Bulked index request.
org.elasticsearch.client.Client	client()
Ingest	delete(String index, String type, String id) Delete document
Ingest	deleteIndex(String index) Delete index
Ingest	deleteMapping(String index, String type)
Ingest	flush(String index) Flush the index
Ingest	flushIngest() Flush ingest, move all pending documents to the bulk indexer
Ingest	flushIngestInterval(org.elasticsearch.common.unit.TimeValue flushInterval) Set the flush interval for automatic flushing outstanding ingest requests
List<String>	getConnectedNodes()
Map<String,String>	getMappings()
Metric	getMetric()
org.elasticsearch.common.settings.Settings	getSettings()
org.elasticsearch.common.settings.ImmutableSettings.Builder	getSettingsBuilder()
Throwable	getThrowable() Return last throwable if exists.
boolean	hasThrowable()
Ingest	index(String index, String type, String id, String source) Index document
boolean	isShutdown()
void	mapping(String type, InputStream in)
void	mapping(String type, String mapping)
Ingest	maxActionsPerBulkRequest(int maxActions) Set the maximum number of actions per bulk request
Ingest	maxConcurrentBulkRequests(int maxConcurentBulkRequests) Set the maximum concurent bulk requests
Ingest	maxRequestWait(org.elasticsearch.common.unit.TimeValue timeout) Set request timeout.
Ingest	maxVolumePerBulkRequest(org.elasticsearch.common.unit.ByteSizeValue maxVolume) Set the maximum volume for bulk request before flush
Ingest	newClient(org.elasticsearch.client.Client client)
Ingest	newClient(Map<String,String> settings)
Ingest	newClient(org.elasticsearch.common.settings.Settings settings)
Ingest	newIndex(String index) Create a new index
Ingest	newIndex(String index, org.elasticsearch.common.settings.Settings settings, Map<String,String> mappings)
Ingest	newIndex(String index, String type, InputStream settings, InputStream mappings)
Ingest	putMapping(String index)
Ingest	refresh(String index) Refresh the index.
Ingest	replica(int replica) The number of replica for index creation
void	resume()
void	setSettings(org.elasticsearch.common.settings.Settings settings)
void	setting(InputStream in) Create settings
Ingest	shards(int shards) The number of shards for index creation
void	shutdown() Shutdown the ingesting
Ingest	startBulk(String index) Start bulk mode
Ingest	stopBulk(String index) Stops bulk mode.
void	suspend()
int	updateReplicaLevel(String index, int level) Add replica level.
Ingest	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)
Ingest	waitForResponses(org.elasticsearch.common.unit.TimeValue maxWait) Wait for all outstanding responses

Method Detail

index

Ingest index(String index,
           String type,
           String id,
           String source)

Index document

Parameters:

index - the index

type - the type

id - the id

source - the source

Returns:

this

delete

Ingest delete(String index,
            String type,
            String id)

Delete document

Parameters:

index - the index

type - the type

id - the id

Returns:

this

newClient

Ingest newClient(org.elasticsearch.client.Client client)

newClient

Ingest newClient(org.elasticsearch.common.settings.Settings settings)

newClient

Ingest newClient(Map<String,String> settings)

getConnectedNodes

List<String> getConnectedNodes()

client

org.elasticsearch.client.Client client()

maxActionsPerBulkRequest

Ingest maxActionsPerBulkRequest(int maxActions)

Set the maximum number of actions per bulk request

Parameters:

maxActions - maximum number of bulk actions

Returns:

this ingest

maxConcurrentBulkRequests

Ingest maxConcurrentBulkRequests(int maxConcurentBulkRequests)

Set the maximum concurent bulk requests

Parameters:

maxConcurentBulkRequests - maximum number of concurrent ingest requests

Returns:

this Ingest

maxVolumePerBulkRequest

Ingest maxVolumePerBulkRequest(org.elasticsearch.common.unit.ByteSizeValue maxVolume)

Set the maximum volume for bulk request before flush

Parameters:

maxVolume - maximum volume

Returns:

this ingest

flushIngestInterval

Ingest flushIngestInterval(org.elasticsearch.common.unit.TimeValue flushInterval)

Set the flush interval for automatic flushing outstanding ingest requests

Parameters:

flushInterval - the flush interval, default is 30 seconds

Returns:

this ingest

maxRequestWait

Ingest maxRequestWait(org.elasticsearch.common.unit.TimeValue timeout)

Set request timeout. Default is 60s.

Parameters:

timeout - timeout

Returns:

this ingest

shards

Ingest shards(int shards)

The number of shards for index creation

Parameters:

shards - the number of shards

Returns:

this

replica

Ingest replica(int replica)

The number of replica for index creation

Parameters:

replica - the number of replica

Returns:

this

setSettings

void setSettings(org.elasticsearch.common.settings.Settings settings)

getSettingsBuilder

org.elasticsearch.common.settings.ImmutableSettings.Builder getSettingsBuilder()

getSettings

org.elasticsearch.common.settings.Settings getSettings()

setting

void setting(InputStream in)
             throws IOException

Create settings

Parameters:

in - the input stream with settings

Throws:

IOException

addSetting

void addSetting(String key,
              String value)

Create a key/value in the settings

Parameters:

key - the key

value - the value

addSetting

void addSetting(String key,
              Boolean value)

Create a key/value in the settings

Parameters:

key - the key

value - the value

addSetting

void addSetting(String key,
              Integer value)

Create a key/value in the settings

Parameters:

key - the key

value - the value

mapping

void mapping(String type,
           InputStream in)
             throws IOException

Throws:

IOException

mapping

void mapping(String type,
           String mapping)
             throws IOException

Throws:

IOException

getMappings

Map<String,String> getMappings()

putMapping

Ingest putMapping(String index)

deleteMapping

Ingest deleteMapping(String index,
                   String type)

newIndex

Ingest newIndex(String index)
                throws IOException

Create a new index

Returns:

this ingest

Throws:

IOException

newIndex

Ingest newIndex(String index,
              String type,
              InputStream settings,
              InputStream mappings)
                throws IOException

Throws:

IOException

newIndex

Ingest newIndex(String index,
              org.elasticsearch.common.settings.Settings settings,
              Map<String,String> mappings)
                throws IOException

Throws:

IOException

deleteIndex

Ingest deleteIndex(String index)

Delete index

Returns:

this ingest

startBulk

Ingest startBulk(String index)
                 throws IOException

Start bulk mode

Returns:

this ingest

Throws:

IOException

stopBulk

Ingest stopBulk(String index)
                throws IOException

Stops bulk mode. Enables refresh.

Returns:

this Ingest

Throws:

IOException

bulkIndex

Ingest bulkIndex(org.elasticsearch.action.index.IndexRequest indexRequest)

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

Parameters:

indexRequest - the index request to add

Returns:

this ingest

bulkDelete

Ingest bulkDelete(org.elasticsearch.action.delete.DeleteRequest deleteRequest)

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

Parameters:

deleteRequest - the delete request to add

Returns:

this ingest

flushIngest

Ingest flushIngest()

Flush ingest, move all pending documents to the bulk indexer

Returns:

this

waitForResponses

Ingest waitForResponses(org.elasticsearch.common.unit.TimeValue maxWait)
                        throws InterruptedException

Wait for all outstanding responses

Parameters:

maxWait - maximum wait time

Returns:

this ingest

Throws:

InterruptedException

flush

Ingest flush(String index)

Flush the index

refresh

Ingest refresh(String index)

Refresh the index.

Returns:

this ingest

updateReplicaLevel

int updateReplicaLevel(String index,
                     int level)
                       throws IOException

Add replica level.

Parameters:

level - the replica level

Returns:

number of shards after updating replica level

Throws:

IOException

waitForCluster

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

Wait for cluster being healthy.

Throws:

IOException

waitForRecovery

int waitForRecovery(String index)
                    throws IOException

Wait for index recovery (after replica change)

Returns:

number of shards found

Throws:

IOException

getMetric

Metric getMetric()

hasThrowable

boolean hasThrowable()

getThrowable

Throwable getThrowable()

Return last throwable if exists.

Returns:

last throwable

shutdown

void shutdown()

Shutdown the ingesting

isShutdown

boolean isShutdown()

suspend

void suspend()

resume

void resume()