package otsprotocol

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

• required string table_name = 1

• repeated DefinedColumnSchema columns = 2

(message has no fields)

agg & group by

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

aggregation & group by

Used in: Aggregation, AggregationResult

• AGG_AVG = 1

• AGG_DISTINCT_COUNT = 6

• AGG_MAX = 2

• AGG_MIN = 3

• AGG_SUM = 4

• AGG_COUNT = 5

• AGG_TOP_ROWS = 7

• AGG_PERCENTILES = 8

Used in: GroupByComposite, GroupByDateHistogram, GroupByField, GroupByFilter, GroupByGeoDistance, GroupByGeoGrid, GroupByHistogram, GroupByRange, SearchQuery

• repeated Aggregation aggs = 1

Used in: GroupByCompositeResultItem, GroupByDateHistogramItem, GroupByFieldResultItem, GroupByFilterResultItem, GroupByGeoDistanceResultItem, GroupByGeoGridResultItem, GroupByHistogramItem, GroupByRangeResultItem

• repeated AggregationResult agg_results = 1

Used in: DescribeTimeseriesAnalyticalStoreResponse

• optional int64 size = 1

  Analyze the storage size usage

• optional int64 timestamp = 2

  Counting time

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 build

single agg

• optional string field_name = 1

• optional bytes missing = 2

  encoded as SQLVariant, check in SearchProxy

single agg result

• optional double value = 1

Used in: CreateGlobalTableRequest

• required string regionId = 1

• required string instanceName = 2

• required string tableName = 3

• repeated TableInBatchGetRowRequest tables = 1

• repeated TableInBatchGetRowResponse tables = 1

• repeated TableInBatchWriteRowRequest tables = 1

• optional string transaction_id = 2

• optional bool is_atomic = 3

• repeated TableInBatchWriteRowResponse tables = 1

• required string globalTableId = 2

• required string globalTableName = 3

• repeated Placement placements = 4

• required string globalTableId = 2

• required GlobalTableStatus status = 3

Used in: TableOptions

• NONE = 1

• CELL = 2

• ROW = 3

• 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

• required LogicalOperator combinator = 1

• repeated Filter sub_filters = 2

Used in: GetRangeRequest, GetRangeResponse

• CPT_NONE = 0

+++++ ComputeSplitPointsBySize +++++

• required string table_name = 1

• required int64 split_size = 2

  in 100MB

• optional int64 split_size_unit_in_byte = 3

• optional int32 split_point_limit = 4

• 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

computeSplits

• 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, GetStreamRecordResponse, PutRowResponse, RowInBatchGetRowResponse, RowInBatchWriteRowResponse, SearchConsumedCapacity, SearchResponse, TableConsumedCapacity, UpdateRowResponse

• required CapacityUnit capacity_unit = 1

• optional string field_name = 1

• optional int64 value = 1

• optional string tableName = 1

• optional string taskName = 2

• optional OSSTaskConfig taskConfig = 3

• optional DeliveryTaskType taskType = 4

(message has no fields)

• required BaseTable baseTable = 2

• repeated Placement placements = 3

• required SyncMode syncMode = 4

• optional ServeMode serveMode = 5

• required string globalTableId = 2

• required GlobalTableStatus status = 3

• optional ServeMode serveMode = 4

• 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 string source_index_name = 4

  It is not recommended to use the SDK directly

• optional int32 time_to_live = 5

  unit is seconds

(message has no fields)

