文档

数组和嵌套类型

更新时间:

多元索引除了提供Long、Double、Boolean、Keyword、Text、Date、GeoPoint、Vector等基本类型外,还提供了数组类型和嵌套类型两种特殊类型。数组类型适用于存储一系列相同类型的数据,嵌套类型适用于存储具有层级结构的数据,类似于JSON。

数组类型

重要
  • 数组类型仅是多元索引中的概念,数据表中还未支持数组。

  • 向量Vector类型暂时不支持数组。

数组类型属于附加类型,可以附加在Long、Double、Boolean、Keyword、Text、Date、Geopoint等基本类型之上。例如Long类型+数组后,即为长整型数组,该字段中可以包括多个长整型数字,查询数据时其中任何一个匹配都可以返回该行数据。数据类型适用于存储一系列相同类型的数据。

数组格式

多元索引的基本类型数组格式请参见下表。

数组类型

说明

Long Array

长整型的数组形式,格式为"[1000, 4, 5555]"

Double Array

浮点数的数组形式,格式为"[3.1415926, 0.99]"

Boolean Array

布尔值的数组形式,格式为"[true, false]"

Keyword Array

字符串的数组形式,格式为JSON Array,例如"[\"杭州\", \"西安\"]"

Text Array

文本的数组形式,格式为JSON Array,例如"[\"杭州\", \"西安\"]"

对于Text类型,一般无需使用数组形式。

Date Array

日期的数组形式。如果日期类型为整型,则格式为"[1218197720123, 1712850436000]";如果日期类型为字符串,则格式为"[\"2024-04-11 23:47:16.854775807\", \"2024-06-11 23:47:16.854775807\"]"

Geopoint Array

地理位置点的数组形式,格式为"[\"34.2, 43.0\", \"21.4, 45.2\"]"

使用说明

对于多元索引中数组类型的字段,在数据表中必须为String类型,且对应的多元索引中的类型必须为相应的类型,例如Long、Double等。如果字段price是Double Array数组类型,则在数据表中price必须为String类型,在对应的多元索引中的类型必须为Double类型,且附加isArray=true属性。

嵌套类型

嵌套类型(Nested)代表嵌套文档类型。嵌套文档是指对于一行数据(文档)可以包含多个子行(子文档),多个子行保存在一个嵌套类型字段中。嵌套类型适用于存储具有层级结构的数据。

对于嵌套类型字段,需要指定其子行的结构,即子行中包含哪些字段以及每个字段的属性。嵌套类型也是类似数组的多值结构,但是更接近JSON类型。

嵌套格式

根据数据的层级结构不同,嵌套类型包括单层级嵌套类型和多层级嵌套类型。具体说明请参见下表。

嵌套类型

说明

单层级嵌套类型

在一个数据结构中只包含一层其他数据结构,结构相对简单,能表示一定的层次关系。单层级嵌套类型适用于不需要过多层级但需要一定层级结构的场景。示例如下:

[
    {
        "tagName": "tag1",
        "score": 0.8
    },
    {
        "tagName": "tag2",
        "score": 0.2
    }
]

多层级嵌套类型

在一个数据结构中包含了多层嵌套的其他数据结构,具有更复杂的层次关系。多层级嵌套类型适用于需要表示丰富层次、高度模块化或高度组织化的数据模型。示例如下:

[
    {
        "name": "张三",
        "age": 20,
        "phone": "1390000****",
        "address": [
            {
                "province": "浙江省",
                "city": "杭州市",
                "street": "阳光大道幸福小区1201号"
            }
        ]
    }
]

使用说明

对于多元索引中嵌套类型的字段,在数据表中必须为String类型,且对应的多元索引中的类型必须为嵌套类型。嵌套类型字段只能使用嵌套类型查询功能进行数据查询。

在写入数据到数据表时,多元索引嵌套类型字段对应数据表字段的写入格式必须为JSON对象的数组格式,例如[{"tagName":"tag1", "score":0.8}, {"tagName":"tag2", "score":0.2}]

重要

即使只有一个子行,也必须按照JSON数组的格式构造字符串。

