Package io.dingodb.store
Interface Store.TxnScanResponseOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Store.TxnScanResponse,Store.TxnScanResponse.Builder
- Enclosing class:
- Store
public static interface Store.TxnScanResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptiongetDocuments(int index) for document index region, documents is the return value of the scan requestintfor document index region, documents is the return value of the scan requestfor document index region, documents is the return value of the scan requestgetDocumentsOrBuilder(int index) for document index region, documents is the return value of the scan requestList<? extends Common.DocumentWithIdOrBuilder>for document index region, documents is the return value of the scan requestcom.google.protobuf.ByteStringthe last iteratered key of this scan response.getError()error codeerror codebooleanif scan is not finished, has_more is true, otherwise falsegetKvs(int index) for store table/index region, kvs is the return value of the scan requestintfor store table/index region, kvs is the return value of the scan requestfor store table/index region, kvs is the return value of the scan requestgetKvsOrBuilder(int index) for store table/index region, kvs is the return value of the scan requestList<? extends Common.KeyValueOrBuilder>for store table/index region, kvs is the return value of the scan requestresponse inforesponse info.dingodb.pb.stream.StreamResponseMeta stream_meta = 30;.dingodb.pb.stream.StreamResponseMeta stream_meta = 30;This txn_result exists when some key is locked but we cannot check locks of all keys.This txn_result exists when some key is locked but we cannot check locks of all keys.getVectors(int index) for vector index region, vectors is the return value of the scan requestintfor vector index region, vectors is the return value of the scan requestfor vector index region, vectors is the return value of the scan requestgetVectorsOrBuilder(int index) for vector index region, vectors is the return value of the scan requestList<? extends Common.VectorWithIdOrBuilder>for vector index region, vectors is the return value of the scan requestbooleanhasError()error codebooleanresponse infoboolean.dingodb.pb.stream.StreamResponseMeta stream_meta = 30;booleanThis txn_result exists when some key is locked but we cannot check locks of all keys.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasResponseInfo
boolean hasResponseInfo()response info
.dingodb.pb.common.ResponseInfo response_info = 1;- Returns:
- Whether the responseInfo field is set.
-
getResponseInfo
Common.ResponseInfo getResponseInfo()response info
.dingodb.pb.common.ResponseInfo response_info = 1;- Returns:
- The responseInfo.
-
getResponseInfoOrBuilder
Common.ResponseInfoOrBuilder getResponseInfoOrBuilder()response info
.dingodb.pb.common.ResponseInfo response_info = 1; -
hasError
boolean hasError()error code
.dingodb.pb.error.Error error = 2;- Returns:
- Whether the error field is set.
-
getError
ErrorOuterClass.Error getError()error code
.dingodb.pb.error.Error error = 2;- Returns:
- The error.
-
getErrorOrBuilder
ErrorOuterClass.ErrorOrBuilder getErrorOrBuilder()error code
.dingodb.pb.error.Error error = 2; -
hasTxnResult
boolean hasTxnResult()This txn_result exists when some key is locked but we cannot check locks of all keys. In this case, `kvs` should be empty and the client should redo scanning all the keys after resolving the lock. the txn_result is one of the following: 1. LockInfo: Read conflict with key which is locked by another transaction. 2. otherwise, txn_result is empty
.dingodb.pb.store.TxnResultInfo txn_result = 3;- Returns:
- Whether the txnResult field is set.
-
getTxnResult
Store.TxnResultInfo getTxnResult()This txn_result exists when some key is locked but we cannot check locks of all keys. In this case, `kvs` should be empty and the client should redo scanning all the keys after resolving the lock. the txn_result is one of the following: 1. LockInfo: Read conflict with key which is locked by another transaction. 2. otherwise, txn_result is empty
.dingodb.pb.store.TxnResultInfo txn_result = 3;- Returns:
- The txnResult.
-
getTxnResultOrBuilder
Store.TxnResultInfoOrBuilder getTxnResultOrBuilder()This txn_result exists when some key is locked but we cannot check locks of all keys. In this case, `kvs` should be empty and the client should redo scanning all the keys after resolving the lock. the txn_result is one of the following: 1. LockInfo: Read conflict with key which is locked by another transaction. 2. otherwise, txn_result is empty
.dingodb.pb.store.TxnResultInfo txn_result = 3; -
getKvsList
List<Common.KeyValue> getKvsList()for store table/index region, kvs is the return value of the scan request
repeated .dingodb.pb.common.KeyValue kvs = 4; -
getKvs
for store table/index region, kvs is the return value of the scan request
repeated .dingodb.pb.common.KeyValue kvs = 4; -
getKvsCount
int getKvsCount()for store table/index region, kvs is the return value of the scan request
repeated .dingodb.pb.common.KeyValue kvs = 4; -
getKvsOrBuilderList
List<? extends Common.KeyValueOrBuilder> getKvsOrBuilderList()for store table/index region, kvs is the return value of the scan request
repeated .dingodb.pb.common.KeyValue kvs = 4; -
getKvsOrBuilder
for store table/index region, kvs is the return value of the scan request
repeated .dingodb.pb.common.KeyValue kvs = 4; -
getVectorsList
List<Common.VectorWithId> getVectorsList()for vector index region, vectors is the return value of the scan request
repeated .dingodb.pb.common.VectorWithId vectors = 5; -
getVectors
for vector index region, vectors is the return value of the scan request
repeated .dingodb.pb.common.VectorWithId vectors = 5; -
getVectorsCount
int getVectorsCount()for vector index region, vectors is the return value of the scan request
repeated .dingodb.pb.common.VectorWithId vectors = 5; -
getVectorsOrBuilderList
List<? extends Common.VectorWithIdOrBuilder> getVectorsOrBuilderList()for vector index region, vectors is the return value of the scan request
repeated .dingodb.pb.common.VectorWithId vectors = 5; -
getVectorsOrBuilder
for vector index region, vectors is the return value of the scan request
repeated .dingodb.pb.common.VectorWithId vectors = 5; -
getHasMore
boolean getHasMore()if scan is not finished, has_more is true, otherwise false
bool has_more = 6;- Returns:
- The hasMore.
-
getEndKey
com.google.protobuf.ByteString getEndKey()the last iteratered key of this scan response. if end_key is null, means scan do not successfully iterate any key.
bytes end_key = 7;- Returns:
- The endKey.
-
getDocumentsList
List<Common.DocumentWithId> getDocumentsList()for document index region, documents is the return value of the scan request
repeated .dingodb.pb.common.DocumentWithId documents = 8; -
getDocuments
for document index region, documents is the return value of the scan request
repeated .dingodb.pb.common.DocumentWithId documents = 8; -
getDocumentsCount
int getDocumentsCount()for document index region, documents is the return value of the scan request
repeated .dingodb.pb.common.DocumentWithId documents = 8; -
getDocumentsOrBuilderList
List<? extends Common.DocumentWithIdOrBuilder> getDocumentsOrBuilderList()for document index region, documents is the return value of the scan request
repeated .dingodb.pb.common.DocumentWithId documents = 8; -
getDocumentsOrBuilder
for document index region, documents is the return value of the scan request
repeated .dingodb.pb.common.DocumentWithId documents = 8; -
hasStreamMeta
boolean hasStreamMeta().dingodb.pb.stream.StreamResponseMeta stream_meta = 30;- Returns:
- Whether the streamMeta field is set.
-
getStreamMeta
Stream.StreamResponseMeta getStreamMeta().dingodb.pb.stream.StreamResponseMeta stream_meta = 30;- Returns:
- The streamMeta.
-
getStreamMetaOrBuilder
Stream.StreamResponseMetaOrBuilder getStreamMetaOrBuilder().dingodb.pb.stream.StreamResponseMeta stream_meta = 30;
-