* table_meta is used to store the non-modifiable schema properties of a table. The modifiable ReservedThroughput and TableOptions are separated out as parameters for UpdateTable. After adding GlobalIndex and LocalIndex, the structure will become: message CreateTableRequest { required TableMeta table_meta = 1; required ReservedThroughput reserved_throughput = 2; required TableOptions table_options = 3; repeated LocalIndex local_indexes = 4; // LocalIndex no longer separately includes ReservedThroughput and TableOptions; it shares configurations with the main table. repeated GlobalIndex global_indexes = 5; // GlobalIndex separately includes ReservedThroughput and TableOptions }

• required TableMeta table_meta = 1

• required ReservedThroughput reserved_throughput = 2

  Not placed in TableOptions because UpdateTableResponse returns ReservedThroughputDetails, and TableOptions does not have a similar return structure.

• optional TableOptions table_options = 3

• repeated PartitionRange partitions = 4

• optional StreamSpecification stream_spec = 5

• optional SSESpecification sse_spec = 6

• repeated IndexMeta index_metas = 7

• optional bool enable_local_txn = 8

(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: GetRangeRequest, GetRangeResponse

• DBT_PLAIN_BUFFER = 0

• DBT_SIMPLE_ROW_MATRIX = 1

Used in: DateTimeValue

• YEAR = 1

• QUARTER_YEAR = 2

  A quarter

• MONTH = 3

• WEEK = 4

• DAY = 5

• HOUR = 6

• MINUTE = 7

• SECOND = 8

Used in: DecayFuncDateParam, GroupByDateHistogram

• optional int32 value = 1

• optional DateTimeUnit unit = 2

• optional int64 origin_long = 1

• optional string origin_string = 2

• optional DateTimeValue scale = 3

• optional DateTimeValue offset = 4

• optional string origin = 1

• optional double scale = 2

• optional double offset = 3

• optional double origin = 1

• optional double scale = 2

• optional double offset = 3

Used in: DecayFunction

• DF_DATE_PARAM = 1

• DF_NUMERIC_PARAM = 2

• DF_GEO_PARAM = 3

Used in: Function

• optional string field_name = 1

• optional DecayMathFunction math_function = 2

• optional DecayFuncParamType param_type = 3

• optional bytes param = 4

• optional double decay = 5

• optional MultiValueMode multi_value_mode = 6

Used in: DecayFunction

• GAUSS = 1

• EXP = 2

• LINEAR = 3

Used in: AddDefinedColumnRequest, 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

  field 5 is reserved for date type, not supported yet field 6 is reserved for decimal type, not supported yet

• required string table_name = 1

• repeated string columns = 2

(message has no fields)

• optional string tableName = 1

• optional string taskName = 2

(message has no fields)

* OTS only supports deleting all versions of all columns in a row, and does not support: 1. Deleting all versions of all columns that are less than or equal to a certain version

• required string table_name = 1

• required bytes primary_key = 2

  encoded as InplaceRowChangeSet, but only has primary key

• 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)

############################################# DeleteTable #############################################

• 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)

Used in: ListDeliveryTaskResponse

• optional string tableName = 1

• optional string taskName = 2

• optional DeliveryTaskType taskType = 3

Used in: CreateDeliveryTaskRequest, DeliveryTaskInfo, DescribeDeliveryTaskResponse

• BASE = 0

• INC = 1

• BASE_INC = 2

• optional string tableName = 1

• optional string taskName = 2

• optional OSSTaskConfig taskConfig = 1

• optional TaskSyncStat task_sync_stat = 2

• optional DeliveryTaskType taskType = 3

• optional string globalTableId = 1

• required string globalTableName = 2

• optional PhyTable phyTable = 3

• optional bool returnRpo = 4

• required string globalTableId = 2

• required GlobalTableStatus status = 3

• repeated PhyTable phyTables = 4

• optional ServeMode serveMode = 5

• 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 MeteringInfo metering_info = 3

• optional string brother_index_name = 4

• repeated QueryFlowWeight query_flow_weight = 5

• 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

Used in: DescribeTableResponse

• optional string cluster_name = 1

############################################# DescribeTable #############################################

• required string table_name = 1

• required TableMeta table_meta = 1

• required ReservedThroughputDetails reserved_throughput_details = 2

• required TableOptions table_options = 3

• required TableStatus table_status = 4

• optional StreamDetails stream_details = 5

• repeated bytes shard_splits = 6

• optional SSEDetails sse_details = 7

• repeated IndexMeta index_metas = 8

• optional DescribeTableInnerInfo inner_info = 12

• 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

############################################# GetRange #############################################

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: ParquetSchema

• PLAIN = 0

• PLAIN_DICTIONARY = 1

• DELTA_BINARY_PACKED = 2

• DELTA_BYTE_ARRAY = 3

• DELTA_LENGTH_BYTE_ARRAY = 4

Used in: RowInBatchGetRowResponse, RowInBatchWriteRowResponse

• required string code = 1

• optional string message = 2

Used in: TaskSyncStat

• UNAUTHORIZED = 1

• INVALID_OSS_BUCKET = 2

Used in: OSSTaskConfig

• optional string columnName = 1

• optional EventColumn.eventTimeFormat timeFormat = 2

Used in: EventColumn

• RFC822 = 1

• RFC850 = 2

• RFC1123 = 3

