package com.aliyun.tablestore.protocol

Get desktop application:
View/edit binary Protocol Buffers messages

• required string transaction_id = 1

(message has no fields)

Used in: GetStreamRecordResponse.StreamRecord

• PUT_ROW = 1

• UPDATE_ROW = 2

• DELETE_ROW = 3

Used in: Aggregations

• optional string name = 1

• optional AggregationType type = 2

• optional bytes body = 3

Used in: AggregationsResult

• optional string name = 1

• optional AggregationType type = 2

• optional bytes agg_result = 3

  encoded by XxxAggregationResult

Used in: Aggregation, AggregationResult

• AGG_AVG = 1

• AGG_MAX = 2

• AGG_MIN = 3

• AGG_SUM = 4

• AGG_COUNT = 5

• AGG_DISTINCT_COUNT = 6

• AGG_TOP_ROWS = 7

• AGG_PERCENTILES = 8

Used in: GroupByField, GroupByFilter, GroupByGeoDistance, GroupByHistogram, GroupByRange, SearchQuery

• repeated Aggregation aggs = 1

Used in: GroupByFieldResultItem, GroupByFilterResultItem, GroupByGeoDistanceResultItem, GroupByHistogramItem, GroupByRangeResultItem

• repeated AggregationResult agg_results = 1

Used in: DescribeTimeseriesAnalyticalStoreResponse

• optional int64 size = 1

  Analyze the storage size occupied by the storage

• optional int64 timestamp = 2

  Count statistics

Used in: DescribeTimeseriesAnalyticalStoreResponse

• optional AnalyticalStoreSyncType sync_phase = 1

  Build status

• optional int64 current_sync_timestamp = 2

  Latest sync time

Used in: AnalyticalStoreSyncStat, TimeseriesAnalyticalStore

• SYNC_TYPE_FULL = 1

  Full build

• SYNC_TYPE_INCR = 2

  Incremental building

• optional string field_name = 1

• optional bytes missing = 2

  encoded as SQLVariant, check in SearchProxy

• optional double value = 1

• repeated TableInBatchGetRowRequest tables = 1

• repeated TableInBatchGetRowResponse tables = 1

• repeated TableInBatchWriteRowRequest tables = 1

• optional string transaction_id = 2

• repeated TableInBatchWriteRowResponse tables = 1

• repeated Query must_queries = 1

• repeated Query must_not_queries = 2

• repeated Query filter_queries = 3

• repeated Query should_queries = 4

• optional int32 minimum_should_match = 5

• optional string new_minimum_should_match = 6

• optional float weight = 7

Used in: ConsumedCapacity, ReservedThroughput, ReservedThroughputDetails

• optional int32 read = 1

• optional int32 write = 2

Used in: SearchQuery

• optional string field_name = 1

• required int32 offset = 1

• required int32 limit = 2

Used in: ColumnsToGet

• RETURN_ALL = 1

• RETURN_SPECIFIED = 2

• RETURN_NONE = 3

• RETURN_ALL_FROM_INDEX = 4

Used in: ParallelScanRequest, SearchRequest

• optional ColumnReturnType return_type = 1

• repeated string column_names = 2

• required string transaction_id = 1

(message has no fields)

Used in: SingleColumnValueFilter

• CT_EQUAL = 1

• CT_NOT_EQUAL = 2

• CT_GREATER_THAN = 3

• CT_GREATER_EQUAL = 4

• CT_LESS_THAN = 5

• CT_LESS_EQUAL = 6

• CT_EXIST = 7

• CT_NOT_EXIST = 8

• required LogicalOperator combinator = 1

• repeated Filter sub_filters = 2

• required string table_name = 1

• required int64 split_size = 2

  in 100MB

• optional int64 split_size_unit_in_byte = 3

• required ConsumedCapacity consumed = 1

• repeated PrimaryKeySchema schema = 2

• repeated bytes split_points = 3

  * Split points between splits, in the increasing order A split is a consecutive range of primary keys, whose data size is about split_size specified in the request. The size could be hard to be precise. A split point is an array of primary-key column w.r.t. table schema, which is never longer than that of table schema. Tailing -inf will be omitted to reduce transmission payloads.

• repeated ComputeSplitPointsBySizeResponse.SplitLocation locations = 4

* Locations where splits lies in. By the managed nature of TableStore, these locations are no more than hints. If a location is not suitable to be seen, an empty string will be placed.

Used in: ComputeSplitPointsBySizeResponse

• required string location = 1

• required sint64 repeat = 2

• optional string table_name = 1

• optional SearchIndexSplitsOptions search_index_splits_options = 2

• optional bytes session_id = 1

• optional int32 splits_size = 2

Used in: DeleteRowRequest, PutRowRequest, RowInBatchWriteRowRequest, UpdateRowRequest

• required RowExistenceExpectation row_existence = 1

• optional bytes column_condition = 2

• optional Query filter = 1

