v5.0

SequoiaDB 简介
快速入门
- 快速部署
- 容器模式部署
安装部署
数据库实例
分布式引擎
SAC 管控中心
SequoiaPerf 性能分析工具
参考手册
- SequoiaDB Shell方法
  - Global
    - help()
    - print()
    - sleep()
    - forceGC()
    - showClass()
    - getErr()
    - getLastErrMsg()
    - getLastErrObj()
    - getLastError()
    - setLastErrMsg()
    - setLastErrObj()
    - setLastError()
    - getExePath()
    - getRootPath()
    - getSelfPath()
    - import()
    - importOnce()
    - jsonFormat()
    - traceFmt()
  - Sdb
    - Sdb()
    - analyze()
    - backup()
    - cancelTask()
    - close()
    - createCataRG()
    - createCoordRG()
    - createCS()
    - createDataSource()
    - createDomain()
    - createProcedure()
    - createRG()
    - createSequence()
    - createSpareRG()
    - createUsr()
    - dropCS()
    - dropDataSource()
    - dropDomain()
    - dropSequence()
    - dropUsr()
    - eval()
    - exec()
    - execUpdate()
    - flushConfigure()
    - forceSession()
    - forceStepUp()
    - getCataRG()
    - getCoordRG()
    - getCS()
    - getDataSource()
    - getDomain()
    - getRecycleBin()
    - getRG()
    - getSequence()
    - getSessionAttr()
    - getSpareRG()
    - getTask()
    - invalidateCache()
    - list()
    - listBackup()
    - listCollections()
    - listCollectionSpaces()
    - listDataSources()
    - listDomains()
    - listProcedures()
    - listReplicaGroups()
    - listSequences()
    - listTasks()
    - removeBackup()
    - removeCataRG()
    - removeCoordRG()
    - removeSpareRG()
    - removeProcedure()
    - removeRG()
    - renameCS()
    - renameSequence()
    - resetSnapshot()
    - reloadConf()
    - restoreAbort()
    - restoreCheck()
    - restorePrepare()
    - restoreToTime()
    - deleteConf()
    - setSessionAttr()
    - snapshot()
    - startRG()
    - stopRG()
    - sync()
    - setPDLevel()
    - traceOff()
    - traceOn()
    - traceResume()
    - traceStatus()
    - transBegin()
    - transCommit()
    - transRollback()
    - updateConf()
    - waitTasks()
  - SecureSdb
  - SdbCS
    - alter()
    - createCL()
    - dropCL()
    - getCL()
    - getDomainName()
    - listCollections()
    - removeDomain()
    - renameCL()
    - setAttributes()
    - setDomain()
  - SdbCollection
    - aggregate()
    - alter()
    - attachCL()
    - copyIndex()
    - copyIndexAsync()
    - count()
    - createAutoIncrement()
    - createIdIndex()
    - createIndex()
    - createIndexAsync()
    - createLobID()
    - deleteLob()
    - detachCL()
    - disableCompression()
    - disableSharding()
    - dropAutoIncrement()
    - dropIdIndex()
    - dropIndex()
    - dropIndexAsync()
    - enableCompression()
    - enableSharding()
    - find()
    - findOne()
    - getDetail()
    - getIndex()
    - getIndexStat()
    - getLob()
    - getLobDetail()
    - insert()
    - listIndexes()
    - listLobs()
    - putLob()
    - remove()
    - setAttributes()
    - snapshotIndexes()
    - split()
    - splitAsync()
    - truncate()
    - truncateLob()
    - update()
    - upsert()
  - SdbCursor
    - close()
    - current()
    - next()
    - arrayAccess()
  - SdbQuery
    - arrayAccess()
    - close()
    - count()
    - current()
    - explain()
    - flags()
    - getQueryMeta()
    - hint()
    - limit()
    - next()
    - query()
    - remove()
    - size()
    - skip()
    - sort()
    - toArray()
    - update()
  - SdbReplicaGroup
    - attachNode()
    - createNode()
    - detachNode()
    - getDetailObj()
    - getMaster()
    - getNode()
    - getSlave()
    - reelect()
    - removeNode()
    - start()
    - stop()
  - SdbNode
    - connect()
    - getHostName()
    - getDetailObj()
    - getServiceName()
    - start()
    - stop()
  - SdbDomain
    - addGroups()
    - alter()
    - listCollections()
    - listCollectionSpaces()
    - removeGroups()
    - setAttributes()
    - setGroups()
    - listGroups()
  - SdbDataSource
    - alter()
  - SdbRecycleBin
    - alter()
    - count()
    - disable()
    - dropAll()
    - dropItem()
    - enable()
    - getDetail()
    - list()
    - returnItem()
    - returnItemToName()
    - setAttributes()
    - snapshot()
  - SdbSequence
    - fetch()
    - getCurrentValue()
    - getNextValue()
    - restart()
    - setAttributes()
    - setCurrentValue()
  - Oma
    - Oma()
    - addAOmaSvcName()
    - delAOmaSvcName()
    - close()
    - createCoord()
    - createData()
    - createOM()
    - createStp()
    - getAOmaSvcName()
    - getIniConfigs()
    - getNodeConfigs()
    - getOmaConfigFile()
    - getOmaConfigs()
    - getOmaInstallFile()
    - getOmaInstallInfo()
    - getStp()
    - listNodes()
    - reloadConfigs()
    - removeCoord()
    - removeData()
    - removeOM()
    - removeStp()
    - setIniConfigs()
    - setNodeConfigs()
    - setOmaConfigs()
    - start()
    - startAllNodes()
    - stopAllNodes()
    - startNode()
    - startStp()
    - stopNode()
    - startNodes()
    - stopNodes()
    - stopStp()
    - updateNodeConfigs()
  - Stp
    - Stp()
    - getTime()
    - getTimeUS()
    - getConf()
    - getMeta()
    - getServers()
    - getSyncClients()
    - getSyncStatus()
    - getSyncHistory()
    - reelect()
    - stop()
    - updateConf()
  - File
    - File()
    - chgrp()
    - chmod()
    - chown()
    - close()
    - copy()
    - exist()
    - find()
    - getSize()
    - getUmask()
    - isDir()
    - isEmptyDir()
    - isFile()
    - list()
    - md5()
    - mkdir()
    - move()
    - read()
    - readContent()
    - readLine()
    - remove()
    - scp()
    - seek()
    - setUmask()
    - stat()
    - write()
    - writeContent()
    - truncate()
  - FileContent
    - clear()
    - getLength()
    - toBase64Code()
  - Cmd
    - Cmd()
    - getCommand()
    - getInfo()
    - getLastOut()
    - getLastRet()
    - run()
    - runJS()
    - start()
  - Remote
    - close()
    - getCmd()
    - getFile()
    - getIniFile()
    - getInfo()
    - getSystem()
    - Remote()
  - Hash
    - fileMD5()
    - md5()
  - IniFile
    - IniFile()
    - addComment()
    - addSectionComment()
    - addLastComment()
    - setComment()
    - setSectionComment()
    - setLastComment()
    - delComment()
    - delSectionComment()
    - delLastComment()
    - enableItem()
    - disableItem()
    - disableAllItem()
    - getComment()
    - getSectionComment()
    - getLastComment()
    - getValue()
    - setValue()
    - toObj()
    - toString()
    - save()
  - Sdbtool
    - listNodes()
  - Ssh
    - Ssh()
    - close()
    - exec()
    - getLastOut()
    - getLastRet()
    - getLocalIP()
    - getPeerIP()
    - pull()
    - push()
  - System
    - addAHostMap
    - addGroup
    - addUser
    - delAHostMap
    - delGroup
    - delUser
    - getAHostMap
    - getCpuInfo
    - getCurrentUser
    - getDiskInfo
    - getEWD
    - getHostName
    - getHostsMap
    - getIpTablesInfo
    - getMemInfo
    - getNetcardInfo
    - getPID
    - getProcUlimitConfigs
    - getReleaseInfo
    - getSystemConfigs
    - getTID
    - getUserEnv
    - isGroupExist
    - isProcExist
    - isUserExist
    - killProcess
    - listAllUsers
    - listGroups
    - listLoginUsers
    - listProcess
    - ping
    - runService
    - setProcUlimitConfigs
    - setUserConfigs
    - snapshotCpuInfo
    - snapshotDiskInfo
    - snapshotMemInfo
    - snapshotNetcardInfo
    - sniffPort
    - type
  - 辅助类型对象
    - SdbSnapshotOption
    - SdbQueryOption
    - SdbTraceOption
    - CLCount
    - User
    - CipherUser
  - 特殊类型对象
    - BinData
    - BSONArray
    - BSONObj
    - MaxKey
    - MinKey
    - NumberDecimal
    - NumberLong
    - OID
    - Regex
    - SdbDate
    - Timestamp
  - 命令位置参数
- 错误码
- 连接器
  - Hadoop
    - 部署
    - 集成
  - Hive
- 操作符
  - 匹配符
    - $gt
    - $gte
    - $lt
    - $lte
    - $ne
    - $et
    - $mod
    - $in
    - $isnull
    - $nin
    - $all
    - $and
    - $not
    - $or
    - $exists
    - $elemMatch
    - $+标识符
    - $regex
    - $expand
    - $returnMatch
  - 选择符
  - 函数操作
    - $abs
    - $ceiling
    - $floor
    - $mod
    - $add
    - $subtract
    - $multiply
    - $divide
    - $substr
    - $strlen
    - $strlenBytes
    - $strlenCP
    - $lower
    - $upper
    - $ltrim
    - $rtrim
    - $trim
    - $cast
    - $size
    - $type
    - $slice
  - 更新符
    - $inc
    - $set
    - $unset
    - $bit
    - $rename
    - $addtoset
    - $pop
    - $pull
    - $pull_all
    - $pull_by
    - $pull_all_by
    - $push
    - $push_all
    - $replace
  - 聚集符
    - $project
    - $match
    - $limit
    - $sort
    - $skip
    - $group
    - SQL to Aggregate 映射表
  - 字段操作符
    - $field
- SQL to SequoiaDB 映射表
- SQL语法
- 编目表
- 数据库快照
- 数据库列表
- 访问计划的评估过程
- Web服务
  - WebSphere
    - 部署
    - 连接
    - web应用
  - Tomcat
    - 部署
    - 连接
    - web应用
  - JBoss
    - 部署
    - 连接
    - web应用
- 限制
常见问题及解答（FAQ）
- SequoiaDB FAQ
- SQL FAQ
版本信息

createIndexAsync()

名称

createIndexAsync - 异步创建索引

语法

db.collectionspace.collection.createIndexAsync(<name>, <indexDef>, [indexAttr], [option])

类别

SdbCollection

描述

该函数用于为集合异步创建索引，提高查询速度。

参数

参数名	类型	描述	是否必填
name	string	索引名，同一个集合中的索引名必须唯一	是
indexDef	object	索引键，包含一个或多个指定索引字段与类型的对象类型值 1 表示字段升序，-1 表示字段降序，"text"则表示创建全文索引	是
indexAttr	object	索引属性，选项可参考 indexAttr 选项说明	否
option	object	控制参数，选项可参考 option 选项说明	否

indexAttr 选项：

属性名	类型	描述	默认值
Unique	boolean	索引是否唯一	false
Enforced	boolean	索引是否强制唯一	false
NotNull	boolean	索引的任意一个字段是否允许为 null 或者不存在	false
NotArray	boolean	索引的任意一个字段是否允许为数组	false

option 选项：

属性名	类型	描述	默认值
SortBufferSize	number	创建索引时使用的排序缓存的大小	64MB

Note:

在唯一索引所指定的索引键字段上，集合中不可存在一条以上的记录完全重复。

索引名限制、索引字段的最大数量、索引键的最大长度请参考限制。

在集合记录数据量较大时（大于1000万条记录）适当增大排序缓存大小可以提高创建索引的速度。

对于全文索引，参数 isUnique、enforced 及 sortBufferSize 无意义。

返回值

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

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

错误

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

版本

v5.0.3 及以上版本

示例

在集合 sample.employee 中创建唯一索引

> db.sample.employee.createIndexAsync("ab", {a: 1, b: 1}, {Unique: true})
1051

查看相应的任务信息
```
> db.getTask(1051)
```

收起

本页导航

粤ICP备16118040号

回到顶部