Module org.elasticsearch.server

Package org.elasticsearch.action.update

Class UpdateHelper

java.lang.Object

org.elasticsearch.action.update.UpdateHelper

public class UpdateHelper
extends Object

Helper for translating an update request to an index, delete request or update response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateHelper.ContextFields	Field names used to populate the script context
static class	UpdateHelper.Result

Constructor Summary

Constructors

Constructor	Description
UpdateHelper(ScriptService scriptService)

Method Summary

Modifier and Type	Method	Description
static GetResult	extractGetResult(UpdateRequest request, String concreteIndex, MappingLookup mappingLookup, long seqNo, long primaryTerm, long version, Map<String,Object> source, XContentType sourceContentType, BytesReference sourceAsBytes)	Applies UpdateRequest.fetchSource() to the _source of the updated document to be returned in a update response.
UpdateHelper.Result	prepare(UpdateRequest request, IndexShard indexShard, LongSupplier nowInMillis)	Prepares an update request by converting it into an index or delete request or an update response (no action).
UpdateHelper.Result	prepare(UpdateRequest request, IndexShard indexShard, LongSupplier nowInMillis, String[] gFields)	Prepares an update request by converting it into an index or delete request or an update response (no action).
protected UpdateHelper.Result	prepare(IndexShard indexShard, UpdateRequest request, GetResult getResult, LongSupplier nowInMillis)	Prepares an update request by converting it into an index or delete request or an update response (no action, in the event of a noop).

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateHelper

public UpdateHelper(ScriptService scriptService)

Method Details

prepare

public UpdateHelper.Result prepare(UpdateRequest request,
 IndexShard indexShard,
 LongSupplier nowInMillis)
                            throws IOException

Prepares an update request by converting it into an index or delete request or an update response (no action).

Throws:

IOException

prepare

public UpdateHelper.Result prepare(UpdateRequest request,
 IndexShard indexShard,
 LongSupplier nowInMillis,
 String[] gFields)
                            throws IOException

Prepares an update request by converting it into an index or delete request or an update response (no action).

Throws:

IOException

prepare

protected UpdateHelper.Result prepare(IndexShard indexShard,
 UpdateRequest request,
 GetResult getResult,
 LongSupplier nowInMillis)

Prepares an update request by converting it into an index or delete request or an update response (no action, in the event of a noop).

extractGetResult

public static GetResult extractGetResult(UpdateRequest request,
 String concreteIndex,
 MappingLookup mappingLookup,
 long seqNo,
 long primaryTerm,
 long version,
 Map<String,Object> source,
 XContentType sourceContentType,
 @Nullable
 BytesReference sourceAsBytes)

Applies UpdateRequest.fetchSource() to the _source of the updated document to be returned in a update response. // TODO can we pass a Source here rather than Map, XcontentType and BytesReference?