Used in: ComputeSplitPointsBySizeResponse, DeleteRowResponse, GetRangeResponse, GetRowResponse, PutRowResponse, RowInBatchGetRowResponse, RowInBatchWriteRowResponse, SearchConsumedCapacity, TableConsumedCapacity, UpdateRowResponse

• required CapacityUnit capacity_unit = 1

• optional string field_name = 1

• optional int64 value = 1

• required string main_table_name = 1

• required IndexMeta index_meta = 2

• optional bool include_base_data = 3

(message has no fields)

• required string table_name = 1

• required string index_name = 2

• optional IndexSchema schema = 3

• optional int32 time_to_live = 5

  unit is seconds

(message has no fields)

• required TableMeta table_meta = 1

• required ReservedThroughput reserved_throughput = 2

• optional TableOptions table_options = 3

• optional StreamSpecification stream_spec = 5

• optional SSESpecification sse_spec = 6

• repeated IndexMeta index_metas = 7

(message has no fields)

• required string table_name = 1

• optional TimeseriesAnalyticalStore analytical_store = 2

  The time-series analysis storage that needs to be created

(message has no fields)

• required string main_table_name = 1

• required string index_table_name = 2

• optional bool include_base_data = 3

• optional bool create_on_wide_column_table = 4

• repeated string index_primary_key_names = 5

(message has no fields)

• required TimeseriesTableMeta table_meta = 1

• repeated TimeseriesAnalyticalStore analytical_stores = 3

• optional bool enable_analytical_store = 4

• repeated LastpointIndexMetaForCreate lastpoint_index_metas = 5

(message has no fields)

Used in: TableMeta

• required string name = 1

• required DefinedColumnType type = 2

Used in: DefinedColumnSchema

• DCT_INTEGER = 1

• DCT_DOUBLE = 2

• DCT_BOOLEAN = 3

• DCT_STRING = 4

• DCT_BLOB = 7

• required string table_name = 1

• required bytes primary_key = 2

• required Condition condition = 3

• optional ReturnContent return_content = 4

• optional string transaction_id = 5

• required ConsumedCapacity consumed = 1

• optional bytes row = 2

• optional string table_name = 1

• optional string index_name = 2

(message has no fields)

• required string table_name = 1

(message has no fields)

• required string table_name = 1

• required string store_name = 2

• optional bool drop_mapping_table = 3

(message has no fields)

• required string main_table_name = 1

• required string index_table_name = 2

(message has no fields)

• required string table_name = 1

• repeated TimeseriesKey timeseries_key = 2

• optional int64 supported_table_version = 3

• repeated FailedRowInfo failed_rows = 1

• required string table_name = 1

(message has no fields)

• optional string table_name = 1

• optional string index_name = 2

• optional bool include_sync_stat = 3

• optional IndexSchema schema = 1

• optional SyncStat sync_stat = 2

• optional int64 create_time = 6

• optional int32 time_to_live = 7

  unit is seconds

• required string stream_id = 1

• optional string inclusive_start_shard_id = 2

• optional int32 shard_limit = 3

• required string stream_id = 1

• required int32 expiration_time = 2

• required string table_name = 3

• required int64 creation_time = 4

• required StreamStatus stream_status = 5

• repeated StreamShard shards = 6

• optional string next_shard_id = 7

• required string table_name = 1

• required TableMeta table_meta = 1

• required ReservedThroughputDetails reserved_throughput_details = 2

• required TableOptions table_options = 3

• optional StreamDetails stream_details = 5

• repeated bytes shard_splits = 6

• optional SSEDetails sse_details = 7

• repeated IndexMeta index_metas = 8

• required string table_name = 1

• required string store_name = 2

• optional TimeseriesAnalyticalStore analytical_store = 1

• optional AnalyticalStoreSyncStat sync_stat = 2

• optional AnalyticalStoreStorageSize storage_size = 3

• required string table_name = 1

• required TimeseriesTableMeta table_meta = 1

• repeated TimeseriesAnalyticalStore analytical_stores = 2

• repeated TimeseriesLastpointIndex lastpoint_indexes = 3

Used in: GetRangeRequest

• FORWARD = 0

• BACKWARD = 1

• repeated Query queries = 1

• optional float tie_breaker = 2

• optional float weight = 3

• optional string field_name = 1

• optional bytes missing = 2

• optional int64 value = 1

Used in: Sorter

• optional SortOrder order = 1

• required string main_table_name = 1

• required string index_name = 2

(message has no fields)

Used in: RowInBatchGetRowResponse, RowInBatchWriteRowResponse

• required string code = 1

• optional string message = 2

• optional string field_name = 1

Used in: DeleteTimeseriesMetaResponse, PutTimeseriesDataResponse, UpdateTimeseriesMetaResponse

• required int32 row_index = 1

• optional string error_code = 2

• optional string error_message = 3

Used in: GroupByHistogram

• optional bytes min = 1

• optional bytes max = 2

Used in: IndexSchema

• optional string field_name = 1

• optional FieldType field_type = 2

• optional string analyzer = 4

• optional bool index = 5

• optional bool enable_sort_and_agg = 6

• optional bool store = 7