• RFC3339 = 4

• Unix = 5

• 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: GroupByDateHistogram, GroupByHistogram

• optional bytes min = 1

• optional bytes max = 2

Used in: IndexSchema

• optional string field_name = 1

• optional FieldType field_type = 2

• optional IndexOptions index_options = 3

• optional string analyzer = 4

• optional bool index = 5

• optional bool 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

• optional bytes missing_value = 5

• optional string missing_field = 6

• repeated string missing_fields = 7

Used in: FieldSchema

• LONG = 1

• DOUBLE = 2

• BOOLEAN = 3

• KEYWORD = 4

• TEXT = 5

• NESTED = 6

• GEO_POINT = 7

• DATE = 8

• VECTOR = 9

• IP = 11

• JSON = 12

Used in: FunctionScoreQuery

• optional string field_name = 1

Used in: Function

• optional string field_name = 1

• optional float factor = 2

• optional FunctionModifier modifier = 3

• optional double missing = 4

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

Used in: OSSTaskConfig

• Parquet = 0

Used in: FunctionsScoreQuery

• optional FieldValueFactorFunction field_value_factor = 1

• optional RandomScoreFunction random = 2

• optional DecayFunction decay = 3

• optional float weight = 4

• optional Query filter = 5

Used in: FunctionsScoreQuery

• FCM_MULTIPLY = 1

• FCM_AVG = 2

• FCM_MAX = 3

• FCM_SUM = 4

• FCM_MIN = 5

• FCM_REPLACE = 6

Used in: FieldValueFactorFunction

• FM_NONE = 1

• FM_LOG = 2

• FM_LOG1P = 3

• FM_LOG2P = 4

• FM_LN = 5

• FM_LN1P = 6

• FM_LN2P = 7

• FM_SQUARE = 8

• FM_SQRT = 9

• FM_RECIPROCAL = 10

Used in: FunctionsScoreQuery

• FSM_AVG = 1

• FSM_MAX = 2

• FSM_SUM = 3

• FSM_MIN = 4

• FSM_MULTIPLY = 5

• FSM_FIRST = 6

• optional Query query = 1

• optional FieldValueFactor field_value_factor = 2

• optional Query query = 1

• repeated Function functions = 2

• optional FunctionScoreMode socre_mode = 3

• optional FunctionCombineMode combine_mode = 4

• optional float min_score = 5

• optional float max_score = 6

• 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: GroupByGeoGridResultItem

• optional GeoPoint top_left = 1

• optional GeoPoint bottom_right = 2

Used in: GroupByGeoGrid

• GHP_5009KM_4992KM_1 = 1

• GHP_1252KM_624KM_2 = 2

• GHP_156KM_156KM_3 = 3

• GHP_39KM_19KM_4 = 4

• GHP_4900M_4900M_5 = 5

• GHP_1200M_609M_6 = 6

• GHP_152M_152M_7 = 7

• GHP_38M_19M_8 = 8

• GHP_480CM_480CM_9 = 9

• GHP_120CM_595MM_10 = 10

• GHP_149MM_149MM_11 = 11

• GHP_37MM_19MM_12 = 12

Used in: GeoGrid, GroupByGeoDistance

• optional double lat = 1

• optional double lon = 2

• optional string field_name = 1

• repeated string points = 2

* HBase supports the following parameters: 1. TimeRange or specified time 2. Filter (for filtering by column value or column name) We only support selection conditions for the same version.

• required string table_name = 1

• required Direction direction = 2

• repeated string columns_to_get = 3

  If not specified, all columns will be read.

• optional TimeRange time_range = 4

• optional int32 max_versions = 5

• optional int32 limit = 6

• required bytes inclusive_start_primary_key = 7

  encoded as InplaceRowChangeSet, but only has primary key

• required bytes exclusive_end_primary_key = 8

  encoded as InplaceRowChangeSet, but only has primary key

• optional bool cache_blocks = 9

  Whether the data read this time is entered into BlockCache

• optional bytes filter = 10

• optional string start_column = 11

• optional string end_column = 12

• optional bytes token = 13

• optional string transaction_id = 14

• optional DataBlockType data_block_type_hint = 15

• optional bool return_entire_primary_keys = 16

• optional CompressType compress_type_hint = 17

• required ConsumedCapacity consumed = 1

• required bytes rows = 2

  encoded as InplaceRowChangeSet

