copyIndexAsync()

名称

copyIndexAsync - 异步复制索引

语法

db.collectionspace.collection.copyIndexAsync([subCLName], [indexName])

类别

SdbCollection

描述

该函数用于将主集合的索引异步复制到子集合中。

参数

• subCLName（ string，选填 ）

  指定子集合名，格式为<csname>.<clname>，默认值为 null ，表示主集合下的所有子集合

• indexName（ string，选填 ）

  指定索引名，默认值为 null ，表示主集合下的所有索引

返回值

函数执行成功时，将返回一个 number 类型的对象。通过该对象获取返回的任务 ID。

函数执行失败时，将抛异常并输出错误信息。

错误

当异常抛出时，可以通过 getLastErrMsg() 获取错误信息或通过 getLastError() 获取错误码。更多错误处理可以参考常见错误处理指南。

版本

v3.6 及以上版本

示例

1. 在主集合 sample.employee 中创建名为"IDIdx"的索引

   > db.sample.employee.createIndex("IDIdx", {ID: 1})

2. 把主集合的索引复制到子集合中

   > var id = db.sample.employee.copyIndexAsync()

3. 查看任务状态

   > db.getTask(id)

4. 任务完成后查看子集合 sample.January 的索引信息，显示已添加索引 IDIdx

   > db.sample.January.listIndexes()
   {
     "IndexDef": {
       "name": "ID",
       "key": {
         "ID": 1
       },
       ...
     },
     ...
   }