• repeated FieldSchema field_schemas = 8

  only for nested type

• optional bool is_array = 9

• optional bytes analyzer_parameter = 10

• optional bool is_virtual_field = 11

• repeated string source_field_names = 12

• repeated string date_formats = 13

• optional bool enable_highlighting = 14

• optional VectorOptions vector_options = 15

• optional JsonType json_type = 16

• optional TextSimilarity text_similarity = 17

Used in: Sorter

• optional string field_name = 1

• optional SortOrder order = 2

• optional SortMode mode = 3

• optional NestedFilter nested_filter = 4

Used in: FieldSchema

• LONG = 1

• DOUBLE = 2

• BOOLEAN = 3

• KEYWORD = 4

• TEXT = 5

• NESTED = 6

• GEO_POINT = 7

• DATE = 8

• VECTOR = 9

• JSON = 12

Used in: FunctionScoreQuery

• optional string field_name = 1

Used in: CompositeColumnValueFilter

• required FilterType type = 1

• required bytes filter = 2

  Serialized string of filter of the type

Used in: Filter

• FT_SINGLE_COLUMN_VALUE = 1

• FT_COMPOSITE_COLUMN_VALUE = 2

• FT_COLUMN_PAGINATION = 3

• optional Query query = 1

• optional FieldValueFactor field_value_factor = 2

• optional int32 min_chars = 1

• optional int32 max_chars = 2

• optional string field_name = 1

• optional string top_left = 2

• optional string bottom_right = 3

• optional string field_name = 1

• optional string center_point = 2

• optional double distance = 3

Used in: Sorter

• optional string field_name = 1

• repeated string points = 2

• optional SortOrder order = 3

• optional SortMode mode = 4

• optional GeoDistanceType distance_type = 5

• optional NestedFilter nested_filter = 6

Used in: GeoDistanceSort

• GEO_DISTANCE_ARC = 0

• GEO_DISTANCE_PLANE = 1

Used in: GroupByGeoDistance

• optional double lat = 1

• optional double lon = 2

• optional string field_name = 1

• repeated string points = 2

• required string table_name = 1

• required Direction direction = 2

• repeated string columns_to_get = 3

• optional TimeRange time_range = 4

• optional int32 max_versions = 5

• optional int32 limit = 6

• required bytes inclusive_start_primary_key = 7

• required bytes exclusive_end_primary_key = 8

• optional bytes filter = 10

• optional string start_column = 11

• optional string end_column = 12

• optional bytes token = 13

• optional string transaction_id = 14

• required ConsumedCapacity consumed = 1

• required bytes rows = 2

• optional bytes next_start_primary_key = 3

• optional bytes next_token = 4

• required string table_name = 1

• required bytes primary_key = 2

• repeated string columns_to_get = 3

• optional TimeRange time_range = 4

• optional int32 max_versions = 5

• optional bytes filter = 7

• optional string start_column = 8

• optional string end_column = 9

• optional bytes token = 10

• optional string transaction_id = 11

• required ConsumedCapacity consumed = 1

• required bytes row = 2

• optional bytes next_token = 3

• required string stream_id = 1

• required string shard_id = 2

• required string shard_iterator = 1

• required string shard_iterator = 1

• optional int32 limit = 2

• repeated GetStreamRecordResponse.StreamRecord stream_records = 1

• optional string next_shard_iterator = 2

Used in: GetStreamRecordResponse

• required ActionType action_type = 1

• required bytes record = 2

• required string table_name = 1

• required TimeseriesKey time_series_key = 2

• optional int64 begin_time = 3

• optional int64 end_time = 4

• optional int64 specific_time = 5

• optional bytes token = 6

• optional int32 limit = 7

• optional bool backward = 8

• repeated TimeseriesFieldsToGet fields_to_get = 9

• optional int64 supported_table_version = 10

• required bytes rows_data = 1

• optional bytes next_token = 2

Used in: GroupBys

• optional string name = 1

• optional GroupByType type = 2

• optional bytes body = 3

• optional string field_name = 1

• optional int32 size = 2

• optional GroupBySort sort = 3

• optional Aggregations sub_aggs = 4

• optional GroupBys sub_group_bys = 5

• repeated GroupByFieldResultItem group_by_field_result_items = 1

Used in: GroupByFieldResult

• optional string key = 1

• optional int64 row_count = 2

• optional AggregationsResult sub_aggs_result = 3

• optional GroupBysResult sub_group_bys_result = 4

• repeated Query filters = 1

• optional Aggregations sub_aggs = 2

• optional GroupBys sub_group_bys = 3

• repeated GroupByFilterResultItem group_by_filter_result_items = 1

Used in: GroupByFilterResult

• optional int64 row_count = 1

• optional AggregationsResult sub_aggs_result = 2

• optional GroupBysResult sub_group_bys_result = 3

• optional string field_name = 1

• optional GeoPoint origin = 2

• repeated Range ranges = 3

• optional Aggregations sub_aggs = 4

• optional GroupBys sub_group_bys = 5

• repeated GroupByGeoDistanceResultItem group_by_geo_distance_result_items = 1

Used in: GroupByGeoDistanceResult

• optional double range_from = 1

• optional double range_to = 2

• optional int64 row_count = 3

• optional AggregationsResult sub_aggs_result = 4

• optional GroupBysResult sub_group_bys_result = 5

• optional string field_name = 1

• optional bytes interval = 2

• optional bytes missing_value = 3

• optional int64 min_doc_count = 4

• optional GroupBySort sort = 5

• optional FieldRange field_range = 6

• optional Aggregations sub_aggs = 7

• optional GroupBys sub_group_bys = 8

Used in: GroupByHistogramResult

• optional bytes key = 1

• optional int64 value = 2

• optional AggregationsResult sub_aggs_result = 3

• optional GroupBysResult sub_group_bys_result = 4

• repeated GroupByHistogramItem group_by_histogra_items = 1

• optional string field_name = 1

• repeated Range ranges = 2

• optional Aggregations sub_aggs = 3

• optional GroupBys sub_group_bys = 4

• repeated GroupByRangeResultItem group_by_range_result_items = 1

Used in: GroupByRangeResult

• optional double range_from = 1

• optional double range_to = 2

• optional int64 row_count = 3

• optional AggregationsResult sub_aggs_result = 4

• optional GroupBysResult sub_group_bys_result = 5

Used in: GroupBysResult

• optional string name = 1

• optional GroupByType type = 2

• optional bytes group_by_result = 3

  encoded by XxxGroupByResult

Used in: GroupByField, GroupByHistogram

• repeated GroupBySorter sorters = 1

Used in: GroupBySort

• optional GroupKeySort group_key_sort = 1

• optional RowCountSort row_count_sort = 2

• optional SubAggSort sub_agg_sort = 3

Used in: GroupBy, GroupByResult

• GROUP_BY_FIELD = 1

• GROUP_BY_RANGE = 2

• GROUP_BY_FILTER = 3

• GROUP_BY_GEO_DISTANCE = 4

• GROUP_BY_HISTOGRAM = 5

Used in: GroupByField, GroupByFilter, GroupByGeoDistance, GroupByHistogram, GroupByRange, SearchQuery

• repeated GroupBy group_bys = 1

Used in: GroupByFieldResultItem, GroupByFilterResultItem, GroupByGeoDistanceResultItem, GroupByHistogramItem, GroupByRangeResultItem

• repeated GroupByResult group_by_results = 1

  sibling pipeline / parallel group bys

Used in: GroupBySorter

• optional SortOrder order = 1

Used in: InnerHits, SearchQuery

• repeated HighlightParameter highlight_parameters = 1

• optional HighlightEncoder highlight_encoder = 2

Used in: Highlight

• PLAIN_MODE = 1

• HTML_MODE = 2

Used in: HighlightResult

• optional string field_name = 1

• repeated string field_fragments = 2

Used in: HighlightParameter

• TEXT_SEQUENCE = 1

• SCORE = 2

Used in: Highlight

• optional string field_name = 1

• optional int32 number_of_fragments = 2

• optional int32 fragment_size = 3

• optional string pre_tag = 4

• optional string post_tag = 5

• optional HighlightFragmentOrder fragments_order = 6

Used in: SearchHit

• repeated HighlightField highlight_fields = 1

Used in: ListSearchIndexResponse

• optional string table_name = 1

• optional string index_name = 2

Used in: CreateIndexRequest, CreateTableRequest, DescribeTableResponse

• required string name = 1

• repeated string primary_key = 2

• repeated string defined_column = 3

• required IndexUpdateMode index_update_mode = 4

• required IndexType index_type = 5

Used in: CreateSearchIndexRequest, DescribeSearchIndexResponse

• repeated FieldSchema field_schemas = 1

• optional IndexSetting index_setting = 2

• optional Sort index_sort = 3

Used in: IndexSchema

• optional int32 number_of_shards = 1

• repeated string routing_fields = 2

• optional int32 routing_partition_size = 3

Used in: IndexMeta

• IT_GLOBAL_INDEX = 0

• IT_LOCAL_INDEX = 1

Used in: IndexMeta

• IUM_ASYNC_INDEX = 0

• IUM_SYNC_INDEX = 1

Used in: NestedQuery

• optional Sort sort = 1

• optional int32 offset = 2

• optional int32 limit = 3

• optional Highlight highlight = 4

Used in: FieldSchema

• OBJECT_JSON = 1

• NESTED_JSON = 2

• optional string field_name = 1

• optional int32 top_k = 2

• repeated float float32_query_vector = 4

• optional Query filter = 5

• optional float weight = 6

• optional float min_score = 7

• optional int32 num_candidates = 8

Used in: CreateTimeseriesTableRequest

• required string index_table_name = 1

• optional string table_name = 1

• repeated IndexInfo indices = 1

• optional string table_name = 1

• repeated Stream streams = 1

(message has no fields)

• repeated string table_names = 1

(message has no fields)

• repeated TimeseriesTableMeta table_metas = 1

• required string table_name = 1

(message has no fields)

Used in: CompositeColumnValueFilter

• LO_NOT = 1

• LO_AND = 2

• LO_OR = 3

(message has no fields)

• optional string field_name = 1

• optional string text = 2

• optional float weight = 3

• optional int32 slop = 4

• optional string field_name = 1

• optional string text = 2

• optional int32 minimum_should_match = 3

• optional QueryOperator operator = 4

• optional float weight = 5

• optional string new_minimum_should_match = 6

• optional string field_name = 1

• optional bytes missing = 2

• optional double value = 1

• required MetaQuerySingleOperator op = 1

• required string attr_name = 2

• required string value = 3

• required MetaQueryCompositeOperator op = 1

• repeated MetaQueryCondition sub_conditions = 2

Used in: MetaQueryCompositeCondition

• OP_AND = 1

• OP_OR = 2

• OP_NOT = 3

Used in: MetaQueryCompositeCondition, QueryTimeseriesMetaRequest

• required MetaQueryConditionType type = 1

• required bytes proto_data = 2

Used in: MetaQueryCondition

• COMPOSITE_CONDITION = 1

• MEASUREMENT_CONDITION = 2

• SOURCE_CONDITION = 3

• TAG_CONDITION = 4

• UPDATE_TIME_CONDITION = 5

• ATTRIBUTE_CONDITION = 6

• required MetaQuerySingleOperator op = 1

• required string value = 2

Used in: MetaQueryAttributeCondition, MetaQueryMeasurementCondition, MetaQuerySourceCondition, MetaQueryTagCondition, MetaQueryUpdateTimeCondition

• OP_EQUAL = 1

• OP_GREATER_THAN = 2

• OP_GREATER_EQUAL = 3

• OP_LESS_THAN = 4

• OP_LESS_EQUAL = 5

• OP_PREFIX = 6

• required MetaQuerySingleOperator op = 1

• required string value = 2

• required MetaQuerySingleOperator op = 1

• required string tag_name = 2

• required string value = 3

• required MetaQuerySingleOperator op = 1

• required int64 value = 2

Used in: PutTimeseriesDataRequest

• MUM_NORMAL = 0

• MUM_IGNORE = 1

Used in: PutTimeseriesDataResponse

• repeated uint32 row_ids = 1

• repeated uint32 meta_update_times = 2

• optional string field_name = 1

• optional bytes missing = 2

• optional double value = 1

Used in: FieldSort, GeoDistanceSort

• optional string path = 1

• optional Query filter = 2

• optional string path = 1

• optional Query query = 2

• optional ScoreMode score_mode = 3

• optional float weight = 4

• optional InnerHits inner_hits = 5

Used in: RowInBatchWriteRowRequest

• PUT = 1

• UPDATE = 2

• DELETE = 3

• optional string table_name = 1

• optional string index_name = 2

• optional ColumnsToGet columns_to_get = 3

• optional bytes session_id = 4

• optional bytes scan_query = 5

• optional int32 timeout_ms = 6

• repeated bytes rows = 1

  encoded as InplaceRowChangeSet with score

• optional bytes next_token = 2

• optional string field_name = 1

• repeated double percentiles = 2

• optional bytes missing_value = 3

Used in: PercentilesAggregationResult

• optional double key = 1

• optional bytes value = 2

• repeated PercentilesAggregationItem percentiles_aggregation_items = 1

• optional string field_name = 1

• optional string prefix = 2

• optional float weight = 3

Used in: PrimaryKeySchema

• AUTO_INCREMENT = 1

Used in: ComputeSplitPointsBySizeResponse, TableMeta, TimeseriesTableMeta

• required string name = 1

• required PrimaryKeyType type = 2

• optional PrimaryKeyOption option = 3

Used in: Sorter

• optional SortOrder order = 1

Used in: PrimaryKeySchema

• INTEGER = 1

• STRING = 2

• BINARY = 3

• required string table_name = 1

• required bytes row = 2

• required Condition condition = 3

• optional ReturnContent return_content = 4

• optional string transaction_id = 5

• required ConsumedCapacity consumed = 1

• optional bytes row = 2

• required string table_name = 1

• required TimeseriesRows rows_data = 2

• optional MetaUpdateMode meta_update_mode = 3

• optional int64 supported_table_version = 4

• repeated FailedRowInfo failed_rows = 1

• optional MetaUpdateStatus meta_update_status = 2

Used in: BoolQuery, ConstScoreQuery, DisMaxQuery, FunctionScoreQuery, GroupByFilter, KnnVectorQuery, NestedFilter, NestedQuery, ScanQuery, SearchQuery

• optional QueryType type = 1

• optional bytes query = 2

Used in: MatchQuery

• OR = 1

• AND = 2

• required string table_name = 1

• optional MetaQueryCondition condition = 2

• optional bool get_total_hit = 3

• optional bytes token = 4

• optional int32 limit = 5

• optional int64 supported_table_version = 6

