赛尔校园公共服务平台 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
赛尔校园公共服务平台 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 表格存储
  4. 开发参考
  5. SDK参考
  6. PHP SDK
  7. 多元索引
  8. 索引管理
  9. 创建多元索引

创建多元索引

  • 索引管理
  • 发布于 2025-04-22
  • 0 次阅读
文档编辑
文档编辑

使用CreateSearchIndex接口在数据表上创建一个多元索引。一个数据表支持创建多个多元索引。创建多元索引时,您需要将要查询的字段添加到多元索引中,您还可以配置多元索引路由键、预排序等高级选项。

前提条件

  • 已初始化Client。具体操作,请参见初始化OTSClient。

  • 已创建数据表,并且数据表的最大版本数(max Versions)必须为1,数据生命周期(Time to Live)为-1。具体操作,请参见创建数据表。

注意事项

创建多元索引时,多元索引中字段的数据类型必须与数据表中字段的数据类型相匹配。更多信息,请参见数据类型映射。

接口

/**
 * 创建多元索引。
 * @api
 *
 * @param [] $request
 *            请求参数、数据表名称、索引配置等。
 * @return [] 请求返回。
 * @throws OTSClientException 当参数检查出错或服务端返回校验出错时抛出异常。
 * @throws OTSServerException 当OTS服务端返回错误时抛出异常。
 * @example "src/examples/CreateSearchIndex.php"
 */
public function createSearchIndex(array $request)

参数

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

参数

说明

table_name

数据表名称。

index_name

多元索引名称。

field_schemas

field_schema的列表,每个field_schemas包含如下内容:

  • field_name(必选):建立索引的字段名,即列名,类型为String。

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

  • field_type(必选):字段类型,类型为FieldTypeConst::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。

index_setting

索引设置,包含routing_fields设置。

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

index_sort

索引预排序设置,包含sorters设置。如果不设置,则默认按照主键排序。

说明

含有Nested类型的索引不支持index_sort,没有预排序。

sorters(必选):索引的预排序方式,支持按照主键排序和字段值排序。关于排序的更多信息,请参见排序和翻页。

  • PrimaryKeySort表示按照主键排序,包含如下设置:

    order:排序的顺序,可按升序或者降序排序,默认为升序(SortOrderConst::SORT_ORDER_ASC)。

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

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

    • field_name:排序的字段名。

    • order:排序的顺序,可按照升序或者降序排序,默认为升序(SortOrderConst::SORT_ORDER_ASC)。

    • mode:当字段存在多个值时的排序方式。

示例

以下示例用于创建一个多元索引。该多元索引包含keyword(Keyword类型)、text(Text类型)、geo(Geo-point类型)、long(Long类型)、double(Double类型)、boolean(Boolean类型)、array(Keyword类型)、nested(Nested类型)8列,其中nested列包含一个子列nested_keyword(Keyword类型),按照数据表主键进行预排序且数据永不过期。

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index',
    'schema' => array(
        'field_schemas' => array(
            array(
                'field_name' => 'keyword',
                'field_type' => FieldTypeConst::KEYWORD,
                'index' => true,
                'enable_sort_and_agg' => true,
                'store' => true,
                'is_array' => false
            ),
            array(
                'field_name' => 'text',
                'field_type' => FieldTypeConst::TEXT,
                'analyzer' => 'single_word',
                'index' => true,
                'enable_sort_and_agg' => false,
                'store' => true,
                'is_array' => false
            ),
            array(
                'field_name' => 'geo',
                'field_type' => FieldTypeConst::GEO_POINT,
                'index' => true,
                'enable_sort_and_agg' => true,
                'store' => true,
                'is_array' => false
            ),
            array(
                'field_name' => 'long',
                'field_type' => FieldTypeConst::LONG,
                'index' => true,
                'enable_sort_and_agg' => true,
                'store' => true,
                'is_array' => false
            ),
            array(
                'field_name' => 'double',
                'field_type' => FieldTypeConst::DOUBLE,
                'index' => true,
                'enable_sort_and_agg' => true,
                'store' => true,
                'is_array' => false
            ),
            array(
                'field_name' => 'boolean',
                'field_type' => FieldTypeConst::BOOLEAN,
                'index' => true,
                'enable_sort_and_agg' => false,
                'store' => true,
                'is_array' => false
            ),
            array(
                'field_name' => 'array',
                'field_type' => FieldTypeConst::KEYWORD,
                'index' => true,
                'enable_sort_and_agg' => false,
                'store' => true,
                'is_array' => true
            ),
            array(
                'field_name' => 'nested',
                'field_type' => FieldTypeConst::NESTED,
                'index' => false,
                'enable_sort_and_agg' => false,
                'store' => false,
                'field_schemas' => array(
                    array(
                        'field_name' => 'nested_keyword',
                        'field_type' => FieldTypeConst::KEYWORD,
                        'index' => false,
                        'enable_sort_and_agg' => false,
                        'store' => false,
                        'is_array' => false
                    )
                )
            ),
        ),
        'index_setting' => array(
            'routing_fields' => array("pk1")
        ),
//        "index_sort" => array(//含有Nested类型的索引不支持index_sort,没有预排序。
//            array(
//                'field_sort' => array(
//                    'field_name' => 'keyword',
//                    'order' => SortOrderConst::SORT_ORDER_ASC,
//                    'mode' => SortModeConst::SORT_MODE_AVG,
//                )
//            ),
//            array(
//                'pk_sort' => array(
//                    'order' => SortOrderConst::SORT_ORDER_ASC
//                )
//            ),
//        )
    )
);
$response = $otsClient->createSearchIndex($request);

常见问题

  • 多元索引路由字段的使用

  • 使用GetRange接口和Search接口范围查询数据时的区别

  • 表格存储是否支持存储JSON数据?

  • 使用多元索引Search接口查不到数据

  • 如何查看表的总行数

  • 表格存储是否支持类似关系数据库的in和between...and查询

  • 如何将多元索引Search接口查询数据的limit提高到1000

  • 如何批量删除数据

  • 使用多元索引时出现field:xx must enable enable_sort_and_agg异常

相关文档

  • 创建多元索引后,您可以选择合适的查询类型进行多维度数据查询。多元索引查询类型包括精确查询、多词精确查询、全匹配查询、匹配查询、短语匹配查询、前缀查询、范围查询、通配符查询、地理位置查询、多条件组合查询、嵌套类型查询和列存在性查询。

    当通过Search接口查询数据时,如果要对结果集进行排序或者翻页,您可以使用排序和翻页功能来实现。具体操作,请参见排序和翻页。

  • 当通过Search接口查询数据时,如果要按照某一列对结果集做折叠,使对应类型的数据在结果展示中只出现一次,您可以使用折叠(去重)功能来实现。具体操作,请参见折叠(去重)。

  • 如果要进行数据分析,例如求最值、求和、统计行数等,您可以使用Search接口的统计聚合功能或者SQL查询来实现。具体操作,请参见统计聚合和SQL查询。

  • 如果要快速导出数据,而不关心整个结果集的顺序时,您可以使用ParallelScan接口和ComputeSplits接口实现多并发导出数据。具体操作,请参见并发导出数据。

  • 如果要在多元索引中新增、更新或者删除索引列,您可以使用动态修改schema功能实现。具体操作,请参见动态修改schema。

  • 如果要获取某个数据表关联的所有多元索引的列表信息,您可以使用列出多元索引列表功能实现。具体操作,请参见列出多元索引列表。

  • 如果要查询多元索引的描述信息,包括多元索引的字段信息和索引配置等,您可以使用查询多元索引描述信息功能实现。具体操作,请参见查询多元索引描述信息。

  • 如果不再需要使用多元索引,您可以删除多元索引。具体操作,请参见删除多元索引。

相关文章

创建多元索引 2025-04-22 14:20

使用CreateSearchIndex接口在数据表上创建一个多元索引。一个数据表支持创建多个多元索引。创建多元索引时,您需要将要查询的字段添加到多元索引中,您还可以配置多元索引路由键、预排序等高级选项。

列出多元索引列表 2025-04-22 14:20

创建多元索引后,使用ListSearchIndex接口可以获取某个数据表关联的所有多元索引的列表信息。 前提条件

更新多元索引配置 2025-04-22 14:20

创建多元索引后,您可以使用UpdateSearchIndex接口更新多元索引信息。本文介绍如何通过PHP SDK更新多元索引的数据生命周期。 前提条件

查询多元索引描述信息 2025-04-22 14:20

创建多元索引后,使用DescribeSearchIndex接口可以查询多元索引的描述信息,包括多元索引的字段信息、索引配置、计量信息、创建时间、TTL等。

删除多元索引 2025-04-22 14:20

使用DeleteSearchIndex接口可以删除指定数据表的一个多元索引。 前提条件

目录
Copyright © 2025 your company All Rights Reserved. Powered by 赛尔网络.
京ICP备14022346号-15
gongan beian 京公网安备11010802041014号