• optional bytes next_start_primary_key = 3

  If it is empty, it means all the data has been read. Encoded as InplaceRowChangeSet, but only contains the primary key.

• optional bytes next_token = 4

• optional DataBlockType data_block_type = 5

• optional CompressType compress_type = 6

* 1. Supports users specifying a version timestamp range or a specific version time to read the designated version of columns. 2. Currently, breakpoints within a row are not supported.

• required string table_name = 1

• required bytes primary_key = 2

  encoded as InplaceRowChangeSet, but only has primary key

• repeated string columns_to_get = 3

  If not specified, all columns will be read.

• optional TimeRange time_range = 4

• optional int32 max_versions = 5

• optional bool cache_blocks = 6

  Whether the data read this time enters the BlockCache

• 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

  encoded as InplaceRowChangeSet

• optional bytes next_token = 3

• required string stream_id = 1

• required string shard_id = 2

• optional int64 timestamp = 3

• optional string token = 4

• required string shard_iterator = 1

• optional string next_token = 2

• required string shard_iterator = 1

• optional int32 limit = 2

• optional string table_name = 3

• optional NewRowReturnPolicy new_row_return_policy = 4

• optional bool return_sys_columns = 5

• repeated GetStreamRecordResponse.StreamRecord stream_records = 1

• optional string next_shard_iterator = 2

• optional ConsumedCapacity consumed = 3

• optional bool may_more_record = 4

• optional int64 version_generator_value = 5

Used in: StreamRecord

• optional bool has_new_row = 1

  Used to distinguish between a non-existent row and an empty row(only PK).

• optional bytes columns = 2

Used in: GetStreamRecordResponse

• required ActionType action_type = 1

• required bytes record = 2

• optional bytes origin_record = 3

• optional bytes table_name = 4

• optional int64 version_generator_value = 5

• optional NewRowInfo new_row_info = 6

• optional bytes sys_columns = 7

• 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: BindGlobalTableResponse, CreateGlobalTableResponse, DescribeGlobalTableResponse, UnbindGlobalTableResponse

• G_INIT = 1

• G_RE_CONF = 2

• G_ACTIVE = 3

Used in: GroupBys

• optional string name = 1

• optional GroupByType type = 2

• optional bytes body = 3

• optional GroupBys sources = 1

• optional int32 size = 2

• optional Aggregations sub_aggs = 4

• optional GroupBys sub_group_bys = 5

• optional string next_token = 6

• optional int32 suggested_size = 7

• repeated GroupByCompositeResultItem group_by_composite_result_items = 1

• repeated string source_group_by_names = 2

• optional string next_token = 3

Used in: GroupByCompositeResult

• repeated string keys = 1

• repeated bool is_null_keys = 5

• optional int64 row_count = 2

• optional AggregationsResult sub_aggs_result = 3

• optional GroupBysResult sub_group_bys_result = 4

• optional string field_name = 1

• optional DateTimeValue interval = 2

• optional FieldRange field_range = 3

• optional bytes missing = 4

• optional int64 min_doc_count = 5

• optional string time_zone = 6

• optional GroupBySort sort = 7

• optional Aggregations sub_aggs = 8

• optional GroupBys sub_group_bys = 9

Used in: GroupByDateHistogramResult

• optional int64 timestamp = 1

• optional int64 row_count = 2

• optional AggregationsResult sub_aggs_result = 3

• optional GroupBysResult sub_group_bys_result = 4

• repeated GroupByDateHistogramItem group_by_date_histogram_items = 1

• 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

group by result

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 from = 1

• optional double 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 GeoHashPrecision precision = 2

• optional int64 size = 3

• optional Aggregations sub_aggs = 4

• optional GroupBys sub_group_bys = 5

• repeated GroupByGeoGridResultItem group_by_geo_gird_result_items = 1

Used in: GroupByGeoGridResult

• optional string key = 1

• optional GeoGrid geo_grid = 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 = 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 from = 1

• optional double 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: GroupByDateHistogram, 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

• GROUP_BY_DATE_HISTOGRAM = 6

• GROUP_BY_GEO_GRID = 7

• GROUP_BY_COMPOSITE = 8

Used in: GroupByComposite, GroupByDateHistogram, GroupByField, GroupByFilter, GroupByGeoDistance, GroupByGeoGrid, GroupByHistogram, GroupByRange, SearchQuery

• repeated GroupBy group_bys = 1

