Package io.dingodb.store
Class Store.TxnScanRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.dingodb.store.Store.TxnScanRequest
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Store.TxnScanRequestOrBuilder,Serializable
- Enclosing class:
- Store
public static final class Store.TxnScanRequest
extends com.google.protobuf.GeneratedMessageV3
implements Store.TxnScanRequestOrBuilder
TxnScan fetches values for a range of keys in the transaction with start_ts.Protobuf type
dingodb.pb.store.TxnScanRequest- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classTxnScan fetches values for a range of keys in the transaction with start_ts.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionboolean.dingodb.pb.store.Context context = 2;.dingodb.pb.store.Context context = 2;coprocessorcoprocessorstatic Store.TxnScanRequeststatic final com.google.protobuf.Descriptors.DescriptorbooleanFor compatibility, when scanning forward, the range to scan is [start_key, end_key), where start_key < end_key; and when scanning backward, it scans [end_key, start_key) in descending order, where end_key < start_key.booleanReturn only the keys found by scanning, not their values.intgetLimit()The maximum number of results to return.com.google.protobuf.Parser<Store.TxnScanRequest>getRange()prefix start_key end_key with modeprefix start_key end_key with mode.dingodb.pb.common.RequestInfo request_info = 1;.dingodb.pb.common.RequestInfo request_info = 1;intlongthe start_ts of the get transaction, store will return the value of the key when commit_ts < start_ts.dingodb.pb.stream.StreamRequestMeta stream_meta = 30;.dingodb.pb.stream.StreamRequestMeta stream_meta = 30;boolean.dingodb.pb.store.Context context = 2;booleancoprocessorinthashCode()booleanhasRange()prefix start_key end_key with modeboolean.dingodb.pb.common.RequestInfo request_info = 1;boolean.dingodb.pb.stream.StreamRequestMeta stream_meta = 30;protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic Store.TxnScanRequest.Builderstatic Store.TxnScanRequest.BuildernewBuilder(Store.TxnScanRequest prototype) protected Store.TxnScanRequest.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static Store.TxnScanRequestparseDelimitedFrom(InputStream input) static Store.TxnScanRequestparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Store.TxnScanRequestparseFrom(byte[] data) static Store.TxnScanRequestparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Store.TxnScanRequestparseFrom(com.google.protobuf.ByteString data) static Store.TxnScanRequestparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Store.TxnScanRequestparseFrom(com.google.protobuf.CodedInputStream input) static Store.TxnScanRequestparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Store.TxnScanRequestparseFrom(InputStream input) static Store.TxnScanRequestparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Store.TxnScanRequestparseFrom(ByteBuffer data) static Store.TxnScanRequestparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Store.TxnScanRequest>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
REQUEST_INFO_FIELD_NUMBER
public static final int REQUEST_INFO_FIELD_NUMBER- See Also:
-
CONTEXT_FIELD_NUMBER
public static final int CONTEXT_FIELD_NUMBER- See Also:
-
RANGE_FIELD_NUMBER
public static final int RANGE_FIELD_NUMBER- See Also:
-
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER- See Also:
-
START_TS_FIELD_NUMBER
public static final int START_TS_FIELD_NUMBER- See Also:
-
KEY_ONLY_FIELD_NUMBER
public static final int KEY_ONLY_FIELD_NUMBER- See Also:
-
IS_REVERSE_FIELD_NUMBER
public static final int IS_REVERSE_FIELD_NUMBER- See Also:
-
COPROCESSOR_FIELD_NUMBER
public static final int COPROCESSOR_FIELD_NUMBER- See Also:
-
STREAM_META_FIELD_NUMBER
public static final int STREAM_META_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
hasRequestInfo
public boolean hasRequestInfo().dingodb.pb.common.RequestInfo request_info = 1;- Specified by:
hasRequestInfoin interfaceStore.TxnScanRequestOrBuilder- Returns:
- Whether the requestInfo field is set.
-
getRequestInfo
.dingodb.pb.common.RequestInfo request_info = 1;- Specified by:
getRequestInfoin interfaceStore.TxnScanRequestOrBuilder- Returns:
- The requestInfo.
-
getRequestInfoOrBuilder
.dingodb.pb.common.RequestInfo request_info = 1;- Specified by:
getRequestInfoOrBuilderin interfaceStore.TxnScanRequestOrBuilder
-
hasContext
public boolean hasContext().dingodb.pb.store.Context context = 2;- Specified by:
hasContextin interfaceStore.TxnScanRequestOrBuilder- Returns:
- Whether the context field is set.
-
getContext
.dingodb.pb.store.Context context = 2;- Specified by:
getContextin interfaceStore.TxnScanRequestOrBuilder- Returns:
- The context.
-
getContextOrBuilder
.dingodb.pb.store.Context context = 2;- Specified by:
getContextOrBuilderin interfaceStore.TxnScanRequestOrBuilder
-
hasRange
public boolean hasRange()prefix start_key end_key with mode
.dingodb.pb.common.RangeWithOptions range = 3;- Specified by:
hasRangein interfaceStore.TxnScanRequestOrBuilder- Returns:
- Whether the range field is set.
-
getRange
prefix start_key end_key with mode
.dingodb.pb.common.RangeWithOptions range = 3;- Specified by:
getRangein interfaceStore.TxnScanRequestOrBuilder- Returns:
- The range.
-
getRangeOrBuilder
prefix start_key end_key with mode
.dingodb.pb.common.RangeWithOptions range = 3;- Specified by:
getRangeOrBuilderin interfaceStore.TxnScanRequestOrBuilder
-
getLimit
public int getLimit()The maximum number of results to return.
uint32 limit = 4;- Specified by:
getLimitin interfaceStore.TxnScanRequestOrBuilder- Returns:
- The limit.
-
getStartTs
public long getStartTs()the start_ts of the get transaction, store will return the value of the key when commit_ts < start_ts
int64 start_ts = 5;- Specified by:
getStartTsin interfaceStore.TxnScanRequestOrBuilder- Returns:
- The startTs.
-
getKeyOnly
public boolean getKeyOnly()Return only the keys found by scanning, not their values.
bool key_only = 6;- Specified by:
getKeyOnlyin interfaceStore.TxnScanRequestOrBuilder- Returns:
- The keyOnly.
-
getIsReverse
public boolean getIsReverse()For compatibility, when scanning forward, the range to scan is [start_key, end_key), where start_key < end_key; and when scanning backward, it scans [end_key, start_key) in descending order, where end_key < start_key.
bool is_reverse = 7;- Specified by:
getIsReversein interfaceStore.TxnScanRequestOrBuilder- Returns:
- The isReverse.
-
hasCoprocessor
public boolean hasCoprocessor()coprocessor
.dingodb.pb.common.CoprocessorV2 coprocessor = 20;- Specified by:
hasCoprocessorin interfaceStore.TxnScanRequestOrBuilder- Returns:
- Whether the coprocessor field is set.
-
getCoprocessor
coprocessor
.dingodb.pb.common.CoprocessorV2 coprocessor = 20;- Specified by:
getCoprocessorin interfaceStore.TxnScanRequestOrBuilder- Returns:
- The coprocessor.
-
getCoprocessorOrBuilder
coprocessor
.dingodb.pb.common.CoprocessorV2 coprocessor = 20;- Specified by:
getCoprocessorOrBuilderin interfaceStore.TxnScanRequestOrBuilder
-
hasStreamMeta
public boolean hasStreamMeta().dingodb.pb.stream.StreamRequestMeta stream_meta = 30;- Specified by:
hasStreamMetain interfaceStore.TxnScanRequestOrBuilder- Returns:
- Whether the streamMeta field is set.
-
getStreamMeta
.dingodb.pb.stream.StreamRequestMeta stream_meta = 30;- Specified by:
getStreamMetain interfaceStore.TxnScanRequestOrBuilder- Returns:
- The streamMeta.
-
getStreamMetaOrBuilder
.dingodb.pb.stream.StreamRequestMeta stream_meta = 30;- Specified by:
getStreamMetaOrBuilderin interfaceStore.TxnScanRequestOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Store.TxnScanRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Store.TxnScanRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Store.TxnScanRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Store.TxnScanRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Store.TxnScanRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Store.TxnScanRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Store.TxnScanRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Store.TxnScanRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static Store.TxnScanRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static Store.TxnScanRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Store.TxnScanRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-