Package io.dingodb.common

Interface Common.DocumentSearchParameterOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Common.DocumentSearchParameter, Common.DocumentSearchParameter.Builder
Enclosing class:
Common
public static interface Common.DocumentSearchParameterOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getColumnNames(int index)
    use column filter if query_string is simple string, use column_names to select columns if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
    com.google.protobuf.ByteString
    getColumnNamesBytes(int index)
    use column filter if query_string is simple string, use column_names to select columns if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
    int
    getColumnNamesCount()
    use column filter if query_string is simple string, use column_names to select columns if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
    List<String>
    getColumnNamesList()
    use column filter if query_string is simple string, use column_names to select columns if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
    long
    getDocumentIds(int index)
    if use_id_filter = true, use this field
    int
    getDocumentIdsCount()
    if use_id_filter = true, use this field
    List<Long>
    getDocumentIdsList()
    if use_id_filter = true, use this field
    String
    getQueryString()
    The query_string for search
    com.google.protobuf.ByteString
    getQueryStringBytes()
    The query_string for search
    boolean
    getQueryUnlimited()
    if query_unlimited = true, top_n is igonred
    String
    getSelectedKeys(int index)
    If without_scalar_data is false, selected_keys is used to select scalar data,
    com.google.protobuf.ByteString
    getSelectedKeysBytes(int index)
    If without_scalar_data is false, selected_keys is used to select scalar data,
    int
    getSelectedKeysCount()
    If without_scalar_data is false, selected_keys is used to select scalar data,
    List<String>
    getSelectedKeysList()
    If without_scalar_data is false, selected_keys is used to select scalar data,
    int
    getTopN()
    The number of top results to return.
    boolean
    getUseIdFilter()
    use id filter
    boolean
    getWithoutScalarData()
    for output, if only id is needed, set without_scalar_data = true else set without_scalar_data = false, and set selected_keys to select scalar data
    boolean
    getWithoutTableData()
    if this parameter is null, all scalar data will be returned.

    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

    • getTopN

      int getTopN()
       The number of top results to return.
      uint32 top_n = 1;
      Returns:
      The topN.

    • getQueryString

      String getQueryString()
       The query_string for search
      string query_string = 2;
      Returns:
      The queryString.

    • getQueryStringBytes

      com.google.protobuf.ByteString getQueryStringBytes()
       The query_string for search
      string query_string = 2;
      Returns:
      The bytes for queryString.

    • getUseIdFilter

      boolean getUseIdFilter()
       use id filter
      bool use_id_filter = 3;
      Returns:
      The useIdFilter.

    • getDocumentIdsList

      List<Long> getDocumentIdsList()
       if use_id_filter = true, use this field
      repeated int64 document_ids = 4;
      Returns:
      A list containing the documentIds.

    • getDocumentIdsCount

      int getDocumentIdsCount()
       if use_id_filter = true, use this field
      repeated int64 document_ids = 4;
      Returns:
      The count of documentIds.

    • getDocumentIds

      long getDocumentIds(int index)
       if use_id_filter = true, use this field
      repeated int64 document_ids = 4;
      Parameters:
      index - The index of the element to return.
      Returns:
      The documentIds at the given index.

    • getColumnNamesList

      List<String> getColumnNamesList()
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Returns:
      A list containing the columnNames.

    • getColumnNamesCount

      int getColumnNamesCount()
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Returns:
      The count of columnNames.

    • getColumnNames

      String getColumnNames(int index)
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The columnNames at the given index.

    • getColumnNamesBytes

      com.google.protobuf.ByteString getColumnNamesBytes(int index)
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the columnNames at the given index.

    • getWithoutScalarData

      boolean getWithoutScalarData()
       for output, if only id is needed, set without_scalar_data = true
 else set without_scalar_data = false, and set selected_keys to select scalar data
      bool without_scalar_data = 10;
      Returns:
      The withoutScalarData.

    • getSelectedKeysList

      List<String> getSelectedKeysList()
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 11;
      Returns:
      A list containing the selectedKeys.

    • getSelectedKeysCount

      int getSelectedKeysCount()
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 11;
      Returns:
      The count of selectedKeys.

    • getSelectedKeys

      String getSelectedKeys(int index)
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 11;
      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,
      repeated string selected_keys = 11;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the selectedKeys at the given index.

    • getWithoutTableData

      boolean getWithoutTableData()
       if this parameter is null, all scalar data will be returned.
      bool without_table_data = 12;
      Returns:
      The withoutTableData.

    • getQueryUnlimited

      boolean getQueryUnlimited()
       if query_unlimited = true, top_n is igonred
      bool query_unlimited = 13;
      Returns:
      The queryUnlimited.