Used in: GroupByCompositeResultItem, GroupByDateHistogramItem, GroupByFieldResultItem, GroupByFilterResultItem, GroupByGeoDistanceResultItem, GroupByGeoGridResultItem, GroupByHistogramItem, GroupByRangeResultItem

• repeated GroupByResult group_by_results = 1

group agg

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, TableMeta

• 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

• optional IndexSyncPhase index_sync_phase = 6

Used in: FieldSchema

• DOCS = 1

• FREQS = 2

• POSITIONS = 3

• OFFSETS = 4

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

• ISP_INVALID = 0

• ISP_FULL = 1

• ISP_INCR = 2

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 tableName = 1

• repeated DeliveryTaskInfo tasks = 1

• optional string table_name = 1

• repeated IndexInfo indices = 1

• optional string table_name = 1

• repeated Stream streams = 1

############################################# ListTable #############################################

(message has no fields)

* Currently, only a simple list of names is returned. We need to discuss whether there are any business scenarios that require obtaining information other than the table name. The other information can include reserved throughput and table status; however, this information can only be rough. Detailed table information still needs to be obtained through DescribeTable.

• repeated string table_names = 1

(message has no fields)

• repeated TimeseriesTableMeta table_metas = 1

############################################# LoadTable #############################################

• 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

Used in: DescribeSearchIndexResponse

• optional int64 storage_size = 1

• optional int64 row_count = 2

• optional int64 reserved_read_cu = 3

• optional int64 timestamp = 4

• optional string field_name = 1

• optional bytes missing = 2

• optional double value = 1

Used in: DecayFunction

• MVM_MAX = 1

• MVM_MIN = 2

• MVM_SUM = 3

• MVM_AVG = 4

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 InnerHits inner_hits = 5

Used in: GetStreamRecordRequest

• NO_NEW_ROW = 1

• WITH_NEW_ROW = 2

  for row version table, return new row for update operation

• NEW_ROW_ONLY = 3

  for row version table, only return new row for update operation

Used in: CreateDeliveryTaskRequest, DescribeDeliveryTaskResponse, UpdateDeliveryTaskRequest

• optional string ossPrefix = 1

• optional TimeFormatter formatter = 2

• optional string ossDirtyPrefix = 3

• optional string ossBucket = 4

• optional string ossEndpoint = 5

• optional string ossStsRole = 6

• optional EventColumn eventTimeColumn = 7

• optional Format format = 8

• repeated ParquetSchema schema = 11

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 timeoutMs = 6

• repeated bytes rows = 1

• optional bytes next_token = 2

Used in: OSSTaskConfig

• optional string columnName = 1

• optional string ossColumnName = 2

• optional ParquetSchema.DataType type = 3

  parquet logical type

• optional Encoding encode = 4

• optional string typeExtend = 5

Used in: ParquetSchema

• BOOL = 0

• INT64 = 1

• UTF8 = 2

• DOUBLE = 3

• DATE = 4

• DECIMAL = 5

• TIME_MILLIS = 6

• TIME_MICROS = 7

• TIMESTAMP_MILLIS = 8

• TIMESTAMP_MICROS = 9

• LIST = 10

• MAP = 11

• INTERVAL = 12

• FLOAT = 13

• INT32 = 14

• INT96 = 15

Used in: CreateTableRequest

• required bytes begin = 1

  encoded as SQLVariant

• required bytes end = 2

  encoded as SQLVariant

• optional string field_name = 1

• repeated double percentiles = 2

• optional bytes missing = 3

Used in: PercentilesAggregationResult

• optional double key = 1

• optional bytes value = 2

• repeated PercentilesAggregationItem percentiles_aggregation_items = 1

Used in: DescribeGlobalTableRequest, DescribeGlobalTableResponse

• required string regionId = 1

• required string instanceName = 2

• required string tableName = 3

• required bool writable = 4

• optional PhyTableStatus status = 5

• optional int64 statusTimestamp = 6

• optional string tableId = 7

• optional SyncStage stage = 10

  optional int32 tableHashKey = 8; optional string endpoint = 9;

• optional bool isFailed = 12

  optional int64 metaVersion = 11;

• optional string message = 13

• optional string role = 14

• optional int64 rpoNanos = 15

Used in: PhyTable

• PHY_PENDING = 1

• PHY_INIT = 2

• PHY_SYNCDATA = 3

• PHY_READY = 4

• PHY_ACTIVE = 5

• PHY_UNBINDING = 6

• PHY_UNBOUND = 7

Used in: BindGlobalTableRequest, CreateGlobalTableRequest

• required string regionId = 1

• required string instanceName = 2

• required bool writable = 3

• optional string field_name = 1

• optional string prefix = 2

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

* Here, users are allowed to set the timestamp for each column individually, rather than being forced to use a uniform timestamp for the entire row. The reason is that all columns use a unified structure, which itself includes a timestamp. Enforcing a uniform timestamp increases standardization but reduces flexibility, and this standardization does not provide any obvious benefits while adding complexity to the structure.

• required string table_name = 1

• required bytes row = 2

  encoded as InplaceRowChangeSet

• 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, Function, FunctionScoreQuery, FunctionsScoreQuery, GroupByFilter, KnnVectorQuery, NestedFilter, NestedQuery, ScanQuery, SearchFilter, SearchQuery

• optional QueryType type = 1

• optional bytes query = 2

Update Search Index

Used in: DescribeSearchIndexResponse, UpdateSearchIndexRequest

• optional string index_name = 1

• optional int32 weight = 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

query

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

• FUNCTIONS_SCORE_QUERY = 18

• DIS_MAX_QUERY = 20

Used in: Function

(message has no fields)

Used in: GroupByGeoDistance, GroupByRange

• optional double from = 1

• optional double to = 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: UnbindGlobalTableRequest

• required string regionId = 1

• required string instanceName = 2

Used in: CreateTableRequest, SearchConsumedCapacity, TableConsumedCapacity, UpdateTableRequest

• required CapacityUnit capacity_unit = 1

Used in: DescribeTableResponse, UpdateTableResponse

• required CapacityUnit capacity_unit = 1

  The reserved throughput value of the table.

• required int64 last_increase_time = 2

  The time of the last increase in reserved throughput.

• optional int64 last_decrease_time = 3

  The time of the last reduction in reserved throughput.

• optional string request_id = 1

• optional string msg = 2

• required ResultCode code = 3

Used in: Response

• OK = 1

• INVALID_PARAM = 2

• SERVER_ERROR = 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

  encoded as InplaceRowChangeSet

• optional bytes next_token = 5

Used in: TableInBatchWriteRowRequest

• required OperationType type = 1

• required bytes row_change = 2

  encoded as InplaceRowChangeSet

• required Condition condition = 3

• optional ReturnContent return_content = 4

• optional int64 row_version = 5

• optional bytes source_id = 6

Used in: TableInBatchWriteRowResponse

• required bool is_ok = 1

• optional Error error = 2

• optional ConsumedCapacity consumed = 3

• optional bytes row = 4

Used in: TimeseriesRows

• RST_FLAT_BUFFER = 0

• RST_PLAIN_BUFFER = 1

• RST_PROTO_BUFFER = 2

SQLQuery

Used in: SQLQueryRequest, SQLQueryResponse

• SQL_PLAIN_BUFFER = 1

• SQL_FLAT_BUFFERS = 2

• required string query = 1

• optional SQLPayloadVersion version = 2

• optional int64 sql_version = 3

• optional string search_token = 5

• repeated TableConsumedCapacity consumes = 1

• optional bytes rows = 2

• optional SQLPayloadVersion version = 3

• optional SQLStatementType type = 4

• repeated SearchConsumedCapacity search_consumes = 5

• optional int64 affected_rows = 6

• optional string next_search_token = 8

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

ParallelScan API, same to Search API

• 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

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: SearchQuery

• optional Query query = 1

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 getTotalCount = 8

• optional bytes token = 9

• optional Aggregations aggs = 10

• optional GroupBys group_bys = 11

• optional Highlight highlight = 12

• optional SearchFilter filter = 14

• 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 timeoutMs = 6

• optional int64 total_hits = 1

• repeated bytes rows = 2

• optional bool is_all_succeeded = 3

• repeated SearchHit search_hits = 5

• optional bytes next_token = 6

• optional bytes aggs = 7

• optional bytes group_bys = 8

• optional ConsumedCapacity consumed = 9

• optional ConsumedCapacity reserved_consumed = 10

Used in: CreateGlobalTableRequest, CreateGlobalTableResponse, DescribeGlobalTableResponse

• PRIMARY_SECONDARY = 2

  HOT_STANDBY = 1;

• PEER_TO_PEER = 3

• 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

