Package io.dingodb.store

Class Store.TxnScanResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.dingodb.store.Store.TxnScanResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Store.TxnScanResponseOrBuilder, Serializable
Enclosing class:
Store
public static final class Store.TxnScanResponse extends com.google.protobuf.GeneratedMessageV3 implements Store.TxnScanResponseOrBuilder
 TxnScan can be partially success
 if kvs is not null, and has_more is true, means scan is not finished, client should continue to scan from end_key.
 if txn_result is not null, the kvs may not null, client can use kvs as a partial result, and should continue to scan
 after resolve lock.
Protobuf type dingodb.pb.store.TxnScanResponse
See Also:

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • hasResponseInfo

      public boolean hasResponseInfo()
       response info
      .dingodb.pb.common.ResponseInfo response_info = 1;
      Specified by:
      hasResponseInfo in interface Store.TxnScanResponseOrBuilder
      Returns:
      Whether the responseInfo field is set.

    • getResponseInfo

      public Common.ResponseInfo getResponseInfo()
       response info
      .dingodb.pb.common.ResponseInfo response_info = 1;
      Specified by:
      getResponseInfo in interface Store.TxnScanResponseOrBuilder
      Returns:
      The responseInfo.

    • getResponseInfoOrBuilder

      public Common.ResponseInfoOrBuilder getResponseInfoOrBuilder()
       response info
      .dingodb.pb.common.ResponseInfo response_info = 1;
      Specified by:
      getResponseInfoOrBuilder in interface Store.TxnScanResponseOrBuilder

    • hasError

      public boolean hasError()
       error code
      .dingodb.pb.error.Error error = 2;
      Specified by:
      hasError in interface Store.TxnScanResponseOrBuilder
      Returns:
      Whether the error field is set.

    • getError

      public ErrorOuterClass.Error getError()
       error code
      .dingodb.pb.error.Error error = 2;
      Specified by:
      getError in interface Store.TxnScanResponseOrBuilder
      Returns:
      The error.

    • getErrorOrBuilder

      public ErrorOuterClass.ErrorOrBuilder getErrorOrBuilder()
       error code
      .dingodb.pb.error.Error error = 2;
      Specified by:
      getErrorOrBuilder in interface Store.TxnScanResponseOrBuilder

    • hasTxnResult

      public 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;
      Specified by:
      hasTxnResult in interface Store.TxnScanResponseOrBuilder
      Returns:
      Whether the txnResult field is set.

    • getTxnResult

      public 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;
      Specified by:
      getTxnResult in interface Store.TxnScanResponseOrBuilder
      Returns:
      The txnResult.

    • getTxnResultOrBuilder

      public 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;
      Specified by:
      getTxnResultOrBuilder in interface Store.TxnScanResponseOrBuilder

    • getKvsList

      public 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;
      Specified by:
      getKvsList in interface Store.TxnScanResponseOrBuilder

    • getKvsOrBuilderList

      public 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;
      Specified by:
      getKvsOrBuilderList in interface Store.TxnScanResponseOrBuilder

    • getKvsCount

      public int getKvsCount()
       for store table/index region, kvs is the return value of the scan request
      repeated .dingodb.pb.common.KeyValue kvs = 4;
      Specified by:
      getKvsCount in interface Store.TxnScanResponseOrBuilder

    • getKvs

      public Common.KeyValue getKvs(int index)
       for store table/index region, kvs is the return value of the scan request
      repeated .dingodb.pb.common.KeyValue kvs = 4;
      Specified by:
      getKvs in interface Store.TxnScanResponseOrBuilder

    • getKvsOrBuilder

      public Common.KeyValueOrBuilder getKvsOrBuilder(int index)
       for store table/index region, kvs is the return value of the scan request
      repeated .dingodb.pb.common.KeyValue kvs = 4;
      Specified by:
      getKvsOrBuilder in interface Store.TxnScanResponseOrBuilder

    • getVectorsList

      public List<Common.VectorWithId> getVectorsList()
       for vector index region, vectors is the return value of the scan request
      repeated .dingodb.pb.common.VectorWithId vectors = 5;
      Specified by:
      getVectorsList in interface Store.TxnScanResponseOrBuilder

    • getVectorsOrBuilderList

      public 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;
      Specified by:
      getVectorsOrBuilderList in interface Store.TxnScanResponseOrBuilder

    • getVectorsCount

      public int getVectorsCount()
       for vector index region, vectors is the return value of the scan request
      repeated .dingodb.pb.common.VectorWithId vectors = 5;
      Specified by:
      getVectorsCount in interface Store.TxnScanResponseOrBuilder

    • getVectors

      public Common.VectorWithId getVectors(int index)
       for vector index region, vectors is the return value of the scan request
      repeated .dingodb.pb.common.VectorWithId vectors = 5;
      Specified by:
      getVectors in interface Store.TxnScanResponseOrBuilder

    • getVectorsOrBuilder

      public Common.VectorWithIdOrBuilder getVectorsOrBuilder(int index)
       for vector index region, vectors is the return value of the scan request
      repeated .dingodb.pb.common.VectorWithId vectors = 5;
      Specified by:
      getVectorsOrBuilder in interface Store.TxnScanResponseOrBuilder

    • getHasMore

      public boolean getHasMore()
       if scan is not finished, has_more is true, otherwise false
      bool has_more = 6;
      Specified by:
      getHasMore in interface Store.TxnScanResponseOrBuilder
      Returns:
      The hasMore.

    • getEndKey

      public 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;
      Specified by:
      getEndKey in interface Store.TxnScanResponseOrBuilder
      Returns:
      The endKey.

    • getDocumentsList

      public List<Common.DocumentWithId> getDocumentsList()
       for document index region, documents is the return value of the scan request
      repeated .dingodb.pb.common.DocumentWithId documents = 8;
      Specified by:
      getDocumentsList in interface Store.TxnScanResponseOrBuilder

    • getDocumentsOrBuilderList

      public 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;
      Specified by:
      getDocumentsOrBuilderList in interface Store.TxnScanResponseOrBuilder

    • getDocumentsCount

      public int getDocumentsCount()
       for document index region, documents is the return value of the scan request
      repeated .dingodb.pb.common.DocumentWithId documents = 8;
      Specified by:
      getDocumentsCount in interface Store.TxnScanResponseOrBuilder

    • getDocuments

      public Common.DocumentWithId getDocuments(int index)
       for document index region, documents is the return value of the scan request
      repeated .dingodb.pb.common.DocumentWithId documents = 8;
      Specified by:
      getDocuments in interface Store.TxnScanResponseOrBuilder

    • getDocumentsOrBuilder

      public Common.DocumentWithIdOrBuilder getDocumentsOrBuilder(int index)
       for document index region, documents is the return value of the scan request
      repeated .dingodb.pb.common.DocumentWithId documents = 8;
      Specified by:
      getDocumentsOrBuilder in interface Store.TxnScanResponseOrBuilder

    • hasStreamMeta

      public boolean hasStreamMeta()
      .dingodb.pb.stream.StreamResponseMeta stream_meta = 30;
      Specified by:
      hasStreamMeta in interface Store.TxnScanResponseOrBuilder
      Returns:
      Whether the streamMeta field is set.

    • getStreamMeta

      public Stream.StreamResponseMeta getStreamMeta()
      .dingodb.pb.stream.StreamResponseMeta stream_meta = 30;
      Specified by:
      getStreamMeta in interface Store.TxnScanResponseOrBuilder
      Returns:
      The streamMeta.

    • getStreamMetaOrBuilder

      public Stream.StreamResponseMetaOrBuilder getStreamMetaOrBuilder()
      .dingodb.pb.stream.StreamResponseMeta stream_meta = 30;
      Specified by:
      getStreamMetaOrBuilder in interface Store.TxnScanResponseOrBuilder

    • 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 Store.TxnScanResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Store.TxnScanResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Store.TxnScanResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Store.TxnScanResponse 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.TxnScanResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Store.TxnScanResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Store.TxnScanResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Store.TxnScanResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Store.TxnScanResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Store.TxnScanResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Store.TxnScanResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Store.TxnScanResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Store.TxnScanResponse.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Store.TxnScanResponse.Builder newBuilder()

    • newBuilder

      public static Store.TxnScanResponse.Builder newBuilder(Store.TxnScanResponse prototype)

    • toBuilder

      public Store.TxnScanResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Store.TxnScanResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Store.TxnScanResponse getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Store.TxnScanResponse> parser()

    • getParserForType

      public com.google.protobuf.Parser<Store.TxnScanResponse> 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 Store.TxnScanResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder