com.sequoiadb.base.options

Class UpdateOption

java.lang.Object

com.sequoiadb.base.options.UpdateOption

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

UpsertOption

public class UpdateOption
extends Object

The optional parameter of the update operation.

Since:

3.4.5/5.0.3

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLG_UPDATE_KEEP_SHARDINGKEY The sharding key in update rule is not filtered, when executing update or upsert.
static int	FLG_UPDATE_ONE The flag represent whether to update only one matched record or all matched records.

Constructor Summary

Constructors

Constructor and Description
UpdateOption()

Method Summary

Modifier and Type	Method and Description
void	appendFlag(int flag) Appends a new flag to the update option.
Object	clone()
void	eraseFlag(int flag) Erases the specified flag from the update option.
int	getFlag() Gets the flag option.
BSONObject	getHint() Gets the hint option.
UpdateOption	setFlag(int flag) Sets the flag option.
UpdateOption	setHint(BSONObject hint) Sets the hint option, default is null.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FLG_UPDATE_KEEP_SHARDINGKEY

public static final int FLG_UPDATE_KEEP_SHARDINGKEY

The sharding key in update rule is not filtered, when executing update or upsert.

See Also:

Constant Field Values

FLG_UPDATE_ONE

public static final int FLG_UPDATE_ONE

The flag represent whether to update only one matched record or all matched records.

See Also:

Constant Field Values

Constructor Detail

UpdateOption

public UpdateOption()

Method Detail

appendFlag

public void appendFlag(int flag)

Appends a new flag to the update option.

Parameters:

flag - The update flag, the following values:

• FLG_UPDATE_KEEP_SHARDINGKEY
• FLG_UPDATE_ONE

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

eraseFlag

public void eraseFlag(int flag)

Erases the specified flag from the update option.

Parameters:

flag - The update flag, the following values:

• FLG_UPDATE_KEEP_SHARDINGKEY
• FLG_UPDATE_ONE

getFlag

public int getFlag()

Gets the flag option.

Returns:

The value of flag option.

getHint

public BSONObject getHint()

Gets the hint option.

Returns:

A BSONObject of the hint option.

setFlag

public UpdateOption setFlag(int flag)

Sets the flag option.

Parameters:

flag - The update flag, default to be 0, the following values:

• FLG_UPDATE_KEEP_SHARDINGKEY
• FLG_UPDATE_ONE

Returns:

this

setHint

public UpdateOption setHint(BSONObject hint)

Sets the hint option, default is null.

Parameters:

hint - Specified the index used to scan data. e.g. {"":"ageIndex"} means using index "ageIndex" to scan data(index scan); {"":null} means table scan. when hint is null, database automatically match the optimal index to scan data.

Returns:

this

toString

public String toString()

Overrides:

toString in class Object