v3.4

SequoiaDB 简介
安装部署
数据库实例
分布式引擎
SAC 管控中心
参考手册
- 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()
    - getRG()
    - getSequence()
    - getSessionAttr()
    - getSpareRG()
    - invalidateCache()
    - list()
    - listBackup()
    - listCollections()
    - listCollectionSpaces()
    - listDataSources()
    - listDomains()
    - listProcedures()
    - listReplicaGroups()
    - listSequences()
    - listTasks()
    - removeBackup()
    - removeCataRG()
    - removeCoordRG()
    - removeSpareRG()
    - removeProcedure()
    - removeRG()
    - renameCS()
    - renameSequence()
    - resetSnapshot()
    - reloadConf()
    - 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()
    - count()
    - createAutoIncrement()
    - createIdIndex()
    - createIndex()
    - createLobID()
    - deleteLob()
    - detachCL()
    - disableCompression()
    - disableSharding()
    - dropAutoIncrement()
    - dropIdIndex()
    - dropIndex()
    - enableCompression()
    - enableSharding()
    - find()
    - findOne()
    - getDetail()
    - getIndex()
    - getIndexStat()
    - getLob()
    - getLobDetail()
    - insert()
    - listIndexes()
    - listLobs()
    - putLob()
    - remove()
    - setAttributes()
    - 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()
  - SdbSequence
    - fetch()
    - getCurrentValue()
    - getNextValue()
    - restart()
    - setAttributes()
    - setCurrentValue()
  - Oma
    - Oma()
    - addAOmaSvcName()
    - delAOmaSvcName()
    - close()
    - createCoord()
    - createData()
    - createOM()
    - getAOmaSvcName()
    - getIniConfigs()
    - getNodeConfigs()
    - getOmaConfigFile()
    - getOmaConfigs()
    - getOmaInstallFile()
    - getOmaInstallInfo()
    - listNodes()
    - reloadConfigs()
    - removeCoord()
    - removeData()
    - removeOM()
    - setIniConfigs()
    - setNodeConfigs()
    - setOmaConfigs()
    - start()
    - startAllNodes()
    - stopAllNodes()
    - startNode()
    - stopNode()
    - startNodes()
    - stopNodes()
    - updateNodeConfigs()
  - 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
  - 命令位置参数
- 错误码
- 操作符
  - 匹配符
    - $gt
    - $gte
    - $lt
    - $lte
    - $ne
    - $et
    - $mod
    - $and
    - $or
    - $not
    - $regex
    - $elemMatch
    - $exists
    - $isnull
    - $in
    - $nin
    - $all
    - $+标识符
    - $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语法
- 编目表
- 数据库快照
- 数据库列表
- 访问计划的评估过程
- 限制
常见问题及解答（FAQ）
- SequoiaDB FAQ
版本信息

addComment()

名称

addComment - 为指定的 item 追加注释

语法

IniFile.addComment( <section>, <key>, <comment>, [pos] )

IniFile.addComment( <key>, <comment>, [pos] )

类别

IniFile

描述

为指定的 item 追加注释。

参数

参数名	参数类型	默认值	描述	是否必填
section	string	---	段名	是
key	string	---	键名	是
comment	string	---	追加的注释	是
pos	boolean	true	true: 前置注释; false: 后置注释	否

返回值

执行成功，无返回值.

执行失败，抛异常。

错误

如果出错则抛异常，并输出错误信息，可以通过getLastErrMsg()获取错误信息或通过getLastError()获取错误码。关于错误处理可以参考常见错误处理指南。

常见错误可参考错误码。

版本

v3.2 及以上版本

示例

打开一个 INI 文件。

> var ini = new IniFile( "/opt/sequoiadb/file.ini", SDB_INIFILE_FLAGS_DEFAULT )

为指定的 item 追加注释。

> ini.addComment( "info", "name", "what's your name" )

收起

本页导航

粤ICP备16118040号

回到顶部