com.mapr.db

Interface Mutation

All Known Implementing Classes:

MutationImpl

@API.Public
public interface Mutation

APIs to help perform modification of a record based on its key/id.

Method Summary

Methods

Modifier and Type	Method and Description
Mutation	append(org.ojai.FieldPath path, byte[] value)
Mutation	append(org.ojai.FieldPath path, byte[] value, int offset, int len)
Mutation	append(org.ojai.FieldPath path, ByteBuffer value)
Mutation	append(org.ojai.FieldPath path, List<? extends Object> value)
Mutation	append(org.ojai.FieldPath path, String value)
Mutation	append(String path, byte[] value)
Mutation	append(String path, byte[] value, int offset, int len) Appends a given byte array to the existing binary data stored on the server on the given path.
Mutation	append(String path, ByteBuffer value)
Mutation	append(String path, List<? extends Object> value) Appends elements to an existing array.
Mutation	append(String path, String value) Appends elements to an existing string.
Mutation	build()
Mutation	delete(org.ojai.FieldPath path)
Mutation	delete(String path) Deletes the field at the given path.
Mutation	empty() Empties this Mutation object.
Mutation	increment(org.ojai.FieldPath path, BigDecimal inc)
Mutation	increment(org.ojai.FieldPath path, byte inc) Atomically applies an increment to a given field (in dot separated notation) of the given row id.
Mutation	increment(org.ojai.FieldPath path, double inc)
Mutation	increment(org.ojai.FieldPath path, float inc)
Mutation	increment(org.ojai.FieldPath path, int inc)
Mutation	increment(org.ojai.FieldPath path, long inc)
Mutation	increment(org.ojai.FieldPath path, short inc)
Mutation	increment(String path, BigDecimal inc)
Mutation	increment(String path, byte inc)
Mutation	increment(String path, double inc)
Mutation	increment(String path, float inc)
Mutation	increment(String path, int inc)
Mutation	increment(String path, long inc)
Mutation	increment(String path, short inc)
Mutation	merge(org.ojai.FieldPath path, org.ojai.Document value)
Mutation	merge(org.ojai.FieldPath path, Map<String,Object> value)
Mutation	merge(String path, org.ojai.Document value) Merges the existing value on the server for the given field path with the new map provided in the input.
Mutation	merge(String path, Map<String,Object> value)
Mutation	set(org.ojai.FieldPath path, BigDecimal bd)
Mutation	set(org.ojai.FieldPath path, boolean b)
Mutation	set(org.ojai.FieldPath path, byte b)
Mutation	set(org.ojai.FieldPath path, ByteBuffer bb)
Mutation	set(org.ojai.FieldPath path, Date d)
Mutation	set(org.ojai.FieldPath path, org.ojai.Document value)
Mutation	set(org.ojai.FieldPath path, double d)
Mutation	set(org.ojai.FieldPath path, float f)
Mutation	set(org.ojai.FieldPath path, int i)
Mutation	set(org.ojai.FieldPath path, org.ojai.types.Interval intv)
Mutation	set(org.ojai.FieldPath path, List<? extends Object> value)
Mutation	set(org.ojai.FieldPath path, long l)
Mutation	set(org.ojai.FieldPath path, Map<String,? extends Object> value)
Mutation	set(org.ojai.FieldPath path, short s)
Mutation	set(org.ojai.FieldPath path, String value)
Mutation	set(org.ojai.FieldPath path, Time t)
Mutation	set(org.ojai.FieldPath path, Timestamp t)
Mutation	set(org.ojai.FieldPath path, org.ojai.Value v)
Mutation	set(String path, BigDecimal bd)
Mutation	set(String path, boolean b)
Mutation	set(String path, byte b)
Mutation	set(String path, ByteBuffer bb)
Mutation	set(String path, Date d)
Mutation	set(String path, org.ojai.Document value)
Mutation	set(String path, double d)
Mutation	set(String path, float f)
Mutation	set(String path, int i)
Mutation	set(String path, org.ojai.types.Interval intv)
Mutation	set(String path, List<? extends Object> value)
Mutation	set(String path, long l)
Mutation	set(String path, Map<String,? extends Object> value)
Mutation	set(String path, short s)
Mutation	set(String path, String value)
Mutation	set(String path, Time t)
Mutation	set(String path, Timestamp t)
Mutation	set(String path, org.ojai.Value v)
Mutation	setNull(org.ojai.FieldPath path)
Mutation	setNull(String path) Sets the value of given field to the specified value.
Mutation	setOrReplace(org.ojai.FieldPath path, BigDecimal bd)
Mutation	setOrReplace(org.ojai.FieldPath path, boolean b)
Mutation	setOrReplace(org.ojai.FieldPath path, byte b)
Mutation	setOrReplace(org.ojai.FieldPath path, ByteBuffer bb)
Mutation	setOrReplace(org.ojai.FieldPath path, Date d)
Mutation	setOrReplace(org.ojai.FieldPath path, org.ojai.Document value)
Mutation	setOrReplace(org.ojai.FieldPath path, double d)
Mutation	setOrReplace(org.ojai.FieldPath path, float f)
Mutation	setOrReplace(org.ojai.FieldPath path, int i)
Mutation	setOrReplace(org.ojai.FieldPath path, org.ojai.types.Interval intv)
Mutation	setOrReplace(org.ojai.FieldPath path, List<? extends Object> value)
Mutation	setOrReplace(org.ojai.FieldPath path, long l)
Mutation	setOrReplace(org.ojai.FieldPath path, Map<String,? extends Object> value)
Mutation	setOrReplace(org.ojai.FieldPath path, short s)
Mutation	setOrReplace(org.ojai.FieldPath path, String value)
Mutation	setOrReplace(org.ojai.FieldPath path, Time t)
Mutation	setOrReplace(org.ojai.FieldPath path, Timestamp t)
Mutation	setOrReplace(org.ojai.FieldPath path, org.ojai.Value v)
Mutation	setOrReplace(String path, BigDecimal bd)
Mutation	setOrReplace(String path, boolean b)
Mutation	setOrReplace(String path, byte b)
Mutation	setOrReplace(String path, ByteBuffer bb)
Mutation	setOrReplace(String path, Date d)
Mutation	setOrReplace(String path, org.ojai.Document value)
Mutation	setOrReplace(String path, double d)
Mutation	setOrReplace(String path, float f)
Mutation	setOrReplace(String path, int i)
Mutation	setOrReplace(String path, org.ojai.types.Interval intv)
Mutation	setOrReplace(String path, List<? extends Object> value)
Mutation	setOrReplace(String path, long l)
Mutation	setOrReplace(String path, Map<String,? extends Object> value)
Mutation	setOrReplace(String path, short s)
Mutation	setOrReplace(String path, String value)
Mutation	setOrReplace(String path, Time t)
Mutation	setOrReplace(String path, Timestamp t)
Mutation	setOrReplace(String path, org.ojai.Value v) Sets or replaces the value of a given field with the new value given in the API.
Mutation	setOrReplaceNull(org.ojai.FieldPath path)
Mutation	setOrReplaceNull(String path)

