org.tikv.kvproto

Interface Kvrpcpb.PrewriteRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Kvrpcpb.PrewriteRequest, Kvrpcpb.PrewriteRequest.Builder

Enclosing class:

Kvrpcpb

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

Method Summary

Modifier and Type	Method and Description
Kvrpcpb.AssertionLevel	getAssertionLevel() The level of assertion to use on this prewrte request.
int	getAssertionLevelValue() The level of assertion to use on this prewrte request.
Kvrpcpb.Context	getContext() .kvrpcpb.Context context = 1;
Kvrpcpb.ContextOrBuilder	getContextOrBuilder() .kvrpcpb.Context context = 1;
long	getForUpdateTs() For pessimistic transactions only; used to check if a conflict lock is already committed.
boolean	getIsPessimisticLock(int index) For pessimistic transaction, some mutations don't need to be locked, for example, non-unique index key.
int	getIsPessimisticLockCount() For pessimistic transaction, some mutations don't need to be locked, for example, non-unique index key.
List<Boolean>	getIsPessimisticLockList() For pessimistic transaction, some mutations don't need to be locked, for example, non-unique index key.
long	getLockTtl() uint64 lock_ttl = 5;
long	getMaxCommitTs() The max commit ts is reserved for limiting the commit ts of 1PC or async commit, which can be used to avoid inconsistency with schema change.
long	getMinCommitTs() If min_commit_ts > 0, this is a large transaction request, the final commit_ts will be inferred from `min_commit_ts`.
Kvrpcpb.Mutation	getMutations(int index) The data to be written to the database.
int	getMutationsCount() The data to be written to the database.
List<Kvrpcpb.Mutation>	getMutationsList() The data to be written to the database.
Kvrpcpb.MutationOrBuilder	getMutationsOrBuilder(int index) The data to be written to the database.
List<? extends Kvrpcpb.MutationOrBuilder>	getMutationsOrBuilderList() The data to be written to the database.
com.google.protobuf.ByteString	getPrimaryLock() The client picks one key to be primary (unrelated to the primary key concept in SQL).
com.google.protobuf.ByteString	getSecondaries(int index) repeated bytes secondaries = 12;
int	getSecondariesCount() repeated bytes secondaries = 12;
List<com.google.protobuf.ByteString>	getSecondariesList() repeated bytes secondaries = 12;
boolean	getSkipConstraintCheck() TiKV can skip some checks, used for speeding up data migration.
long	getStartVersion() Identifies the transaction being written.
boolean	getTryOnePc() When the transaction involves only one region, it's possible to commit the transaction directly with 1PC protocol.
long	getTxnSize() How many keys this transaction involves in this region.
boolean	getUseAsyncCommit() When async commit is enabled, `secondaries` should be set as the key list of all secondary locks if the request prewrites the primary lock.
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()

 The data to be written to the database.
 

repeated .kvrpcpb.Mutation mutations = 2;

getMutations

Kvrpcpb.Mutation getMutations(int index)

 The data to be written to the database.
 

repeated .kvrpcpb.Mutation mutations = 2;

getMutationsCount

int getMutationsCount()

 The data to be written to the database.
 

repeated .kvrpcpb.Mutation mutations = 2;

getMutationsOrBuilderList

List<? extends Kvrpcpb.MutationOrBuilder> getMutationsOrBuilderList()

 The data to be written to the database.
 

repeated .kvrpcpb.Mutation mutations = 2;

getMutationsOrBuilder

Kvrpcpb.MutationOrBuilder getMutationsOrBuilder(int index)

 The data to be written to the database.
 

repeated .kvrpcpb.Mutation mutations = 2;

getPrimaryLock

com.google.protobuf.ByteString getPrimaryLock()

 The client picks one key to be primary (unrelated to the primary key concept in SQL). This
 key's lock is the source of truth for the state of a transaction. All other locks due to a
 transaction will point to the primary lock.
 

bytes primary_lock = 3;

Returns:

The primaryLock.

getStartVersion

long getStartVersion()

 Identifies the transaction being written.
 

uint64 start_version = 4;

Returns:

The startVersion.

getLockTtl

long getLockTtl()

uint64 lock_ttl = 5;

Returns:

The lockTtl.

getSkipConstraintCheck

boolean getSkipConstraintCheck()

 TiKV can skip some checks, used for speeding up data migration.
 

bool skip_constraint_check = 6;

Returns:

The skipConstraintCheck.

getIsPessimisticLockList

List<Boolean> getIsPessimisticLockList()

 For pessimistic transaction, some mutations don't need to be locked, for example, non-unique index key.
 

repeated bool is_pessimistic_lock = 7;

Returns:

A list containing the isPessimisticLock.

getIsPessimisticLockCount

int getIsPessimisticLockCount()

 For pessimistic transaction, some mutations don't need to be locked, for example, non-unique index key.
 

repeated bool is_pessimistic_lock = 7;

Returns:

The count of isPessimisticLock.

getIsPessimisticLock

boolean getIsPessimisticLock(int index)

 For pessimistic transaction, some mutations don't need to be locked, for example, non-unique index key.
 

repeated bool is_pessimistic_lock = 7;

Parameters:

index - The index of the element to return.

Returns:

The isPessimisticLock at the given index.

getTxnSize

long getTxnSize()

 How many keys this transaction involves in this region.
 

uint64 txn_size = 8;

Returns:

The txnSize.

getForUpdateTs

long getForUpdateTs()

 For pessimistic transactions only; used to check if a conflict lock is already committed.
 

uint64 for_update_ts = 9;

Returns:

The forUpdateTs.

getMinCommitTs

long getMinCommitTs()

 If min_commit_ts > 0, this is a large transaction request, the final commit_ts
 will be inferred from `min_commit_ts`.
 

uint64 min_commit_ts = 10;

Returns:

The minCommitTs.

getUseAsyncCommit

boolean getUseAsyncCommit()

 When async commit is enabled, `secondaries` should be set as the key list of all secondary
 locks if the request prewrites the primary lock.
 

bool use_async_commit = 11;

Returns:

The useAsyncCommit.

getSecondariesList

List<com.google.protobuf.ByteString> getSecondariesList()

repeated bytes secondaries = 12;

Returns:

A list containing the secondaries.

getSecondariesCount

int getSecondariesCount()

repeated bytes secondaries = 12;

Returns:

The count of secondaries.

getSecondaries

com.google.protobuf.ByteString getSecondaries(int index)

repeated bytes secondaries = 12;

Parameters:

index - The index of the element to return.

Returns:

The secondaries at the given index.

getTryOnePc

boolean getTryOnePc()

 When the transaction involves only one region, it's possible to commit the transaction
 directly with 1PC protocol.
 

bool try_one_pc = 13;

Returns:

The tryOnePc.

getMaxCommitTs

long getMaxCommitTs()

 The max commit ts is reserved for limiting the commit ts of 1PC or async commit, which can be used to avoid
 inconsistency with schema change.
 

uint64 max_commit_ts = 14;

Returns:

The maxCommitTs.

getAssertionLevelValue

int getAssertionLevelValue()

 The level of assertion to use on this prewrte request.
 

.kvrpcpb.AssertionLevel assertion_level = 15;

Returns:

The enum numeric value on the wire for assertionLevel.

getAssertionLevel

Kvrpcpb.AssertionLevel getAssertionLevel()

 The level of assertion to use on this prewrte request.
 

.kvrpcpb.AssertionLevel assertion_level = 15;

Returns:

The assertionLevel.