文档中心

SequoiaDB 简介

快速入门

安装部署

数据库实例

分布式引擎

SAC管控中心

SequoiaPerf性能分析工具

参考手册

常见问题及解答(FAQ)

版本信息

getIndex()

名称

getIndex - 获取指定索引

语法

db.collectionspace.collection.getIndex(<name>)

类别

SdbCollection

描述

该函数用于获取当前集合中指定的索引信息。

参数

  • name ( string必填 )

被指定的索引名。

Note:

  • 索引名不能是空串,含点(.)或者美元符号($),且长度不超过127B。

返回值

函数执行成功时,将返回一个 BSONObj 类型的对象。通过该对象获取集合详细信息列表,字段说明可参考[索引统计信息快照][SDB_SNAP_INDEXSTATS]。

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

错误

getIndex()函数常见异常如下:

错误码 错误名 可能发生的原因 解决办法
-47 SDB_IXM_NOTEXIST 索引不存在 检查索引是否存在

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

版本

v1.10 及以上版本

示例

  • 获取集合 sample.employee 下名为 ageIndex 的索引信息,假设 ageIndex 已存在。

    > db.sample.employee.getIndex( "ageIndex" )

    结果如下:

    {
     "IndexDef": {
         "name": "ageIndex",
         "_id": {
           "$oid": "5f4f3b938f5a48a0c3a5f3ad"
         },
         "key": {
           "age": 1
         },
         "v": 0,
        "unique": true,
         "dropDups": false,
         "enforced": false,
         "NotNull": false,
         "NotArray": false
      },
      "IndexFlag": "Normal",
      "Type": "Positive"
    }
回到顶部