Package io.dingodb.index

Interface Index.VectorScanQueryRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Index.VectorScanQueryRequest, Index.VectorScanQueryRequest.Builder
Enclosing class:
Index
public static interface Index.VectorScanQueryRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Store.Context
    getContext()
    .dingodb.pb.store.Context context = 2;
    Store.ContextOrBuilder
    getContextOrBuilder()
    .dingodb.pb.store.Context context = 2;
    boolean
    getIsReverseScan()
    bool is_reverse_scan = 4;
    long
    getMaxScanCount()
    the max count user want to scan
    Common.RequestInfo
    getRequestInfo()
    .dingodb.pb.common.RequestInfo request_info = 1;
    Common.RequestInfoOrBuilder
    getRequestInfoOrBuilder()
    .dingodb.pb.common.RequestInfo request_info = 1;
    Common.VectorScalardata
    getScalarForFilter()
    .dingodb.pb.common.VectorScalardata scalar_for_filter = 21;
    Common.VectorScalardataOrBuilder
    getScalarForFilterOrBuilder()
    .dingodb.pb.common.VectorScalardata scalar_for_filter = 21;
    String
    getSelectedKeys(int index)
    If without_scalar_data is false, selected_keys is used to select scalar data, if this parameter is null, all scalar data will be returned.
    com.google.protobuf.ByteString
    getSelectedKeysBytes(int index)
    If without_scalar_data is false, selected_keys is used to select scalar data, if this parameter is null, all scalar data will be returned.
    int
    getSelectedKeysCount()
    If without_scalar_data is false, selected_keys is used to select scalar data, if this parameter is null, all scalar data will be returned.
    List<String>
    getSelectedKeysList()
    If without_scalar_data is false, selected_keys is used to select scalar data, if this parameter is null, all scalar data will be returned.
    long
    getTs()
    int64 ts = 10;
    boolean
    getUseScalarFilter()
    Whether to use scalar filtering.
    long
    getVectorIdEnd()
    the end id of scan, if is_reverse_scan is true, vector_id_end must be less than vector_id_start, if is_reverse_scan is false, vector_id_end must be greater than vector_id_start the real range is [start, end], include start and end if vector_id_end == 0, scan to the end of the region
    long
    getVectorIdStart()
    int64 vector_id_start = 3;
    boolean
    getWithoutScalarData()
    Default false, if true, response without scalar data.
    boolean
    getWithoutTableData()
    Default false, if true, response without table data.
    boolean
    getWithoutVectorData()
    Default false, if true, response without vector data.
    boolean
    hasContext()
    .dingodb.pb.store.Context context = 2;
    boolean
    hasRequestInfo()
    .dingodb.pb.common.RequestInfo request_info = 1;
    boolean
    hasScalarForFilter()
    .dingodb.pb.common.VectorScalardata scalar_for_filter = 21;

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasRequestInfo

      boolean hasRequestInfo()
      .dingodb.pb.common.RequestInfo request_info = 1;
      Returns:
      Whether the requestInfo field is set.

    • getRequestInfo

      Common.RequestInfo getRequestInfo()
      .dingodb.pb.common.RequestInfo request_info = 1;
      Returns:
      The requestInfo.

    • getRequestInfoOrBuilder

      Common.RequestInfoOrBuilder getRequestInfoOrBuilder()
      .dingodb.pb.common.RequestInfo request_info = 1;

    • hasContext

      boolean hasContext()
      .dingodb.pb.store.Context context = 2;
      Returns:
      Whether the context field is set.

    • getContext

      Store.Context getContext()
      .dingodb.pb.store.Context context = 2;
      Returns:
      The context.

    • getContextOrBuilder

      Store.ContextOrBuilder getContextOrBuilder()
      .dingodb.pb.store.Context context = 2;

    • getVectorIdStart

      long getVectorIdStart()
      int64 vector_id_start = 3;
      Returns:
      The vectorIdStart.

    • getIsReverseScan

      boolean getIsReverseScan()
      bool is_reverse_scan = 4;
      Returns:
      The isReverseScan.

    • getMaxScanCount

      long getMaxScanCount()
       the max count user want to scan
      int64 max_scan_count = 5;
      Returns:
      The maxScanCount.

    • getVectorIdEnd

      long getVectorIdEnd()
       the end id of scan, if is_reverse_scan is true, vector_id_end must be
 less than vector_id_start, if is_reverse_scan is false, vector_id_end
 must be greater than vector_id_start the real range is [start, end],
 include start and end if vector_id_end == 0, scan to the end of the
 region
      int64 vector_id_end = 6;
      Returns:
      The vectorIdEnd.

    • getWithoutVectorData

      boolean getWithoutVectorData()
       Default false, if true, response without vector data.
      bool without_vector_data = 11;
      Returns:
      The withoutVectorData.

    • getWithoutScalarData

      boolean getWithoutScalarData()
       Default false, if true, response without scalar data.
      bool without_scalar_data = 12;
      Returns:
      The withoutScalarData.

    • getSelectedKeysList

      List<String> getSelectedKeysList()
       If without_scalar_data is false, selected_keys is used to select scalar
 data, if this parameter is null, all scalar data will be returned.
      repeated string selected_keys = 13;
      Returns:
      A list containing the selectedKeys.

    • getSelectedKeysCount

      int getSelectedKeysCount()
       If without_scalar_data is false, selected_keys is used to select scalar
 data, if this parameter is null, all scalar data will be returned.
      repeated string selected_keys = 13;
      Returns:
      The count of selectedKeys.

    • getSelectedKeys

      String getSelectedKeys(int index)
       If without_scalar_data is false, selected_keys is used to select scalar
 data, if this parameter is null, all scalar data will be returned.
      repeated string selected_keys = 13;
      Parameters:
      index - The index of the element to return.
      Returns:
      The selectedKeys at the given index.

    • getSelectedKeysBytes

      com.google.protobuf.ByteString getSelectedKeysBytes(int index)
       If without_scalar_data is false, selected_keys is used to select scalar
 data, if this parameter is null, all scalar data will be returned.
      repeated string selected_keys = 13;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the selectedKeys at the given index.

    • getWithoutTableData

      boolean getWithoutTableData()
       Default false, if true, response without table data.
      bool without_table_data = 14;
      Returns:
      The withoutTableData.

    • getUseScalarFilter

      boolean getUseScalarFilter()
       Whether to use scalar filtering.
      bool use_scalar_filter = 20;
      Returns:
      The useScalarFilter.

    • hasScalarForFilter

      boolean hasScalarForFilter()
      .dingodb.pb.common.VectorScalardata scalar_for_filter = 21;
      Returns:
      Whether the scalarForFilter field is set.

    • getScalarForFilter

      Common.VectorScalardata getScalarForFilter()
      .dingodb.pb.common.VectorScalardata scalar_for_filter = 21;
      Returns:
      The scalarForFilter.

    • getScalarForFilterOrBuilder

      Common.VectorScalardataOrBuilder getScalarForFilterOrBuilder()
      .dingodb.pb.common.VectorScalardata scalar_for_filter = 21;

    • getTs

      long getTs()
      int64 ts = 10;
      Returns:
      The ts.