org.tikv.kvproto

Class Kvrpcpb.PessimisticLockRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tikv.kvproto.Kvrpcpb.PessimisticLockRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Kvrpcpb.PessimisticLockRequestOrBuilder

Enclosing class:

Kvrpcpb

public static final class Kvrpcpb.PessimisticLockRequest
extends com.google.protobuf.GeneratedMessageV3
implements Kvrpcpb.PessimisticLockRequestOrBuilder

 Lock a set of keys to prepare to write to them.
 

Protobuf type kvrpcpb.PessimisticLockRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Kvrpcpb.PessimisticLockRequest.Builder Lock a set of keys to prepare to write to them.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHECK_EXISTENCE_FIELD_NUMBER
static int	CONTEXT_FIELD_NUMBER
static int	FOR_UPDATE_TS_FIELD_NUMBER
static int	FORCE_FIELD_NUMBER
static int	IS_FIRST_LOCK_FIELD_NUMBER
static int	LOCK_TTL_FIELD_NUMBER
static int	MIN_COMMIT_TS_FIELD_NUMBER
static int	MUTATIONS_FIELD_NUMBER
static int	PRIMARY_LOCK_FIELD_NUMBER
static int	RETURN_VALUES_FIELD_NUMBER
static int	START_VERSION_FIELD_NUMBER
static int	WAIT_TIMEOUT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getCheckExistence() If set to true, it means TiKV need to check if the key exists, and return the result in the `not_founds` feild in the response.
Kvrpcpb.Context	getContext() .kvrpcpb.Context context = 1;
Kvrpcpb.ContextOrBuilder	getContextOrBuilder() .kvrpcpb.Context context = 1;
static Kvrpcpb.PessimisticLockRequest	getDefaultInstance()
Kvrpcpb.PessimisticLockRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getForce() Deprecated.
long	getForUpdateTs() Each locking command in a pessimistic transaction has its own timestamp.
boolean	getIsFirstLock() If the request is the first lock request, we don't need to detect deadlock.
long	getLockTtl() uint64 lock_ttl = 5;
long	getMinCommitTs() If min_commit_ts > 0, this is large transaction proto, the final commit_ts would be infered from min_commit_ts.
Kvrpcpb.Mutation	getMutations(int index) In this case every `Op` of the mutations must be `PessimisticLock`.
int	getMutationsCount() In this case every `Op` of the mutations must be `PessimisticLock`.
List<Kvrpcpb.Mutation>	getMutationsList() In this case every `Op` of the mutations must be `PessimisticLock`.
Kvrpcpb.MutationOrBuilder	getMutationsOrBuilder(int index) In this case every `Op` of the mutations must be `PessimisticLock`.
List<? extends Kvrpcpb.MutationOrBuilder>	getMutationsOrBuilderList() In this case every `Op` of the mutations must be `PessimisticLock`.
com.google.protobuf.Parser<Kvrpcpb.PessimisticLockRequest>	getParserForType()
com.google.protobuf.ByteString	getPrimaryLock() bytes primary_lock = 3;
boolean	getReturnValues() If it is true, TiKV will return values of the keys if no error, so TiDB can cache the values for later read in the same transaction.
int	getSerializedSize()
long	getStartVersion() uint64 start_version = 4;
com.google.protobuf.UnknownFieldSet	getUnknownFields()
long	getWaitTimeout() Time to wait for lock released in milliseconds when encountering locks.
boolean	hasContext() .kvrpcpb.Context context = 1;
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Kvrpcpb.PessimisticLockRequest.Builder	newBuilder()
static Kvrpcpb.PessimisticLockRequest.Builder	newBuilder(Kvrpcpb.PessimisticLockRequest prototype)
Kvrpcpb.PessimisticLockRequest.Builder	newBuilderForType()
protected Kvrpcpb.PessimisticLockRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Kvrpcpb.PessimisticLockRequest	parseDelimitedFrom(InputStream input)
static Kvrpcpb.PessimisticLockRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.PessimisticLockRequest	parseFrom(byte[] data)
static Kvrpcpb.PessimisticLockRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.PessimisticLockRequest	parseFrom(ByteBuffer data)
static Kvrpcpb.PessimisticLockRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.PessimisticLockRequest	parseFrom(com.google.protobuf.ByteString data)
static Kvrpcpb.PessimisticLockRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.PessimisticLockRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static Kvrpcpb.PessimisticLockRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.PessimisticLockRequest	parseFrom(InputStream input)
static Kvrpcpb.PessimisticLockRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Kvrpcpb.PessimisticLockRequest>	parser()
Kvrpcpb.PessimisticLockRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER

See Also:

Constant Field Values

MUTATIONS_FIELD_NUMBER

public static final int MUTATIONS_FIELD_NUMBER

See Also:

Constant Field Values

PRIMARY_LOCK_FIELD_NUMBER

public static final int PRIMARY_LOCK_FIELD_NUMBER

See Also:

Constant Field Values

START_VERSION_FIELD_NUMBER

public static final int START_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

LOCK_TTL_FIELD_NUMBER

public static final int LOCK_TTL_FIELD_NUMBER

See Also:

Constant Field Values

FOR_UPDATE_TS_FIELD_NUMBER

public static final int FOR_UPDATE_TS_FIELD_NUMBER

See Also:

Constant Field Values

IS_FIRST_LOCK_FIELD_NUMBER

public static final int IS_FIRST_LOCK_FIELD_NUMBER

See Also:

Constant Field Values

WAIT_TIMEOUT_FIELD_NUMBER

public static final int WAIT_TIMEOUT_FIELD_NUMBER

See Also:

Constant Field Values

FORCE_FIELD_NUMBER

public static final int FORCE_FIELD_NUMBER

See Also:

Constant Field Values

RETURN_VALUES_FIELD_NUMBER

public static final int RETURN_VALUES_FIELD_NUMBER

See Also:

Constant Field Values

MIN_COMMIT_TS_FIELD_NUMBER

public static final int MIN_COMMIT_TS_FIELD_NUMBER

See Also:

Constant Field Values

CHECK_EXISTENCE_FIELD_NUMBER

public static final int CHECK_EXISTENCE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasContext

public boolean hasContext()

.kvrpcpb.Context context = 1;

Specified by:

hasContext in interface Kvrpcpb.PessimisticLockRequestOrBuilder

Returns:

Whether the context field is set.

getContext

public Kvrpcpb.Context getContext()

.kvrpcpb.Context context = 1;

Specified by:

getContext in interface Kvrpcpb.PessimisticLockRequestOrBuilder

Returns:

The context.

getContextOrBuilder

public Kvrpcpb.ContextOrBuilder getContextOrBuilder()

.kvrpcpb.Context context = 1;

Specified by:

getContextOrBuilder in interface Kvrpcpb.PessimisticLockRequestOrBuilder

getMutationsList

public List<Kvrpcpb.Mutation> getMutationsList()

 In this case every `Op` of the mutations must be `PessimisticLock`.
 

repeated .kvrpcpb.Mutation mutations = 2;

Specified by:

getMutationsList in interface Kvrpcpb.PessimisticLockRequestOrBuilder

getMutationsOrBuilderList

public List<? extends Kvrpcpb.MutationOrBuilder> getMutationsOrBuilderList()

 In this case every `Op` of the mutations must be `PessimisticLock`.
 

repeated .kvrpcpb.Mutation mutations = 2;

Specified by:

getMutationsOrBuilderList in interface Kvrpcpb.PessimisticLockRequestOrBuilder

getMutationsCount

public int getMutationsCount()

 In this case every `Op` of the mutations must be `PessimisticLock`.
 

repeated .kvrpcpb.Mutation mutations = 2;

Specified by:

getMutationsCount in interface Kvrpcpb.PessimisticLockRequestOrBuilder

getMutations

public Kvrpcpb.Mutation getMutations(int index)

 In this case every `Op` of the mutations must be `PessimisticLock`.
 

repeated .kvrpcpb.Mutation mutations = 2;

Specified by:

getMutations in interface Kvrpcpb.PessimisticLockRequestOrBuilder

getMutationsOrBuilder

public Kvrpcpb.MutationOrBuilder getMutationsOrBuilder(int index)

 In this case every `Op` of the mutations must be `PessimisticLock`.
 

repeated .kvrpcpb.Mutation mutations = 2;

Specified by:

getMutationsOrBuilder in interface Kvrpcpb.PessimisticLockRequestOrBuilder

getPrimaryLock

public com.google.protobuf.ByteString getPrimaryLock()

bytes primary_lock = 3;

Specified by:

getPrimaryLock in interface Kvrpcpb.PessimisticLockRequestOrBuilder

Returns:

The primaryLock.

getStartVersion

public long getStartVersion()

uint64 start_version = 4;

Specified by:

getStartVersion in interface Kvrpcpb.PessimisticLockRequestOrBuilder

Returns:

The startVersion.

