您可以使用创建多元索引(CreateSearchIndex)接口在一个表上创建多元索引。

如果要在某张表上使用Search功能,那么首先需要在这张表上创建一个多元索引。创建多元索引时,需要指定表名(table_name)、索引名(index_name)、索引的结构信息(index_meta)。

  • table_name:要创建的多元索引所属的表名。
  • index_name:要创建的多元索引的名字。
  • index_meta:包含index_setting(索引设置)、field_schemas(Index的所有字段的设置)、index_sort(IndexSort的设置)
    • FieldSchema的列表,每个FieldSchema包含以下内容:
      • field_name(必选,str类型):要索引的字段名,即列名。可以是主键列,也可以是属性列。
      • field_type(必选,FieldType类型):字段类型,详见SearchIndex字段类型一节。
      • is_array(可选,bool类型):是否为数组。如果为true,则表示该列是一个数组,在写入时,也必须按照JSON数组格式写入,例如["a","b","c"]。嵌套类型本身就是一个数组,所以无须显式配置。
      • index(可选,bool类型):是否对该列进行索引。
      • analyzer(可选,AnalyzerType类型):若该列类型为TEXT,则可以选择分词器。
      • enable_sort_and_agg(可选,bool类型):是否对该列开启排序与统计功能。
      • store(可选,bool类型):是否在多元索引中附加存储该字段的值。开启后,可以直接从多元索引中读取该字段的值,而不必反查主表,可用于查询性能优化。
      • sub_field_schemas(可选,FieldSchema的列表):若该列为嵌套类型,则嵌套文档中的子列的索引类型需要通过该参数来配置。
    • index_setting(可选):

      routing_fields(高级功能,可选配置):自定义路由字段。可以选择部分主键列作为路由字段,在进行索引数据写入时,会根据路由字段的值计算索引数据的分布位置,路由字段的值相同的记录会被索引到相同的数据分区中。

    • index_sort(可选):默认和主表保持相同主键排序(若带有嵌套字段,则默认不排序)。
      • sorters(必选,Sort数组):可选的排序方式包含以下两种:
        • PrimaryKeySort:可指定索引表按主键排序,指定正序或者倒序排序。
        • FieldSort:可指定某一列作为排序字段,指定正序或者倒序排序。
field_a = FieldSchema('k', FieldType.KEYWORD, index=True, enable_sort_and_agg=True, store=True)
field_b = FieldSchema('t', FieldType.TEXT, index=True, store=True, analyzer=AnalyzerType.SINGLEWORD)
field_c = FieldSchema('g', FieldType.GEOPOINT, index=True, store=True)
field_d = FieldSchema('ka', FieldType.KEYWORD, index=True, is_array=True, store=True)
field_e = FieldSchema('la', FieldType.LONG, index=True, is_array=True, store=True)

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 # can not set index sort if there is any nested field.
#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)