使用示例

单层级嵌套类型示例

单层级嵌套类型支持通过控制台或者SDK进行创建。

以Java代码为例介绍创建单层级嵌套类型。示例中嵌套类型字段的名称为tags,子行中包含两个字段,如下图所示。fig_sample

  • 一个字段名称为tagName,类型为字符串类型(Keyword)。

  • 一个字段名称为score,类型为浮点数(Double)。

写入数据表时的数据样例为[{"tagName":"tag1", "score":0.8}, {"tagName":"tag2", "score":0.2}]

//构造子行的FieldSchema。
List<FieldSchema> subFieldSchemas = new ArrayList<FieldSchema>();
subFieldSchemas.add(new FieldSchema("tagName", FieldType.KEYWORD)
    .setIndex(true).setEnableSortAndAgg(true));
subFieldSchemas.add(new FieldSchema("score", FieldType.DOUBLE)
    .setIndex(true).setEnableSortAndAgg(true));

//将子行的FieldSchema设置到嵌套类型字段的subfieldSchemas中。
FieldSchema nestedFieldSchema = new FieldSchema("tags", FieldType.NESTED)
    .setSubFieldSchemas(subFieldSchemas);

多层级嵌套类型示例

多层级嵌套类型只能通过SDK进行创建。

以Java示例代码为例介绍创建多层级嵌套类型。示例中嵌套类型字段的名称为user,子行中包含三个基础类型字段和一个嵌套类型字段。

  • 一个字段名称为name,类型为字符串类型(Keyword)。

  • 一个字段名称为age,类型为长整型(Long)。

  • 一个字段名称为phone,类型为字符串类型(Keyword)。

  • 一个嵌套类型字段的名称为address,子行中包含的三个字段名称分别为province、city和street,类型均为字符串类型(Keyword)。

写入数据表时的数据样例为[ {"name":"张三","age":20,"phone":"1390000****","address":[{"province":"浙江省","city":"杭州市","street":"阳光大道幸福小区1201号"}]}]

//构造嵌套类型字段address的子行FieldSchema,子行中包含三个字段。查询子行中字段的数据时,子行中字段的路径为user.address。
List<FieldSchema> addressSubFiledSchemas = new ArrayList<>();
addressSubFiledSchemas.add(new FieldSchema("province",FieldType.KEYWORD));
addressSubFiledSchemas.add(new FieldSchema("city",FieldType.KEYWORD));
addressSubFiledSchemas.add(new FieldSchema("street",FieldType.KEYWORD));

//构造嵌套类型字段user的子行FieldSchema,子行中包含三个基础类型字段和一个嵌套类型字段address。查询子行中字段的数据时,子行中字段的路径为user。
List<FieldSchema> subFieldSchemas = new ArrayList<>();
subFieldSchemas.add(new FieldSchema("name",FieldType.KEYWORD));
subFieldSchemas.add(new FieldSchema("age",FieldType.LONG));
subFieldSchemas.add(new FieldSchema("phone",FieldType.KEYWORD));
subFieldSchemas.add(new FieldSchema("address",FieldType.NESTED).setSubFieldSchemas(addressSubFiledSchemas));

//将嵌套类型字段user的子行FieldSchema设置到嵌套类型字段的subfieldSchemas中。
List<FieldSchema> fieldSchemas = new ArrayList<>();
fieldSchemas.add(new FieldSchema("user",FieldType.NESTED).setSubFieldSchemas(subFieldSchemas));

嵌套类型的局限性

  • 由于含有嵌套类型字段的多元索引不支持索引预排序(IndexSort),而索引预排序功能在很多场景下可以带来很大性能提升。

  • 如果使用含有嵌套类型字段的多元索引查询数据且需要翻页,则必须在查询条件中指定数据返回的排序方式,否则当符合查询条件的数据未读取完时,服务端不会返回nextToken。

  • 嵌套类型的查询性能相比其他类型的查询性能更低一些。

嵌套类型除了上述局限性外,和非嵌套类型支持的功能相同,支持所有的查询类型、排序和统计聚合。

相关文档