getLockTtl

public long getLockTtl()

uint64 lock_ttl = 5;

Specified by:

getLockTtl in interface Kvrpcpb.PessimisticLockRequestOrBuilder

Returns:

The lockTtl.

getForUpdateTs

public long getForUpdateTs()

 Each locking command in a pessimistic transaction has its own timestamp. If locking fails, then
 the corresponding SQL statement can be retried with a later timestamp, TiDB does not need to
 retry the whole transaction. The name comes from the `SELECT ... FOR UPDATE` SQL statement which
 is a locking read. Each `SELECT ... FOR UPDATE` in a transaction will be assigned its own
 timestamp.
 

uint64 for_update_ts = 6;

Specified by:

getForUpdateTs in interface Kvrpcpb.PessimisticLockRequestOrBuilder

Returns:

The forUpdateTs.

getIsFirstLock

public boolean getIsFirstLock()

 If the request is the first lock request, we don't need to detect deadlock.
 

bool is_first_lock = 7;

Specified by:

getIsFirstLock in interface Kvrpcpb.PessimisticLockRequestOrBuilder

Returns:

The isFirstLock.

getWaitTimeout

public long getWaitTimeout()

 Time to wait for lock released in milliseconds when encountering locks.
 0 means using default timeout in TiKV. Negative means no wait.
 

int64 wait_timeout = 8;

Specified by:

getWaitTimeout in interface Kvrpcpb.PessimisticLockRequestOrBuilder

Returns:

The waitTimeout.

getForce

@Deprecated
public boolean getForce()

Deprecated.

 If it is true, TiKV will acquire the pessimistic lock regardless of write conflict
 and return the latest value. It's only supported for single mutation.
 

bool force = 9 [deprecated = true];

Specified by:

getForce in interface Kvrpcpb.PessimisticLockRequestOrBuilder

Returns:

The force.

getReturnValues

public boolean getReturnValues()

 If it is true, TiKV will return values of the keys if no error, so TiDB can cache the values for
 later read in the same transaction.
 When 'force' is set to true, this field is ignored.
 

bool return_values = 10;

Specified by:

getReturnValues in interface Kvrpcpb.PessimisticLockRequestOrBuilder

Returns:

The returnValues.

getMinCommitTs

public long getMinCommitTs()

 If min_commit_ts > 0, this is large transaction proto, the final commit_ts
 would be infered from min_commit_ts.
 

uint64 min_commit_ts = 11;

Specified by:

getMinCommitTs in interface Kvrpcpb.PessimisticLockRequestOrBuilder

Returns:

The minCommitTs.

getCheckExistence

public boolean getCheckExistence()

 If set to true, it means TiKV need to check if the key exists, and return the result in
 the `not_founds` feild in the response. This works no matter if `return_values` is set. If
 `return_values` is set, it simply makes no difference; otherwise, the `value` field of the
 repsonse will be empty while the `not_founds` field still indicates the keys' existence.
 

bool check_existence = 12;

Specified by:

getCheckExistence in interface Kvrpcpb.PessimisticLockRequestOrBuilder

Returns:

The checkExistence.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Kvrpcpb.PessimisticLockRequest parseFrom(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.PessimisticLockRequest parseFrom(ByteBuffer data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.PessimisticLockRequest parseFrom(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.PessimisticLockRequest parseFrom(com.google.protobuf.ByteString data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.PessimisticLockRequest parseFrom(byte[] data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.PessimisticLockRequest parseFrom(byte[] data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.PessimisticLockRequest parseFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static Kvrpcpb.PessimisticLockRequest parseFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static Kvrpcpb.PessimisticLockRequest parseDelimitedFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static Kvrpcpb.PessimisticLockRequest parseDelimitedFrom(InputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseFrom

public static Kvrpcpb.PessimisticLockRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static Kvrpcpb.PessimisticLockRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

newBuilderForType

public Kvrpcpb.PessimisticLockRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Kvrpcpb.PessimisticLockRequest.Builder newBuilder()

newBuilder

public static Kvrpcpb.PessimisticLockRequest.Builder newBuilder(Kvrpcpb.PessimisticLockRequest prototype)

toBuilder

public Kvrpcpb.PessimisticLockRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Kvrpcpb.PessimisticLockRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Kvrpcpb.PessimisticLockRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<Kvrpcpb.PessimisticLockRequest> parser()

getParserForType

public com.google.protobuf.Parser<Kvrpcpb.PessimisticLockRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Kvrpcpb.PessimisticLockRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder