文档中心

关于 SequoiaDB

快速入门

安装

基本操作

数据模型

SQL引擎

S3引擎

系统架构

数据库管理

连接器

驱动

参考手册

故障排除

SAC 管控中心

Web服务

版本信息

listIndexes()

语法

db.collectionspace.collection.listIndexes()

枚举索引,执行此方法会将指定集合下的索引信息全部显示出来。

参数

字段信息

参数名 参数类型 描述
name string 索引名
key json 对象 索引键,可参考 indexDef
v Int32 索引版本号
unique Boolean 索引是否唯一
"true":该索引为唯一索引,不允许集合中有重复的值
"false":该索引为普通索引,允许集合中有重复的值
dropDups Boolean 暂不开放
enforced Boolean 索引是否强制唯一,可参考 enforced
NotNull Boolean 索引的任意一个字段是否允许为 null 或者不存在
"true":不允许为 null 或者不存在
"false":允许为 null 或不存在
IndexFlag string 索引当前状态
"Normal":正常
"Creating":正在创建
"Dropping":正在删除
"Truncating":正在清空
"Invalid":无效
Type string 索引类型
"Positive":正序索引
"Reverse":逆序索引
"Text":全文索引
NotArray Boolean 索引的任意一个字段是否允许为数组
"true":不允许为数组
"false":允许为数组

返回值

返回游标。

错误

错误码

示例

  • 返回集合 bar 下的所有索引信息
> db.foo.bar.listIndexes()
{
  "IndexDef": {
    "name": "$id",
    "_id": {
      "$oid": "5e9e91bccf4f1e7370e4074d"
    },
    "key": {
      "_id": 1
    },
    "v": 0,
    "unique": true,
    "dropDups": false,
    "enforced": true,
    "NotNull": false,
    "NotArray": false
  },
  "IndexFlag": "Normal",
  "Type": "Positive"
}
回到顶部