Definition of data types in Tablestore - Tablestore - Alibaba Cloud Documentation Center

This topic describes the definition of data types that are involved in Tablestore API operations.

List of data types

The following table describes the definition of data types that are involved in Tablestore API operations.

Data type	Description
ActionType	The operation type in the response to the GetStreamRecord operation.
Aggregation	The configurations of a single aggregation.
AggregationResult	The returned results of a single aggregation.
Aggregations	The aggregation configurations.
AggregationsResult	The returned aggregation results.
AggregationType	The type of the aggregation.
AvgAggregation	Specifies the aggregation operation of the search index feature that is used to obtain the average value of a field. This operation is similar to the AVG function in SQL.
BoolQuery	Specifies the Boolean query configuration. You can use BoolQuery to query the rows based on one or more subqueries. Tablestore returns the rows that match the subqueries. A subquery can be of any type, including BoolQuery.
CapacityUnit	The number of capacity units (CUs) that are consumed by an operation or the reserved read or write throughput that is specified for a table.
ChannelInfo	The channel information in the response to the DescribeTunnel operation.
Collapse	The column configuration for the collapse (distinct) feature.
ColumnPaginationFilter	The filter conditions for wide-column read operations.
ComparatorType	The relational operator.
ColumnReturnType	The type of the column that you want to return.
ColumnsToGet	The columns that you want to return.
CompositeColumnValueFilter	The composite conditions, such as `column_a > 5 AND column_b = 10`. CompositeColumnValueFilter is used for the conditional update and filter features.
Condition	The condition that must be met before you can call the PutRow, UpdateRow, or DeleteRow operation to perform specific operations on a row.
ConsumedCapacity	The number of CUs consumed by the operation.
CountAggregation	Returns the total number of values for a specific field or the total number of rows in a search index. This method can be used in a similar manner as the COUNT function in SQL.
DataBlockType	The encoding type of the returned data block.
DateTimeUnit	The unit of the statistical interval.
DateTimeValue	The configurations of the statistical interval.
DefinedColumnSchema	The schema of the predefined column.
DefinedColumnType	The type of the predefined column.
Direction	The data query order in the GetRange operation.
DistinctCountAggregation	The aggregation operation of the search index feature that is used to return the number of distinct values of a field. This operation is similar to the `COUNT(DISTINCT)` function in SQL.
Error	The error message returned in the response when an operation fails. Error also specifies the single-row operation errors returned in the response to the BatchGetRow, BatchWriteRow, and BulkImport operations.
ExistsQuery	The configurations of an exists query. An exists query is also called a NULL query or NULL-value query. This query is used in sparse data to determine whether a column of a row exists. For example, you can query the rows in which the value of the address column is not empty.
FailedRowInfo	The information about the row that failed to be written.
FieldRange	The statistical range.
FieldSchema	The configurations of all index fields in a search index.
FieldSort	The sorting configuration for a field in a search index.
FieldType	The type of a field in a search index.
Filter	The column-based conditions, which are used for the conditional update and filter features.
FilterType	The type of the conditional update or filter feature.
FuzzyAnalyzerParameter	The optional configurations in the search index when fuzzy tokenization is used.
GeoBoundingBoxQuery	The configurations of a geo-bounding box query. You can specify a rectangular geographical area as a query condition. Tablestore returns the rows in which the value of the specified column falls within the rectangular geographical area.
GeoDistanceQuery	The configurations of a geo-distance query. You can specify a circular geographical area that consists of a central point and radius as a query condition. Tablestore returns the rows in which the value of the specified column falls within the geographical circular area.
GeoDistanceSort	The sorting method based on geographic locations.
GeoDistanceType	The distance calculation method.
GeoPoint	The longitude and latitude of the central point.
GroupByDateHistogram	Groups query results based on specific date intervals. Field values that are within the same range are grouped together. The value range of each group and the number of values in each group are returned.
GroupByDateHistogramItem	The grouping results returned for a single range in the date histogram.
GeoPolygonQuery	The configurations of a geo-polygon query. You can specify a polygonal geographical area as a query condition. Tablestore returns the rows in which the value of the specified column falls within the polygonal geographical area.
GroupBy	The configuration of a single group.
GroupByField	Groups query results by field value. You can use this aggregation method to group query results based on the values of a specific field. The values that are the same are grouped together. The identical value of each group and the number of identical values in each group are returned.
GroupByFieldResultItem	The grouping results returned for a single field value when you group query results by field value.
GroupByHistogram	Groups query results based on specific data intervals. Field values that are within the same range are grouped together. The value range of each group and the number of values in each group are returned.
GroupByHistogramItem	The grouping results returned for a single range in the histogram.
GroupByFilter	Groups query results based on specific filter conditions and returns results in the order in which the filter conditions are specified.
GroupByFilterResultItem	The grouping results returned for a single filter condition when you group query results based on filter conditions.
GroupByGeoDistance	Groups query results based on geographical locations. You can group query results based on the distance from a central point. Field values that are within the same distance range are grouped together. The value range of each group and the number of values in each group are returned.
GroupByGeoDistanceResultItem	The grouping results returned for a single range when you group query results based on geographical locations.
GroupByRange	Groups query results by range. You can use this aggregation method to group query results based on the value range of a field. Values that are within the same range are grouped together. The identical value of each group and the number of values in each group are returned.
GroupByRangeResultItem	The grouping results returned for a single range when you group query results by range.
GroupByResult	The returned results of a single GroupBy operation.
GroupBys	The grouping configurations of the returned results of a search index.
GroupBySort	The sorting method set for values in the group.
GroupBySorter	The sorting method for values in the group. By default, row_count_sort is used.
GroupBysResult	The returned results of the GroupBy operation.
GroupByType	The type of the group.
GroupKeySort	The sorting rule for the field values in each group.
Highlight	The summary and highlight configurations.
HighlightEncoder	The encoding method for the highlighted text fragments.
HighlightField	The information about the highlighted text fragments of a field.
HighlightFragmentOrder	The sorting rule for the highlighted text fragments that you want to return.
HighlightParameter	The highlight parameters.
HighlightResult	The highlighted results of a non-Nested field.
IndexInfo	The list of search indexes.
IndexMeta	The schema of the index table.
IndexSchema	The schema of the search index, including the configuration information such as all index fields and options, and the presorting rule of the search index.
IndexSetting	The configuration information of the search index, such as the routing fields.
IndexSyncPhase	The information about the index synchronization phase.
IndexType	The type of the index.
IndexUpdateMode	The index update mode.
InnerHits	The settings of the subfields of the Nested field.
KnnVectorQuery	Uses the k-nearest neighbor (KNN) vector query feature to perform an approximate nearest neighbor search based on vectors. This way, you can find data items that have the highest similarity to the vector that you want to query in a large-scale dataset.
LogicalOperator	The logical operator.
MatchAllQuery	The configurations of a match all query. You can query the total number of rows in a table or return several random rows by using the match all query feature to match all rows in the table.
MatchPhraseQuery	The configurations of a match phrase query. You can use match phrase query to query data in a table based on approximate matches. Match phrase query evaluates the positions of tokens. A row meets the query condition only when the order and positions of the tokens in the row match the order and positions of the tokens that are contained in the keyword.
MatchQuery	The configurations of a match query. You can use the match query feature to query data in a table based on approximate matches.
MaxAggregation	The aggregation operation of the search index feature that is used to return the maximum value of a field. This operation is similar to the MAX function in SQL.
MetaQueryCondition	The condition that is used to retrieve the time series metadata.
MetaQueryConditionType	The type of condition that is used to retrieve the time series metadata.
MetaUpdateMode	The update mode for time series metadata.
MetaUpdateStatus	The metadata update status.
MeteringInfo	The metering information of the search index.
MinAggregation	The aggregation operation of the search index feature that is used to return the minimum value of a field. This operation is similar to the MIN function in SQL.
NestedFilter	The filtering condition for a Nested field.
NestedQuery	The configurations of a nested query. You can use the nested query feature to query the data in the child rows of Nested fields. Nested fields cannot be directly queried. To query a Nested field, you must specify the path of the Nested field and a subquery in a NestedQuery object. The subquery can be a query of any type.
PercentilesAggregation	The percentile statistics of the aggregation feature in search indexes. A percentile value indicates the relative position of a value in a dataset. For example, when you collect statistics for the response time of each request during the routine O&M of your system, you must analyze the response time distribution by using percentiles such as p25, p50, p90, and p99.
PercentilesAggregationItem	The information about a percentile in percentile statistics.
OperationType	The modification method for one column in the UpdateRow and BulkImport operations.
PartitionRange	The partition range.
PlainBuffer	Compared with Protocol Buffer, PlainBuffer delivers better performance for serialization and parsing of small objects. Therefore, PlainBuffer is used to format data in Tablestore.
PrefixQuery	The configurations of a prefix query. You can use the prefix query feature to query data that contains a specific prefix. If the field used to match the prefix is a Text field, the field values are tokenized. A row meets the query conditions when at least one token contains the specified prefix.
PrimaryKeySort	The order in which the primary key is sorted.
PrimaryKeyOption	The attribute of a primary key column. Only AUTO_INCREMENT is supported.
PrimaryKeySchema	The configurations of a primary key column.
PrimaryKeyType	The type of a primary key column.
Query	The query condition of the search index.
QueryFlowWeight	The weight configuration for data queries.
QueryOperator	The query operator.
QueryType	The query type of the search index.
Range	The range configuration information of a single group.
RangeQuery	The configurations of a range query. You can use the range query feature to query data that falls within the specified range. If the type of a field is Text, Tablestore tokenizes the string. A row meets the query conditions when at least one of the tokens falls within the specified range.
ReservedThroughput	The reserved read and write throughput specified for a table.
ReservedThroughputDetails	The information about reserved read and write throughput for a table.
ReturnContent	The returned data.
ReturnType	The type of the returned data.
RowCountSort	Sorts the groups based on the number of rows in each group.
RowExistenceExpectation	The row existence condition.
RowInBatchGetRowResponse	The row of data in the response to the BatchGetRow operation.
RowInBatchWriteRowRequest	The information about the row that you want to insert, update, or delete by calling the BatchWriteRow operation.
RowInBatchWriteRowResponse	The write operation result for a row in the response to the BatchWriteRow operation.
RowInBulkImportRequest	The information about the row that you want to insert, update, or delete by calling the BulkImport operation.
RowInBulkImportResponse	The result of a batch write operation in the response to the BulkImport operation.
RowsSerializeType	The serialization type for rows of time series data.
ScanQuery	The scanning configurations that you specify when you call the ParallelScan operation.
SearchHit	The returned data that meets the query conditions. The return value exists only when you use the highlight or KNN vector query feature.
SearchInnerHit	The information about the highlighted text fragments of a Nested field.
SearchIndexSplitsOptions	The configuration information of the search index in the ComputeSplits operation.
SearchQuery	The query configurations that are specified when you call the Search operation of search indexes.
ScoreSort	The order in which the scores are sorted.
Sort	The presorting method of the search index or the sorting method of the returned results.
Sorter	The presorting method of the index. The default presorting method of an index that contains no Nested field is PrimaryKeySort. By default, no presorting method is specified for an index that contains Nested fields.
SortMode	The sorting method when a field has multiple values. You can sort the fields based on the maximum value, minimum value, or average value.
SortOrder	The order in which field values are sorted. You can sort field values in descending or ascending order.
SingleColumnValueFilter	A single filter condition, such as `column_a>5`. SingleColumnValueFilter is suitable for the conditional update and filter features.
SingleWordAnalyzerParameter	The optional configurations in the search index when single-word tokenization is used.
SQLPayloadVersion	The encoding method of the data returned after you call the SQLQuery operation.
SQLStatementType	The type of the SQL statement in the returned result of the SQLQuery operation.
SplitAnalyzerParameter	The optional configurations in the search index when delimiter tokenization is used.
SSEDetails	The information about server-side encryption.
SSEKeyType	The type of the encryption key.
StartOffsetFlag	The start offset.
Stream	The Stream information.
StreamDetails	The Stream information of a table.
SplitLocation	The location of the split point.
StreamRecord	The row of data in the response to the GetStreamRecord operation.
StreamTunnelConfig	The Stream configuration of the tunnel.
StreamShard	The shard information of the Stream.
StreamSpecification	The Stream information of a table.
SubAggSort	The sorting based on the sub-aggregation results.
SuffixQuery	The configurations of a suffix query. You can perform a suffix query to query data in a search index by specifying suffix conditions. For example, you can query packages based on the last four digits of a mobile phone number.
SumAggregation	The aggregation operation of the search index feature that is used to obtain the sum of values in a field. This operation is similar to the SUM function in SQL.
SyncPhase	The synchronization phase of the search index.
SyncStat	The synchronization status of the search index.
TableConsumedCapacity	The number of CUs consumed by the SQLQuery operation.
TableInBatchGetRowRequest	The configurations for reading data from a single table in the BatchGetRow operation.
TableInBatchGetRowResponse	The data that is read from a table in the response to the BatchGetRow operation.
TableInBatchWriteRowRequest	The configurations for writing, updating, or deleting data in a table in the BatchWriteRow operation.
TableInBatchWriteRowResponse	The write results for a table in the BatchWriteRow operation.
TableMeta	The schema information of a table.
TableOptions	The optional configurations of a table, including the time to live (TTL) of data and the maximum number of versions.
TermQuery	The configurations of a term query. You can use the term query feature to query the rows in which the value of a specific field exactly matches the specified keyword. Term queries is similar to queries based on string matching conditions. If the field used to match the keyword is a Text field, the field values are tokenized. A row meets the query conditions when at least one token matches the keyword.
TermsQuery	The configurations of a terms query. A terms query is similar to a term query. A terms query supports multiple keywords. A row of data is returned when the field value matches at least one of the keywords. Terms queries can be used in the same manner as the IN operator in SQL.
TimeRange	The timestamp range or specific timestamp that is specified for the data query.
TimeseriesFieldsToGet	The name and data type of the time series data column that you want to query.
TimeseriesKey	The identifiers of the time series.
TimeseriesMeta	The time series metadata.
TimeseriesMetaOptions	The configurations of the time series metadata.
TimeseriesRows	The rows of time series data.
TimeseriesTableMeta	The schema and configurations of the time series table.
TimeseriesTableOptions	The configurations of the time series table.
TopRowsAggregation	The aggregation operation that is used to query the rows that are obtained from the results of an aggregation operation in each group. This operation is similar to the ANY_VALUE(field) function in MySQL.
Tunnel	The configuration information of the tunnel.
TunnelInfo	The tunnel information in the response to the ListTunnel and DescribeTunnel operations.
TunnelType	The type of the tunnel.
ValueTransferRule	Converts a string into the String, Integer, or Double type after the string is matched by using a regular expression.
VariantType	The data types after string conversion.
VectorDataType	The data type of the vector.
VectorMetricType	The algorithm that you want to use to measure the distance between vectors.
VectorOptions	The properties of the Vector field.
WildcardQuery	The configurations of a wildcard query. This query retrieves data that matches a string. The string can contain two types of wildcard characters: asterisks () and question marks (?). An asterisk () matches a string of any length at, before, or after a search term. The question mark (?) matches a single character in a specific position. The string to match can start with an asterisk () or a question mark (?). For example, if you search for the "tablee" string, "tablestore" can be matched.