本地二级索引

在数据表上创建索引表后，可根据需要读取索引表中的数据或者删除数据表上指定的索引表。

前提条件

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

• 已创建数据表，且数据表的最大版本数（max_versions）必须为1，数据生命周期（time_to_live）必须满足如下条件中的任意一个。

  • 数据表的数据生命周期为-1（数据永不过期）。

  • 数据表的数据生命周期不为-1时，数据表为禁止更新状态。

• 数据表已设置预定义列。

创建索引表（CreateIndex）

使用CreateIndex接口在已存在的数据表上创建索引表。

• 接口

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

• 参数

  参数	说明
  table_name	数据表名称。
  index_meta	索引表的结构信息，包括如下内容： name：索引表名称。 primary_key：索引表的索引列，索引列为数据表主键和预定义列的任意组合。 defined_column：索引表的属性列，索引表属性列为数据表的预定义列的组合。 index_update_mode：索引表更新模式，可选值包括IndexUpdateModeConst::ASYNC_INDEX和IndexUpdateModeConst::SYNC_INDEX。 当不设置index_update_mode或者设置index_update_mode为IndexUpdateModeConst::ASYNC_INDEX时，表示异步更新。 使用全局二级索引时，索引更新模式必须设置为异步更新（IndexUpdateModeConst::ASYNC_INDEX）。 当设置index_update_mode为IndexUpdateModeConst::SYNC_INDEX时，表示同步更新。 使用本地二级索引时，索引更新模式必须设置为同步更新（IndexUpdateModeConst::SYNC_INDEX）。 index_type：索引表类型，索引类型。可选值包括IndexTypeConst::GLOBAL_INDEX和IndexTypeConst::LOCAL_INDEX。 当不设置index_type或者设置index_type为IndexTypeConst::GLOBAL_INDEX时，表示使用全局二级索引。 使用全局二级索引时，表格存储以异步方式将数据表中被索引的列和主键列的数据自动同步到索引表中，正常情况下同步延迟达到毫秒级别。 当设置index_type为IndexTypeConst::LOCAL_INDEX时，表示使用本地二级索引。 使用本地二级索引时，表格存储以同步方式将数据表中被索引的列和主键列的数据自动同步到索引表中，当数据写入数据表后，即可从索引表中查询到数据。
  include_base_data	索引表中是否包含数据表中已存在的数据，默认值为false。 当设置include_base_data为true时，表示包含存量数据。 当不设置include_base_data或者设置include_base_data为false时，表示不包含存量数据。

• 示例

  $createLocalRequest = array (
   'table_name' => 'MainTableName', // 数据表名称。
   'index_meta' => array (
   'name' => 'IndexName', // 索引表名称。
   'primary_key' => array('col1', 'PK1'),
   'defined_column' => array('col2'),
   'index_type' => IndexTypeConst::LOCAL_INDEX,
   'index_update_mode' => IndexUpdateModeConst::SYNC_INDEX
   )
  );
  $otsClient->createIndex ( $createLocalRequest );

读取索引表中数据

从索引表中单行或者范围读取数据，当返回的属性列在索引表中时，可以直接读取索引表获取数据，否则请自行反查数据表获取数据。

• 单行读取索引表中数据

  更多信息，请参见读取单行数据。

  使用GetRow接口读取索引表中数据时有如下注意事项：

  • table_name需要设置为索引表名称。

  • 由于系统会自动将未出现在索引列中的数据表主键补齐到索引表主键中，所以设置行的主键时，需要同时设置索引表索引列和补齐的数据表主键。

• 范围读索引表中数据

  更多信息，请参见范围读取数据。

  使用GetRange接口读取索引表中数据时有如下注意事项：

  • table_name需要设置为索引表名称。

  • 由于系统会自动将未出现在索引列中的数据表主键补齐到索引表主键中，所以设置起始主键和结束主键时，需要同时设置索引表索引列和补齐的数据表主键。

删除索引表（DropIndex）

使用DropIndex接口删除数据表上指定的索引表。

• 接口

  /**
   * 删除全局二级索引。
   * @api
   *
   * @param [] $request
   *            请求参数，数据表名称。
   * @return [] 请求返回。
   * @throws OTSClientException 当参数检查出错或服务端返回校验出错时抛出异常。
   * @throws OTSServerException 当OTS服务端返回错误时抛出异常。
   * @example "src/examples/DropIndex.php"
   */
  public function dropIndex(array $request)

• 参数

  参数	说明
  table_name	数据表名称。
  index_name	索引表名称。

• 示例

  $request = array (
      'table_name' => 'MainTableName',
      'index_name' => 'IndexName'
  );
  $otsClient->dropIndex( $request );