• optional bool disable_default_pk_sorter = 2

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

########################################### LocalTransaction ###########################################

• required string table_name = 1

• required bytes key = 2

  encoded as SQLVariant

• 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

• repeated string columns_to_get = 5

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

• repeated string columns_to_get = 3

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: CreateGlobalTableRequest

• SYNC_MODE_ROW = 1

• SYNC_MODE_COLUMN = 2

Used in: SyncStat

• FULL = 1

• INCR = 2

Used in: PhyTable

• SYNC_INIT = 1

• SYNC_FULL = 2

• SYNC_INCR = 3

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

* In HBase, each row in a Batch operation can have different query parameters, which is not supported by OTS.

Used in: BatchGetRowRequest

• required string table_name = 1

• repeated bytes primary_key = 2

  encoded as InplaceRowChangeSet, but only has primary key

• repeated bytes token = 3

• repeated string columns_to_get = 4

  If not specified, all columns will be read.

• optional TimeRange time_range = 5

• optional int32 max_versions = 6

• optional bool cache_blocks = 7

  Whether the data read this time enters the BlockCache

• 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

• repeated IndexMeta index_meta = 4

• optional string table_id = 5

• optional string global_table_id = 6

• optional string global_table_source_id = 7

Used in: CreateTableRequest, DescribeTableResponse, UpdateTableRequest, UpdateTableResponse

• optional int32 time_to_live = 1

  Can be dynamically changed

• optional int32 max_versions = 2

  Can be dynamically changed

• optional BloomFilterType bloom_filter_type = 3

  Can be dynamically changed

• optional int32 block_size = 4

  Can be dynamically changed

• optional int64 deviation_cell_version_in_sec = 5

  Can be dynamically modified

• optional bool allow_update = 6

• optional bool update_full_row = 7

  Cannot be dynamically modified

* Table status changes only correspond to user operations; internal machine failovers or other conditions do not result in table status changes. There are three considerations: One, in general scenarios, users will only check the table's status after performing a modification operation on the table; Two, there is a delay between the time when an internal machine failover causes access anomalies and when the user can see the table's status change. It is impossible to fully match the table's unserviceable state with the state the user observes. Three, after an internal machine failover, it should not be considered as a change in the entire table's state but rather as a state change of a partition. The corresponding table state would be PARTIAL_FAILOVER. However, the granularity of this "partial" cannot be clearly represented, which might confuse users even more.

Used in: DescribeTableResponse

• ACTIVE = 1

  The table is in a servable state.

• INACTIVE = 2

  The user disables the table through UnloadTable.

• LOADING = 3

  The table is being created, and the partition has not been fully loaded yet; or the table has just been enabled from the INACTIVE state.

• UNLOADING = 4

  The table is being deleted (during the period from delete table to partition completely unloaded) or the table is unloaded from ACTIVE status.

• UPDATING = 5

  The table is being updated (table property changes, reserved throughput changes).

Used in: DescribeDeliveryTaskResponse

• optional TaskSyncStat.TaskSyncPhase task_sync_phase = 1

• optional int64 current_sync_timestamp = 2

  Synchronize progress, refer to TunnelService.

• optional ErrorType error_code = 3

  UnAuthorized/InvalidOssBucket...

• optional string detail = 4

Used in: TaskSyncStat

• INIT = 0

• FULL = 1

• INCR = 2

• optional string field_name = 1

• optional bytes term = 2

• optional string field_name = 1

• repeated bytes terms = 2

Used in: FieldSchema

• BM25 = 1

• SHORT_TEXT = 2

Used in: OSSTaskConfig

• YDMFormatter = 0

* The minimum value for the timestamp is 0, and the maximum value is INT64.MAX. 1. To query a range, specify start_time and end_time. 2. To query a specific timestamp, specify specific_time.

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

  The name of the storage

• optional int32 time_to_live = 2

  Data storage TTL

• optional AnalyticalStoreSyncType sync_option = 3

  Full or incremental build

Used in: TimeseriesRow

• optional string field_name = 1

• optional int64 value_int = 2

• optional string value_string = 3

• optional bool value_bool = 4

• optional double value_double = 5

• optional bytes value_binary = 6

Used in: GetTimeseriesDataRequest

• optional string name = 1

• optional int32 type = 2

Used in: DeleteTimeseriesMetaRequest, GetTimeseriesDataRequest, TimeseriesMeta, TimeseriesRow