org.tikv.kvproto

Interface Kvrpcpb.PessimisticLockRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Kvrpcpb.PessimisticLockRequest, Kvrpcpb.PessimisticLockRequest.Builder

Enclosing class:

Kvrpcpb

public static interface Kvrpcpb.PessimisticLockRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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;
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.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.
long	getStartVersion() uint64 start_version = 4;
long	getWaitTimeout() Time to wait for lock released in milliseconds when encountering locks.
boolean	hasContext() .kvrpcpb.Context context = 1;

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasContext

boolean hasContext()

.kvrpcpb.Context context = 1;

Returns:

Whether the context field is set.

getContext

Kvrpcpb.Context getContext()

.kvrpcpb.Context context = 1;

Returns:

The context.

getContextOrBuilder

Kvrpcpb.ContextOrBuilder getContextOrBuilder()

.kvrpcpb.Context context = 1;

getMutationsList

List<Kvrpcpb.Mutation> getMutationsList()

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

repeated .kvrpcpb.Mutation mutations = 2;

getMutations

Kvrpcpb.Mutation getMutations(int index)

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

repeated .kvrpcpb.Mutation mutations = 2;

getMutationsCount

int getMutationsCount()

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

repeated .kvrpcpb.Mutation mutations = 2;

getMutationsOrBuilderList

List<? extends Kvrpcpb.MutationOrBuilder> getMutationsOrBuilderList()

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

repeated .kvrpcpb.Mutation mutations = 2;

getMutationsOrBuilder

Kvrpcpb.MutationOrBuilder getMutationsOrBuilder(int index)

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

repeated .kvrpcpb.Mutation mutations = 2;

getPrimaryLock

com.google.protobuf.ByteString getPrimaryLock()

bytes primary_lock = 3;

Returns:

The primaryLock.

getStartVersion

long getStartVersion()

uint64 start_version = 4;

Returns:

The startVersion.

getLockTtl

long getLockTtl()

uint64 lock_ttl = 5;

Returns:

The lockTtl.

getForUpdateTs

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;

Returns:

The forUpdateTs.

getIsFirstLock

boolean getIsFirstLock()

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

bool is_first_lock = 7;

Returns:

The isFirstLock.

getWaitTimeout

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;

Returns:

The waitTimeout.

getForce

@Deprecated
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];

Returns:

The force.

getReturnValues

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;

Returns:

The returnValues.

getMinCommitTs

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;

Returns:

The minCommitTs.

getCheckExistence

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;

Returns:

The checkExistence.