Method Detail

empty

Mutation empty()

Empties this Mutation object.

setNull

Mutation setNull(String path)

Sets the value of given field to the specified value. If the value of given field name doesn't exist in the existing document on the server then new field will be created. If the value for the given field name exists in the existing document on server and its of the same type as the new value then existing value will be replaced by new value. If the value of given field name exists and it is not same type as the type of newly set value then mutation will fail.

Parameters:

path - path of the field that needs to be updated

Returns:

this Mutation object

setNull

Mutation setNull(org.ojai.FieldPath path)

set

Mutation set(String path,
           org.ojai.Value v)

set

Mutation set(org.ojai.FieldPath path,
           org.ojai.Value v)

set

Mutation set(String path,
           boolean b)

set

Mutation set(org.ojai.FieldPath path,
           boolean b)

set

Mutation set(String path,
           short s)

set

Mutation set(org.ojai.FieldPath path,
           short s)

set

Mutation set(String path,
           byte b)

set

Mutation set(org.ojai.FieldPath path,
           byte b)

set

Mutation set(String path,
           int i)

set

Mutation set(org.ojai.FieldPath path,
           int i)

set

Mutation set(String path,
           long l)

set

Mutation set(org.ojai.FieldPath path,
           long l)

set

Mutation set(String path,
           float f)

set

Mutation set(org.ojai.FieldPath path,
           float f)

set

Mutation set(String path,
           double d)

set

Mutation set(org.ojai.FieldPath path,
           double d)

set

Mutation set(String path,
           String value)

set

Mutation set(org.ojai.FieldPath path,
           String value)

set

Mutation set(String path,
           BigDecimal bd)

set

Mutation set(org.ojai.FieldPath path,
           BigDecimal bd)

set