• repeated TimeseriesMeta timeseries_metas = 1

• optional int64 total_hit = 2

• optional bytes next_token = 3

Used in: Query

• MATCH_QUERY = 1

• MATCH_PHRASE_QUERY = 2

• TERM_QUERY = 3

• RANGE_QUERY = 4

• PREFIX_QUERY = 5

• BOOL_QUERY = 6

• CONST_SCORE_QUERY = 7

• FUNCTION_SCORE_QUERY = 8

• NESTED_QUERY = 9

• WILDCARD_QUERY = 10

• MATCH_ALL_QUERY = 11

• GEO_BOUNDING_BOX_QUERY = 12

• GEO_DISTANCE_QUERY = 13

• GEO_POLYGON_QUERY = 14

• TERMS_QUERY = 15

• EXISTS_QUERY = 16

• KNN_VECTOR_QUERY = 17

• DIS_MAX_QUERY = 20

Used in: GroupByGeoDistance, GroupByRange

• optional double begin = 1

• optional double end = 2

• optional string field_name = 1

• optional bytes range_from = 2

  variant value

• optional bytes range_to = 3

  variant value

• optional bool include_lower = 4

• optional bool include_upper = 5

Used in: CreateTableRequest, SearchConsumedCapacity, TableConsumedCapacity, UpdateTableRequest

• required CapacityUnit capacity_unit = 1

Used in: DescribeTableResponse, UpdateTableResponse

• required CapacityUnit capacity_unit = 1

• required int64 last_increase_time = 2

• optional int64 last_decrease_time = 3

Used in: DeleteRowRequest, PutRowRequest, RowInBatchWriteRowRequest, UpdateRowRequest

• optional ReturnType return_type = 1

• repeated string return_column_names = 2

Used in: ReturnContent

• RT_NONE = 0

• RT_PK = 1

• RT_AFTER_MODIFY = 2

Used in: GroupBySorter

• optional SortOrder order = 1

Used in: Condition

• IGNORE = 0

• EXPECT_EXIST = 1

• EXPECT_NOT_EXIST = 2

Used in: TableInBatchGetRowResponse

• required bool is_ok = 1

• optional Error error = 2

• optional ConsumedCapacity consumed = 3

• optional bytes row = 4

• optional bytes next_token = 5

Used in: TableInBatchWriteRowRequest

• required OperationType type = 1

• required bytes row_change = 2

• required Condition condition = 3

• optional ReturnContent return_content = 4

Used in: TableInBatchWriteRowResponse

• required bool is_ok = 1

• optional Error error = 2

• optional ConsumedCapacity consumed = 3

• optional bytes row = 4

Used in: ScanTimeseriesDataRequest, ScanTimeseriesDataResponse, TimeseriesRows

• RST_FLAT_BUFFER = 0

• RST_PLAIN_BUFFER = 1

SQLQuery

Used in: SQLQueryRequest, SQLQueryResponse

• SQL_PLAIN_BUFFER = 1

• SQL_FLAT_BUFFERS = 2

• required string query = 1

• optional SQLPayloadVersion version = 2

• repeated TableConsumedCapacity consumes = 1

• optional bytes rows = 2

• optional SQLPayloadVersion version = 3

• optional SQLStatementType type = 4

• repeated SearchConsumedCapacity search_consumes = 5

Used in: SQLQueryResponse

• SQL_SELECT = 1

• SQL_CREATE_TABLE = 2

• SQL_SHOW_TABLE = 3

• SQL_DESCRIBE_TABLE = 4

• SQL_DROP_TABLE = 5

• SQL_ALTER_TABLE = 6

Used in: DescribeTableResponse

• required bool enable = 1

• optional SSEKeyType key_type = 2

• optional bytes key_id = 3

• optional bytes role_arn = 4

  only useful when key_type is SSE_BYOK

Used in: SSEDetails, SSESpecification

• SSE_KMS_SERVICE = 1

• SSE_BYOK = 2

Used in: CreateTableRequest

• required bool enable = 1

• optional SSEKeyType key_type = 2

• optional bytes key_id = 3

  only useful when key_type is SSE_BYOK

• optional bytes role_arn = 4

  only useful when key_type is SSE_BYOK

• optional Query query = 1

• optional int32 limit = 2

• optional int32 alive_time = 3

  unit is second

• optional bytes token = 4

• optional int32 current_parallel_id = 5

• optional int32 max_parallel = 6

• required string table_name = 1

• optional bytes split_info = 2

• optional int64 start_time_us = 3

• optional int64 end_time_us = 4

• repeated TimeseriesFieldsToGet fields_to_get = 5

• optional int32 limit = 6

• optional RowsSerializeType data_serialize_type = 7

• optional bytes token = 8

• optional int64 supported_table_version = 9

• optional RowsSerializeType data_serialize_type = 1

• required bytes data = 2

• optional bytes next_token = 3

Used in: NestedQuery

• SCORE_MODE_NONE = 1

• SCORE_MODE_AVG = 2

• SCORE_MODE_MAX = 3

• SCORE_MODE_TOTAL = 4

