使用CreateSearchIndex接口在数据表上创建一个多元索引。一个数据表可以创建多个多元索引。

前提条件

  • 已初始化Client。具体操作，请参见初始化。
  • 已创建数据表，且数据表的数据生命周期（time_to_live）必须为-1，最大版本数（max_versions）必须为1。

参数

创建多元索引时，需要指定数据表名称（table_name）、多元索引名称（index_name）和索引的结构信息（schema），其中schema包含field_schemas（Index的所有字段的设置）、index_setting（索引设置）和index_sort（索引预排序设置）。详细参数说明请参见下表。

组成 说明
table_name 数据表名称。
index_name 多元索引名称。
field_schemas field_schema的列表，每个field_schema包含如下内容：
  • field_name（必选）：创建多元索引的字段名，即列名，类型为String。

    多元索引中的字段可以是主键列或者属性列。

  • field_type（必选）：字段类型，类型为FieldType.XXX。更多信息，请参见数据类型映射。
  • is_array（可选）：是否为数组，类型为Boolean。

    如果设置为true，则表示该列是一个数组，在写入时，必须按照JSON数组格式写入，例如["a","b","c"]。

    由于Nested类型是一个数组，当field_type为Nested类型时，无需设置此参数。

  • index（可选）：是否开启索引，类型为Boolean。

    默认为true，表示对该列构建倒排索引或者空间索引；如果设置为false，则不会对该列构建索引。

  • analyzer（可选）：分词器类型。当字段类型为Text时，可以设置此参数；如果不设置，则默认分词器类型为单字分词。关于分词的更多信息，请参见分词。
  • enable_sort_and_agg（可选）：是否开启排序与统计聚合功能，类型为Boolean。
    只有enable_sort_and_agg设置为true的字段才能进行排序。关于排序的更多信息，请参见排序和翻页。
    重要 Nested类型的字段不支持开启排序与统计聚合功能，但是Nested类型内部的子列支持开启排序与统计聚合功能。
  • store（可选）：是否在多元索引中附加存储该字段的值，类型为Boolean。

    开启后，可以直接从多元索引中读取该字段的值，而不必反查数据表，可用于查询性能优化。

  • sub_field_schemas（可选）：当字段类型为Nested类型时，需要通过此参数设置嵌套文档中子列的索引类型，类型为field_schema的列表。
  • is_virtual_field（可选）：该字段是否为虚拟列，类型为Boolean类型，默认值为false。只有使用虚拟列时，才需要设置此参数。关于虚拟列的更多信息，请参见虚拟列。
  • source_field_name（可选）：数据表中的字段名称，类型为String。
    重要 当设置is_virtual_field为true时，必须设置此参数。
  • date_formats（可选）：日期的格式，类型为String。更多信息，请参见日期数据类型。
    重要 当字段类型为Date时，必须设置此参数。
index_setting 索引设置，包含routing_fields设置。

routing_fields（可选）：自定义路由字段。可以选择部分主键列作为路由字段，在进行索引数据写入时，会根据路由字段的值计算索引数据的分布位置，路由字段的值相同的记录会被索引到相同的数据分区中。
index_sort 索引预排序设置，包含sorters设置。如果不设置，则默认按照主键排序。
说明 含有Nested类型的索引不支持indexSort，没有预排序。
sorters（必选）：索引的预排序方式，支持按照主键排序和字段值排序。关于排序的更多信息，请参见排序和翻页。
  • PrimaryKeySort表示按照主键排序，包含如下设置：

    sort_order：排序的顺序，可按升序或者降序排序，默认为升序（SortOrder.ASC）。

  • FieldSort表示按照字段值排序，包含如下设置：

    只有建立索引且开启排序与统计聚合功能的字段才能进行预排序。

    • field_name：排序的字段名。
    • sort_order：排序的顺序，可按照升序或者降序排序，默认为升序（SortOrder.ASC）。
    • sort_mode：当字段存在多个值时的排序方式。

示例

创建多元索引时设置分词。多元索引包括k（Keyword类型）、t（Text类型）、g（Geopoint类型）、ka（数组Keyword类型）、la（数组Long类型）和n（Nested类型）六个字段。其中n字段包括nk（Keyword类型）、nl（Long类型）和nt（Text类型）三个子字段。

#Keyword类型的字段，建立索引并开启统计聚合功能。
field_a = FieldSchema('k', FieldType.KEYWORD, index=True, enable_sort_and_agg=True, store=True)
#Text类型的字段，建立索引并使用单字分词。
field_b = FieldSchema('t', FieldType.TEXT, index=True, store=True, analyzer=AnalyzerType.SINGLEWORD)
#Text类型的字段，建立索引并使用模糊分词。
#filed_b = FieldSchema('t', FieldType.TEXT, index=True, store=True, analyzer=AnalyzerType.FUZZY,analyzer_parameter=FuzzyAnalyzerParameter(1, 6))
#Text类型的字段，建立索引并使用自定义分隔符半角逗号（,）进行分词。
#field_b = FieldSchema('t', FieldType.TEXT, index=True, store=True, analyzer=AnalyzerType.SPLIT, analyzer_parameter = SplitAnalyzerParameter(","))
#Geopoint类型的字段，建立索引。
field_c = FieldSchema('g', FieldType.GEOPOINT, index=True, store=True)
#数组Kerword类型字段，建立索引。
field_d = FieldSchema('ka', FieldType.KEYWORD, index=True, is_array=True, store=True)
#数组Long类型字段，建立索引。
field_e = FieldSchema('la', FieldType.LONG, index=True, is_array=True, store=True)

#Nested类型字段，包括nk（Keyword类型）、nl（Long类型）和nt（Text类型）三个子字段。
field_n = FieldSchema('n', FieldType.NESTED, sub_field_schemas=[
    FieldSchema('nk', FieldType.KEYWORD, index=True, store=True),
    FieldSchema('nl', FieldType.LONG, index=True, store=True),
    FieldSchema('nt', FieldType.TEXT, index=True, store=True),
])

fields = [field_a, field_b, field_c, field_d, field_e, field_n]

index_setting = IndexSetting(routing_fields=['PK1']) 
index_sort = None #当多元索引中存在Nested类型字段时，不能设置索引预排序.
#index_sort = Sort(sorters=[PrimaryKeySort(SortOrder.ASC)])
index_meta = SearchIndexMeta(fields, index_setting=index_setting, index_sort=index_sort)
client.create_search_index(table_name, index_name, index_meta)