Mutation set(String path,
           Time t)

set

Mutation set(org.ojai.FieldPath path,
           Time t)

set

Mutation set(String path,
           Timestamp t)

set

Mutation set(org.ojai.FieldPath path,
           Timestamp t)

set

Mutation set(String path,
           Date d)

set

Mutation set(org.ojai.FieldPath path,
           Date d)

set

Mutation set(String path,
           List<? extends Object> value)

set

Mutation set(org.ojai.FieldPath path,
           List<? extends Object> value)

set

Mutation set(String path,
           org.ojai.types.Interval intv)

set

Mutation set(org.ojai.FieldPath path,
           org.ojai.types.Interval intv)

set

Mutation set(String path,
           ByteBuffer bb)

set

Mutation set(org.ojai.FieldPath path,
           ByteBuffer bb)

set

Mutation set(String path,
           Map<String,? extends Object> value)

set

Mutation set(org.ojai.FieldPath path,
           Map<String,? extends Object> value)

set

Mutation set(String path,
           org.ojai.Document value)

set

Mutation set(org.ojai.FieldPath path,
           org.ojai.Document value)

setOrReplace

Mutation setOrReplace(String path,
                    org.ojai.Value v)

Sets or replaces the value of a given field with the new value given in the API. This is a fast API that doesn't require a read on the server to validate the path or type. If any element in the specified field path doesn't exist then that element will be created on the server. Example : Field is "a.b.c" and value is int 10. Suppose the server has only the field "a" of type map, then a setOrReplace of "a.b.c" will create element "b" of type map inside "a". It will also create an element named "c" of type integer inside map "b". If any element specified in the field path is of a different type than the existing field element on the server, it will be deleted and replaced by a new element. Example : Field is "a.b.c" and value is int 10. Suppose on the server, there is a field "a" of type array. This operation will delete "a", create new element "a" of type map, and insert "b.c" in it.

Parameters:

path - path of the field that needs to be updated

Returns:

this Mutation object

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    org.ojai.Value v)

setOrReplaceNull

Mutation setOrReplaceNull(String path)

setOrReplaceNull

Mutation setOrReplaceNull(org.ojai.FieldPath path)

setOrReplace

Mutation setOrReplace(String path,
                    boolean b)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    boolean b)

setOrReplace

Mutation setOrReplace(String path,
                    short s)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    short s)

setOrReplace

Mutation setOrReplace(String path,
                    byte b)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    byte b)

setOrReplace

Mutation setOrReplace(String path,
                    int i)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    int i)

setOrReplace

Mutation setOrReplace(String path,
                    long l)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    long l)

setOrReplace

Mutation setOrReplace(String path,
                    float f)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    float f)

setOrReplace

Mutation setOrReplace(String path,
                    double d)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    double d)

setOrReplace

Mutation setOrReplace(String path,
                    String value)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    String value)

setOrReplace

Mutation setOrReplace(String path,
                    BigDecimal bd)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    BigDecimal bd)

setOrReplace

Mutation setOrReplace(String path,
                    Time t)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    Time t)

setOrReplace

Mutation setOrReplace(String path,
                    Timestamp t)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    Timestamp t)

setOrReplace

Mutation setOrReplace(String path,
                    Date d)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    Date d)

setOrReplace

Mutation setOrReplace(String path,
                    List<? extends Object> value)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    List<? extends Object> value)

setOrReplace

Mutation setOrReplace(String path,
                    org.ojai.types.Interval intv)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    org.ojai.types.Interval intv)

setOrReplace

Mutation setOrReplace(String path,
                    ByteBuffer bb)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    ByteBuffer bb)

setOrReplace

Mutation setOrReplace(String path,
                    Map<String,? extends Object> value)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    Map<String,? extends Object> value)

setOrReplace

Mutation setOrReplace(String path,
                    org.ojai.Document value)

setOrReplace

Mutation setOrReplace(org.ojai.FieldPath path,
                    org.ojai.Document value)

append

Mutation append(String path,
              List<? extends Object> value)

Appends elements to an existing array. If the field doesn't exist on server, it will be created and this operation proceeds. If the field already exists, this operation will validate that the existing field is of the array type. If it is of a different type, then this operation will fail.

append

Mutation append(org.ojai.FieldPath path,
              List<? extends Object> value)

append

Mutation append(String path,
              String value)

Appends elements to an existing string. This operation will first validate on the server that the field specified by the given path exists and is of the string type. If the field doesn't exist or is of a different type, then the operation will fail.