• SCORE_MODE_MIN = 5

Used in: Sorter

• optional SortOrder order = 1

Used in: SQLQueryResponse

• optional string table_name = 1

• optional string index_name = 2

• optional ConsumedCapacity consumed = 3

• optional ReservedThroughput reserved_throughput = 4

Used in: SearchInnerHit, SearchResponse

• optional double score = 3

• optional HighlightResult highlight_result = 4

• repeated SearchInnerHit search_inner_hits = 5

• optional int32 nested_doc_offset = 6

Used in: ComputeSplitsRequest

• optional string index_name = 1

Used in: SearchHit

• optional string path = 1

• repeated SearchHit search_hits = 2

• optional int32 offset = 1

• optional int32 limit = 2

• optional Query query = 4

• optional Collapse collapse = 5

• optional Sort sort = 6

• optional bool get_total_count = 8

• optional bytes token = 9

• optional Aggregations aggs = 10

• optional GroupBys group_bys = 11

• optional Highlight highlight = 12

• optional string table_name = 1

• optional string index_name = 2

• optional ColumnsToGet columns_to_get = 3

• optional bytes search_query = 4

• repeated bytes routing_values = 5

• optional int32 timeout_ms = 6

* Response part:

• optional int64 total_hits = 1

• repeated bytes rows = 2

• optional bool is_all_succeed = 3

• repeated SearchHit search_hits = 5

• optional bytes next_token = 6

• optional bytes aggs = 7

• optional bytes group_bys = 8

• optional int32 version = 1

• optional bytes session_id = 2

• required ComparatorType comparator = 1

• required string column_name = 2

• required bytes column_value = 3

  Serialized SQLVariant

• required bool filter_if_missing = 4

• required bool latest_version_only = 5

• optional ValueTransferRule value_trans_rule = 6

• optional bool case_sensitive = 1

• optional bool delimit_word = 2

Used in: IndexSchema, InnerHits, SearchQuery, TopRowsAggregation

• repeated Sorter sorter = 1

Used in: FieldSort, GeoDistanceSort

• SORT_MODE_MIN = 0

• SORT_MODE_MAX = 1

• SORT_MODE_AVG = 2

Used in: DocSort, FieldSort, GeoDistanceSort, GroupKeySort, PrimaryKeySort, RowCountSort, ScoreSort, SubAggSort

• SORT_ORDER_ASC = 0

• SORT_ORDER_DESC = 1

Used in: Sort

• optional FieldSort field_sort = 1

• optional GeoDistanceSort geo_distance_sort = 2

• optional ScoreSort score_sort = 3

• optional PrimaryKeySort pk_sort = 4

• optional DocSort doc_sort = 5

• optional string delimiter = 1

• required string table_name = 1

• optional string measurement_name = 2

• required int32 split_count_hint = 3

• repeated bytes split_infos = 1

• required string table_name = 1

• required bytes key = 2

• required string transaction_id = 1

Used in: ListStreamResponse

• required string stream_id = 1

• required string table_name = 2

• required int64 creation_time = 3

Used in: DescribeTableResponse, UpdateTableResponse

• required bool enable_stream = 1

• optional string stream_id = 2

• optional int32 expiration_time = 3

• optional int64 last_enable_time = 4

Used in: DescribeStreamResponse

• required string shard_id = 1

• optional string parent_id = 2

• optional string parent_sibling_id = 3

Used in: CreateTableRequest, UpdateTableRequest

• required bool enable_stream = 1

• optional int32 expiration_time = 2

Used in: DescribeStreamResponse

• STREAM_ENABLING = 1

• STREAM_ACTIVE = 2

Used in: GroupBySorter

• optional string sub_agg_name = 1

• optional SortOrder order = 2

• optional string field_name = 1

• optional bytes missing = 2

• optional double value = 1

Used in: SyncStat

• FULL = 1

• INCR = 2

Used in: DescribeSearchIndexResponse

• optional SyncPhase sync_phase = 1

• optional int64 current_sync_timestamp = 2

  Synchronize progress, refer to TunnelService.

Used in: SQLQueryResponse

• optional string table_name = 1

• optional ConsumedCapacity consumed = 2

• optional ReservedThroughput reserved_throughput = 3

• optional bool is_timeseries_meta = 4

Used in: BatchGetRowRequest

• required string table_name = 1

• repeated bytes primary_key = 2

• repeated bytes token = 3

• repeated string columns_to_get = 4

• optional TimeRange time_range = 5

• optional int32 max_versions = 6

• optional bytes filter = 8

• optional string start_column = 9

• optional string end_column = 10

Used in: BatchGetRowResponse

• required string table_name = 1

• repeated RowInBatchGetRowResponse rows = 2

Used in: BatchWriteRowRequest

• required string table_name = 1

• repeated RowInBatchWriteRowRequest rows = 2

Used in: BatchWriteRowResponse

• required string table_name = 1

• repeated RowInBatchWriteRowResponse rows = 2

Used in: CreateTableRequest, DescribeTableResponse

