DataType定义

本文为您介绍表格存储API涉及的DataType定义。

DataType列表

表格存储API涉及的DataType定义列表请参见下表。

数据类型	描述
ActionType	在GetStreamRecord的响应消息中表示操作类型。
Aggregation	单个统计聚合配置。
AggregationResult	单个统计聚合Aggregation的返回信息。
Aggregations	统计聚合配置。
AggregationsResult	统计聚合中Aggregation的返回信息。
AggregationType	统计聚合类型。
AnalyticalStoreStorageSize	分析存储大小和统计分析存储大小的时间戳。
AnalyticalStoreSyncStat	分析存储同步状态。
AnalyticalStoreSyncType	分析存储同步类型。在TimeseriesAnalyticalStore中表示分析存储同步选项，在AnalyticalStoreSyncStat中表示分析存储同步状态。
AvgAggregation	在多元索引统计聚合中表示求平均值，用于返回一个字段的平均值，类似于SQL中的avg。
BoolQuery	BoolQuery查询条件包含一个或者多个子查询条件，根据子查询条件来判断一行数据是否满足查询条件。每个子查询条件可以是任意一种Query类型，包括BoolQuery。
CapacityUnit	一次操作消耗服务能力单元的值或是一个表的预留读吞吐量或者预留写吞吐量的值。
ChannelInfo	在DescribeTunnel操作的返回结果中表示Channel信息。
Collapse	折叠去重的列配置。
ColumnPaginationFilter	宽行读取过滤条件。
ComparatorType	关系运算符。
ColumnReturnType	列返回类型。
ColumnsToGet	要返回的列。
CompositeColumnValueFilter	多个组合条件，例如`column_a > 5 AND column_b = 10`等。适用于条件更新（ConditionUpdate）和过滤器（Filter）功能。
Condition	在PutRow、UpdateRow和DeleteRow接口中使用的行判断条件。
ConsumedCapacity	一次操作消耗的服务能力单元。
CountAggregation	在多元索引统计聚合中表示统计行数，用于返回指定字段值的数量或者多元索引数据总行数，类似于SQL中的count。
DataBlockType	返回数据的数据块编码类型。
DateTimeUnit	统计间隔的单位。
DateTimeValue	统计间隔的配置信息。
DefinedColumnSchema	表的预定义列结构定义。
DefinedColumnType	预定义列类型。
Direction	在GetRange操作中，表示查询数据的顺序。
DistinctCountAggregation	在多元索引统计聚合中表示去重统计行数，用于返回指定字段不同值的数量，类似于SQL中的`count（distinct）`。
Error	用于在操作失败时的响应消息中表示错误信息，以及在BatchGetRow、BatchWriteRow、BulkImport操作的响应消息中表示单行请求的错误。
ExistsQuery	列存在性查询配置。ExistsQuery也叫NULL查询或者空值查询，一般用于判断稀疏数据中某一行的某一列是否存在。例如查询所有数据中address列不为空的行。
FailedRowInfo	写入失败的行的信息。
FieldRange	统计范围。
FieldSchema	多元索引所有字段的配置信息。
FieldSort	多元索引中字段排序方式的配置。
FieldType	多元索引中的字段类型。
Filter	列判断条件，适用于条件更新（ConditionUpdate）和过滤器（Filter）功能。
FilterType	条件更新或过滤的类型。
FuzzyAnalyzerParameter	多元索引中分词类型为模糊分词时的可选配置。
GeoBoundingBoxQuery	地理长方形范围查询配置。GeoBoundingBoxQuery根据一个长方形范围的地理位置边界条件查询表中的数据。当一个地理位置点落在给出的长方形范围内时满足查询条件。
GeoDistanceQuery	地理距离查询配置。GeoDistanceQuery根据一个中心点和距离条件查询表中的数据。当一个地理位置点到指定的中心点的距离不超过指定的值时满足查询条件。
GeoDistanceSort	地理位置排序方式。
GeoDistanceType	距离的计算方式。
GeoPoint	起始中心点的经纬度。
GroupByDateHistogram	在多元索引统计聚合中表示日期直方图统计，用于对日期字段类型的数据按照指定间隔对查询结果进行分组，字段值在相同范围内放到同一分组内，返回每个分组的值和该值对应的个数。
GroupByDateHistogramItem	在日期直方图统计的返回结果中表示单个范围的分组信息。
GeoPolygonQuery	地理多边形范围查询配置。GeoPolygonQuery根据一个多边形范围条件查询表中的数据。当一个地理位置点落在指定的多边形范围内时满足查询条件。
GroupBy	单个分组配置。
GroupByField	在多元索引统计聚合中表示字段值分组，用于根据一个字段的值对查询结果进行分组，相同的字段值放到同一分组内，返回每个分组的值和该值对应的个数。
GroupByFieldResultItem	在字段值分组的返回结果中表示单个字段值的分组信息。
GroupByHistogram	在多元索引统计聚合中表示直方图统计，用于按照指定数据间隔对查询结果进行分组，字段值在相同范围内放到同一分组内，返回每个分组的值和该值对应的个数。
GroupByHistogramItem	在直方图统计的返回结果中表示单个范围的分组信息。
GroupByFilter	在多元索引统计聚合中表示过滤条件分组，用于按照过滤条件对查询结果进行分组，获取每个过滤条件匹配到的数量，返回结果的顺序和添加过滤条件的顺序一致。
GroupByFilterResultItem	在过滤条件分组的返回结果中表示单个过滤条件的分组信息。
GroupByGeoDistance	在多元索引统计聚合中表示地理位置分组，用于根据距离某一个中心点的范围对查询结果进行分组，距离差值在某范围内放到同一分组内，返回每个范围中相应的item个数。
GroupByGeoDistanceResultItem	在地理位置分组的返回结果中表示单个范围的分组信息。
GroupByRange	在多元索引统计聚合中表示范围分组，用于根据一个字段的范围对查询结果进行分组，字段值在某范围内放到同一分组内，返回每个范围中相应的item个数。
GroupByRangeResultItem	在范围分组的返回结果中表示单个范围的分组信息。
GroupByResult	单个统计聚合GroupBy的返回信息。
GroupBys	多元索引返回结果的分组配置。
GroupBySort	分组中的item排序规则集。
GroupBySorter	分组中的item排序规则，默认按照row_count_sort排序。
GroupBysResult	GroupBy的返回信息。
GroupByType	分组类型。
GroupKeySort	按照分组对应值排序的排序规则。
Highlight	摘要与高亮配置。
HighlightEncoder	对高亮分片原文内容的编码方式。
HighlightField	字段的高亮分片信息。
HighlightFragmentOrder	当高亮字段返回多个分片时，分片的排序规则。
HighlightParameter	字段高亮参数。
HighlightResult	非嵌套类型字段的高亮分片结果。
IndexInfo	索引列表信息。
IndexMeta	索引表的schema。
IndexSchema	多元索引的结构信息，包括索引的所有字段、索引选项、索引预排序等配置信息。
IndexSetting	多元索引的路由字段等配置信息。
IndexSyncPhase	索引同步阶段的信息。
IndexType	索引类型。
IndexUpdateMode	索引更新模式。
InnerHits	嵌套类型字段的子列的配置参数。
KnnVectorQuery	KnnVectorQuery使用数值向量进行近似最近邻查询，可以在大规模数据集中找到最相似的数据项。
LastpointIndexMetaForCreate	Lastpoint索引配置信息，用于创建Lastpoint索引。
LogicalOperator	逻辑操作符。
MatchAllQuery	全匹配查询配置。MatchAllQuery可以匹配所有行，常用于查询表中数据总行数，或者随机返回几条数据。
MatchPhraseQuery	短语匹配查询配置。短语匹配查询采用近似匹配的方式查询表中的数据，但是分词后多个词的位置关系会被考虑，只有分词后的多个词在行数据中以同样的顺序和位置存在时，才表示行数据满足查询条件。
MatchQuery	匹配查询配置。匹配查询采用近似匹配的方式查询表中的数据。
MaxAggregation	在多元索引统计聚合中表示求最大值，用于返回一个字段中的最大值，类似于SQL中的max。
MetaQueryCondition	时间线元数据的检索条件。
MetaQueryConditionType	时间线元数据检索条件的类型。
MetaUpdateMode	时序元数据的更新模式。
MetaUpdateStatus	元数据更新状态。
MeteringInfo	多元索引的计量信息。
MinAggregation	在多元索引统计聚合中表示求最小值，用于返回一个字段中的最小值，类似于SQL中的min。
NestedFilter	嵌套类型字段的过滤条件。
NestedQuery	嵌套类型查询配置。NestedQuery用于查询嵌套类型字段中子行的数据。嵌套类型不能直接查询，需要通过NestedQuery包装，NestedQuery中需要指定嵌套类型字段的路径和一个子查询，其中子查询可以是任意Query类型。
PercentilesAggregation	在多元索引统计聚合中表示百分位统计，百分位统计常用来统计一组数据的百分位分布情况，例如在日常系统运维中统计每次请求访问的耗时情况时，需要关注系统请求耗时的P25、P50、P90、P99值等分布情况。
PercentilesAggregationItem	在百分位统计返回结果中表示返回的单个百分位信息。
OperationType	在UpdateRow和BulkImport中表示对一列的修改方式。
PartitionRange	分区的范围信息。
PlainBuffer	由于Protocol Buffer序列化和解析小对象的性能很差，因此表格存储自定义了 PlainBuffer 数据格式用来表示行数据。
PrefixQuery	前缀匹配配置。PrefixQuery根据前缀条件查询表中的数据。对于Text类型字段，只要分词后的词条中有词条满足前缀条件即可。
PrimaryKeySort	主键排序方式。
PrimaryKeyOption	主键的属性值，目前仅支持AUTO_INCREMENT。
PrimaryKeySchema	主键列的配置信息。
PrimaryKeyType	主键的类型。
Query	多元索引的查询条件。
QueryFlowWeight	数据查询权重配置。
QueryOperator	查询操作符。
QueryType	多元索引的查询类型。
Range	单个分组的范围配置信息。
RangeQuery	范围查询配置。RangeQuery根据范围条件查询表中的数据。对于Text类型字段，只要分词后的词条中有词条满足范围条件即可。
ReservedThroughput	一个表设置的预留读写吞吐量数值。
ReservedThroughputDetails	一个表的预留读写吞吐量信息。
ReturnContent	返回的数据内容。
ReturnType	返回数据的类型。
RowCountSort	按照分组中总行数排序的排序规则。
RowExistenceExpectation	行存在性判断条件。
RowInBatchGetRowResponse	在BatchGetRow操作的返回结果中表示一行数据。
RowInBatchWriteRowRequest	在BatchWriteRow操作中，表示要插入、更新和删除的一行信息。
RowInBatchWriteRowResponse	在BatchWriteRow操作的返回结果中表示一行写入操作的结果。
RowInBulkImportRequest	在BulkImport操作中，表示要插入、更新和删除的一行信息。
RowInBulkImportResponse	在BulkImport操作的返回结果中表示批量写入操作的结果。
RowsSerializeType	时序数据的行序列化类型。
ScanQuery	在ParallelScan操作中表示扫描查询配置。
SearchHit	返回的命中结果。当使用查询摘要与高亮或向量检索功能进行查询时才有返回值。
SearchInnerHit	嵌套类型字段的高亮分片信息。
SearchIndexSplitsOptions	在ComputeSplits操作中，表示多元索引配置信息。
SearchQuery	多元索引Search接口中的数据查询配置。
ScoreSort	分数排序方式。
Sort	在多元索引中表示索引预排序方式或者返回结果的排序方式。
Sorter	索引的排序方式。非Nested索引默认排序方式是PrimaryKeySort，Nested索引默认是无排序。
SortMode	当字段中存在多个值时的排序方式，支持按照最大值、最小值或者平均值参与排序。
SortOrder	字段的排序顺序，支持升序排列和降序排列。
SingleColumnValueFilter	单个条件，例如`column_a>5`等，适用于条件更新（ConditionUpdate）和过滤器（Filter）功能。
SingleWordAnalyzerParameter	多元索引中分词类型使用单字分词时的可选配置。
SQLPayloadVersion	在SQLQuery操作中表示SQL返回数据的编码方式。
SQLStatementType	在SQLQuery操作的返回结果中，表示SQL语句类型。
SplitAnalyzerParameter	多元索引中分词类型为分隔符分词时的可选配置。
SSEDetails	服务端加密（SSE）细节的相关信息。
SSEKeyType	加密密钥的类型。
StartOffsetFlag	起始偏移量的标记。
Stream	stream的相关信息。
StreamDetails	一个表的stream信息。
SplitLocation	分割点的位置信息。
StreamRecord	在GetStreamRecord的返回结果中，表示一行数据。
StreamTunnelConfig	通道stream的配置信息。
StreamShard	stream流的分片信息。
StreamSpecification	一个表的stream信息。
SubAggSort	按照某个子统计聚合结果排序的排序规则。
SuffixQuery	后缀查询配置。SuffixQuery是通过指定后缀条件查询索引中的数据，例如通过手机尾号后4位查询快递。
SumAggregation	在多元索引统计聚合中表示求和，用于返回数值字段值的总和，类似于SQL中的sum。
SyncPhase	多元索引的同步阶段。
SyncStat	多元索引的同步状态。
TableConsumedCapacity	在SQLQuery操作的返回结果中，表示本次操作消耗的服务能力单元。
TableInBatchGetRowRequest	在BatchGetRow操作中表示单个读取表数据的配置。
TableInBatchGetRowResponse	在BatchGetRow操作的返回结果中表示读取到的表数据。
TableInBatchWriteRowRequest	在BatchWriteRow操作中表示单个写入、更新和删除表数据的配置。
TableInBatchWriteRowResponse	在BatchWriteRow操作中表示对一个表进行写入的结果。
TableMeta	一个表的结构信息。
TableOptions	表的可选配置，包括TimeToLive、最大版本数等。
TermQuery	精确查询配置。TermQuery采用完整精确匹配的方式查询表中的数据，类似于字符串匹配。对于Text类型字段，只要分词后有词条可以精确匹配即可。
TermsQuery	多词精确查询配置。类似于TermQuery，但是TermsQuery可以指定多个查询关键词，查询匹配这些词的数据。多个查询关键词中只要有一个词精确匹配，该行数据就会被返回，等价于SQL中的In。
TimeRange	查询数据时指定的时间戳范围或特定时间戳值。
TimeseriesAnalyticalStore	分析存储配置信息。
TimeseriesFieldsToGet	指定要读取的时序数据列的列名和类型。
TimeseriesKey	时间线标识。
TimeseriesLastpointIndex	Lastpoint索引配置信息。
TimeseriesMeta	时间线元数据。
TimeseriesMetaOptions	时序时间线表的配置信息。
TimeseriesRows	多行时序数据。
TimeseriesTableMeta	时序表的表结构和配置。
TimeseriesTableOptions	时序表的配置信息。
TimeseriesTag	时序时间线标签。
TopRowsAggregation	在多元索引统计聚合中表示获取统计聚合分组中的行，用于在对查询结果进行分组后获取每个分组内的一些行数据，可实现和MySQL中ANY_VALUE(field)类似的功能。
Tunnel	通道的配置信息。
TunnelInfo	在ListTunnel和DescribeTunnel操作的返回结果中表示通道信息。
TunnelType	数据通道类型。
ValueTransferRule	使用正则表达式匹配到字符串后，将字符串转换为String、Integer或者Double类型。
VariantType	字符串转换后的数据类型。
VectorDataType	向量数据类型。
VectorMetricType	向量之间距离度量的算法。
VectorOptions	向量字段类型的属性参数。
WildcardQuery	通配符查询配置。WildcardQuery中要匹配的值可以是一个带有通配符的字符串，目前支持星号（）和半角问号（?）两种通配符。要匹配的值中可以用星号（）代表任意字符序列，或者用半角问号（?）代表任意单个字符，且支持以星号（）或半角问号（?）开头。例如查询“tablee”，可以匹配到“tablestore”。

DataType列表

API概览 2025-04-22 14:34

DataType定义 2025-04-22 14:34

错误码参考 2025-04-22 14:34

错误信息 2025-04-22 14:34

数据表操作 2025-04-22 14:34

CreateTable 2025-04-22 14:34

目录