append

Mutation append(org.ojai.FieldPath path,
              String value)

append

Mutation append(String path,
              byte[] value,
              int offset,
              int len)

Appends a given byte array to the existing binary data stored on the server on the given path. This operation will fail if the given field on the server is not of the BINARY type. If the field path specified for append doesn't exist on a server record, then this operation will create a new element at the append path. This new element will be of BINARY type and its value will be as specified in the parameter. This operation will fail if any type of the intermediate path elements specified in the append field path doesn't match the type of the corresponding field in the record stored on server. For example, an operation on field "a.b.c" will fail if, on the server, the record a itself is an array or integer. This operation will perform read-modify-write on the server.

Parameters:

path - field path

value - byte array value

offset - offset in byte array

len - length in byte array

Returns:

this Mutation Object

append

Mutation append(org.ojai.FieldPath path,
              byte[] value,
              int offset,
              int len)

append

Mutation append(String path,
              byte[] value)

append

Mutation append(org.ojai.FieldPath path,
              byte[] value)

append

Mutation append(String path,
              ByteBuffer value)

append

Mutation append(org.ojai.FieldPath path,
              ByteBuffer value)

merge

Mutation merge(String path,
             org.ojai.Document value)

Merges the existing value on the server for the given field path with the new map provided in the input. This operation will first validate that the entry with the given field name exists on the server and is of the MAP type. If the entry is of a type other than MAP, then the operation will fail. If the field path specified for merge doesn't exist in the record on the server, then this operation will create a new element at the given path. This new element will be of the MAP type and its value will be as specified in the parameter. This operation will fail if any type of intermediate path elements specified in the append field path doesn't match the type of the corresponding field in the record stored on the server. For example, an operation on field "a.b.c" will fail if, on the server, record a itself is an array or integer.

Parameters:

path - field path

value - the value to be merged with existing value of a field on the server

Returns:

this record mutation

merge

Mutation merge(org.ojai.FieldPath path,
             org.ojai.Document value)

merge

Mutation merge(String path,
             Map<String,Object> value)

merge

Mutation merge(org.ojai.FieldPath path,
             Map<String,Object> value)

increment

Mutation increment(org.ojai.FieldPath path,
                 byte inc)

Atomically applies an increment to a given field (in dot separated notation) of the given row id. If the field path specified for the incremental change doesn't exist in the server record then this operation will create a new element at the given path. This new element will be of same type as the value specified in the parameter. This operation will fail if the type of any intermediate path elements specified in the append field path doesn't match the type of the corresponding field in the record stored on the server. For example, an operation on field "a.b.c" will fail if, on the server, record a itself is an array or integer. If the field doesn't exist on the server then it will be created with the type of given incremental value. An increment operation can be applied on any of the numeric types of a field, such as byte, short, int, long, float, double, or decimal. The operation will fail if the increment is applied to a field that is of a non-numeric type. The increment operation won't change the type of the existing value stored in the given field for the row. The resultant value of the field will be truncated based on the original type of the field. For example, field 'score' is of type int and contains 60. The increment '5.675', a double, is applied. The resultant value of the field will be 65 (65.675 will be truncated to 65).

Parameters:

path - field name in dot separated notation

inc - increment to apply to a field - can be positive or negative

increment

Mutation increment(String path,
                 byte inc)

increment

Mutation increment(org.ojai.FieldPath path,
                 short inc)

increment

Mutation increment(String path,
                 short inc)

increment

Mutation increment(String path,
                 int inc)

increment

Mutation increment(org.ojai.FieldPath path,
                 int inc)

increment

Mutation increment(org.ojai.FieldPath path,
                 long inc)

increment

Mutation increment(String path,
                 long inc)

increment

Mutation increment(String path,
                 float inc)

increment

Mutation increment(org.ojai.FieldPath path,
                 float inc)

increment

Mutation increment(String path,
                 double inc)

increment

Mutation increment(org.ojai.FieldPath path,
                 double inc)

increment

Mutation increment(String path,
                 BigDecimal inc)

increment

Mutation increment(org.ojai.FieldPath path,
                 BigDecimal inc)

delete

Mutation delete(String path)

Deletes the field at the given path. If the field does not exist, this method silently returns without doing anything. For example, if a delete operation is attempted on a.b.c, and a.b is an array on the server, then a.b.c will not be deleted.

delete

Mutation delete(org.ojai.FieldPath path)

build

Mutation build()