• required string table_name = 1

• repeated PrimaryKeySchema primary_key = 2

• repeated DefinedColumnSchema defined_column = 3

Used in: CreateTableRequest, DescribeTableResponse, UpdateTableRequest, UpdateTableResponse

• optional int32 time_to_live = 1

• optional int32 max_versions = 2

• optional int64 deviation_cell_version_in_sec = 5

• optional bool allow_update = 6

• optional bool update_full_row = 7

• optional string field_name = 1

• optional bytes term = 2

• optional float weight = 3

• optional string field_name = 1

• repeated bytes terms = 2

• optional float weight = 3

Used in: FieldSchema

• BM25 = 1

• SHORT_TEXT = 2

Used in: GetRangeRequest, GetRowRequest, TableInBatchGetRowRequest

• optional int64 start_time = 1

• optional int64 end_time = 2

• optional int64 specific_time = 3

Used in: CreateTimeseriesAnalyticalStoreRequest, CreateTimeseriesTableRequest, DescribeTimeseriesAnalyticalStoreResponse, DescribeTimeseriesTableResponse, UpdateTimeseriesAnalyticalStoreRequest

• optional string store_name = 1

  Store name

• optional int32 time_to_live = 2

  Storage data TTL

• optional AnalyticalStoreSyncType sync_option = 3

  Full or incremental build

Used in: GetTimeseriesDataRequest, ScanTimeseriesDataRequest

• optional string name = 1

• optional int32 type = 2

Used in: DeleteTimeseriesMetaRequest, GetTimeseriesDataRequest, TimeseriesMeta

• optional string measurement = 1

• optional string source = 2

• optional string tags = 3

• repeated TimeseriesTag tag_list = 4

Used in: DescribeTimeseriesTableResponse

• optional string index_table_name = 1

Used in: QueryTimeseriesMetaResponse, UpdateTimeseriesMetaRequest

• required TimeseriesKey time_series_key = 1

• optional string attributes = 2

• optional int64 update_time = 3

Used in: TimeseriesTableMeta, UpdateTimeseriesTableRequest

• optional bool allow_update_attributes = 1

• optional int32 meta_time_to_live = 2

Used in: PutTimeseriesDataRequest

• required RowsSerializeType type = 1

• required bytes rows_data = 2

• optional int32 flatbuffer_crc32c = 3

Used in: CreateTimeseriesTableRequest, DescribeTimeseriesTableResponse, ListTimeseriesTableResponse

• required string table_name = 1

• optional TimeseriesTableOptions table_options = 2

• optional string status = 3

• optional TimeseriesMetaOptions meta_options = 4

• repeated string timeseries_key_schema = 5

• repeated PrimaryKeySchema field_primary_key_schema = 6

• optional bool disable_hash_partition_key = 7

• optional bool disable_timeseries_meta_index = 8

Used in: TimeseriesTableMeta, UpdateTimeseriesTableRequest

• optional int32 time_to_live = 1

Used in: TimeseriesKey

• required string name = 1

• required string value = 2

• optional int32 limit = 1

• optional Sort sort = 2

• repeated bytes rows = 1

• required string table_name = 1

(message has no fields)

• required string table_name = 1

• required bytes row_change = 2

• required Condition condition = 3

• optional ReturnContent return_content = 4

• optional string transaction_id = 5

• required ConsumedCapacity consumed = 1

• optional bytes row = 2

• optional string table_name = 1

• optional string index_name = 2

• optional int32 time_to_live = 5

  unit is seconds

(message has no fields)

• required string table_name = 1

• optional ReservedThroughput reserved_throughput = 2

• optional TableOptions table_options = 3

• optional StreamSpecification stream_spec = 4

• required ReservedThroughputDetails reserved_throughput_details = 1

• required TableOptions table_options = 2

• optional StreamDetails stream_details = 3

• required string table_name = 1

• required TimeseriesAnalyticalStore analytical_store = 2

(message has no fields)

• required string table_name = 1

• repeated TimeseriesMeta timeseries_meta = 2

• optional int64 supported_table_version = 3

• repeated FailedRowInfo failed_rows = 1

• required string table_name = 1

• optional TimeseriesTableOptions table_options = 2

• optional TimeseriesMetaOptions meta_options = 3

(message has no fields)

Used in: SingleColumnValueFilter

• required string regex = 1

• optional VariantType cast_type = 2

Used in: ValueTransferRule

• VT_INTEGER = 0

• VT_DOUBLE = 1

• VT_STRING = 3

  VT_BOOLEAN = 2;

• VT_NULL = 6

• VT_BLOB = 7

Used in: VectorOptions

• VD_FLOAT_32 = 2

Used in: VectorOptions

• VM_EUCLIDEAN = 0

• VM_COSINE = 1

• VM_DOT_PRODUCT = 2

Used in: FieldSchema

• optional VectorDataType data_type = 1

• optional int32 dimension = 2

• optional VectorMetricType metric_type = 3

• optional string field_name = 1

• optional string value = 2

• optional float weight = 3