Sequoiadb (com.sequoiadb:sequoiadb-driver 1.12 API)

java.lang.Object
- com.sequoiadb.base.Sequoiadb

```
public class Sequoiadb
extends Object
```

嵌套类概要

嵌套类
限定符和类型类和说明

static class Sequoiadb.SptEvalResult

static class Sequoiadb.SptReturnType

嵌套类
限定符和类型	类和说明
`static class`	`Sequoiadb.SptEvalResult`
`static class`	`Sequoiadb.SptReturnType`

字段概要

字段
限定符和类型	字段和说明
`static String`	`CATALOG_GROUP_NAME`
`static int`	`FMP_FUNC_TYPE_C`
`static int`	`FMP_FUNC_TYPE_INVALID`
`static int`	`FMP_FUNC_TYPE_JAVA`
`static int`	`FMP_FUNC_TYPE_JS`
`static int`	`SDB_LIST_CL_IN_DOMAIN`
`static int`	`SDB_LIST_COLLECTIONS`
`static int`	`SDB_LIST_COLLECTIONSPACES`
`static int`	`SDB_LIST_CONTEXTS`
`static int`	`SDB_LIST_CONTEXTS_CURRENT`
`static int`	`SDB_LIST_CS_IN_DOMAIN`
`static int`	`SDB_LIST_DOMAINS`
`static int`	`SDB_LIST_GROUPS`
`static int`	`SDB_LIST_SESSIONS`
`static int`	`SDB_LIST_SESSIONS_CURRENT`
`static int`	`SDB_LIST_STORAGEUNITS`
`static int`	`SDB_LIST_STOREPROCEDURES`
`static int`	`SDB_LIST_TASKS`
`static int`	`SDB_PAGESIZE_16K`
`static int`	`SDB_PAGESIZE_32K`
`static int`	`SDB_PAGESIZE_4K`
`static int`	`SDB_PAGESIZE_64K`
`static int`	`SDB_PAGESIZE_8K`
`static int`	`SDB_PAGESIZE_DEFAULT` 0 means using database's default pagesize, it 64k now
`static int`	`SDB_SNAP_CATALOG`
`static int`	`SDB_SNAP_COLLECTIONS`
`static int`	`SDB_SNAP_COLLECTIONSPACES`
`static int`	`SDB_SNAP_CONTEXTS`
`static int`	`SDB_SNAP_CONTEXTS_CURRENT`
`static int`	`SDB_SNAP_DATABASE`
`static int`	`SDB_SNAP_SESSIONS`
`static int`	`SDB_SNAP_SESSIONS_CURRENT`
`static int`	`SDB_SNAP_SYSTEM`

构造器概要

构造器
构造器和说明
`Sequoiadb(List<String> connStrings, String username, String password, ConfigOptions options)`
`Sequoiadb(String addr, int port, String username, String password)`
`Sequoiadb(String addr, int port, String username, String password, ConfigOptions options)`
`Sequoiadb(String username, String password)`
`Sequoiadb(String connString, String username, String password)`
`Sequoiadb(String connString, String username, String password, ConfigOptions options)`

方法概要

方法
限定符和类型	方法和说明
`void`	`activateReplicaGroup(String rgName)`
`void`	`backupOffline(BSONObject options)`
`void`	`beginTransaction()`
`void`	`cancelTask(long taskID, boolean isAsync)`
`void`	`changeConnectionOptions(ConfigOptions opts)`
`void`	`closeAllCursors()`
`void`	`commit()`
`CollectionSpace`	`createCollectionSpace(String csName)`
`CollectionSpace`	`createCollectionSpace(String csName, BSONObject options)`
`CollectionSpace`	`createCollectionSpace(String csName, int pageSize)`
`Domain`	`createDomain(String domainName, BSONObject options)`
`void`	`createReplicaCataGroup(String hostName, int port, String dbPath, Map<String,String> configure)`
`ReplicaGroup`	`createReplicaGroup(String rgName)`
`void`	`createUser(String username, String password)`
`void`	`crtJSProcedure(String code)`
`void`	`disconnect()`
`void`	`dropCollectionSpace(String csName)`
`void`	`dropDomain(String domainName)`
`Sequoiadb.SptEvalResult`	`evalJS(String code)`
`DBCursor`	`exec(String sql)`
`void`	`execUpdate(String sql)`
`void`	`flushConfigure(BSONObject param)`
`ArrayList<String>`	`getCollectionNames()`
`CollectionSpace`	`getCollectionSpace(String csName)`
`ArrayList<String>`	`getCollectionSpaceNames()`
`IConnection`	`getConnection()`
`Domain`	`getDomain(String domainName)`
`DBCursor`	`getList(int listType, BSONObject query, BSONObject selector, BSONObject orderBy)`
`ReplicaGroup`	`getReplicaGroup(int rgId)`
`ReplicaGroup`	`getReplicaGroup(String rgName)`
`ArrayList<String>`	`getReplicaGroupNames()`
`ArrayList<String>`	`getReplicaGroupsInfo()`
`ServerAddress`	`getServerAddress()`
`DBCursor`	`getSnapshot(int snapType, BSONObject matcher, BSONObject selector, BSONObject orderBy)`
`DBCursor`	`getSnapshot(int snapType, String matcher, String selector, String orderBy)`
`ArrayList<String>`	`getStorageUnits()`
`boolean`	`isCollectionSpaceExist(String csName)`
`boolean`	`isDomainExist(String domainName)`
`boolean`	`isEndianConvert()`
`boolean`	`isValid()`
`DBCursor`	`listBackup(BSONObject options, BSONObject matcher, BSONObject selector, BSONObject orderBy)`
`DBCursor`	`listCollections()`
`DBCursor`	`listCollectionSpaces()`
`DBCursor`	`listDomains(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint)`
`DBCursor`	`listProcedures(BSONObject condition)`
`DBCursor`	`listReplicaGroups()`
`DBCursor`	`listTasks(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint)`
`void`	`removeBackup(BSONObject options)`
`void`	`removeReplicaGroup(String rgName)`
`void`	`removeUser(String username, String password)`
`void`	`resetSnapshot()`
`void`	`rmProcedure(String name)`
`void`	`rollback()`
`void`	`setServerAddress(ServerAddress serverAddress)`
`void`	`setSessionAttr(BSONObject options)`
`void`	`waitTasks(long[] taskIDs)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - SDB_PAGESIZE_4K
```
public static final int SDB_PAGESIZE_4K
```
    另请参阅:
    常量字段值
  - SDB_PAGESIZE_8K
```
public static final int SDB_PAGESIZE_8K
```
    另请参阅:
    常量字段值
  - SDB_PAGESIZE_16K
```
public static final int SDB_PAGESIZE_16K
```
    另请参阅:
    常量字段值
  - SDB_PAGESIZE_32K
```
public static final int SDB_PAGESIZE_32K
```
    另请参阅:
    常量字段值
  - SDB_PAGESIZE_64K
```
public static final int SDB_PAGESIZE_64K
```
    另请参阅:
    常量字段值
  - SDB_PAGESIZE_DEFAULT
```
public static final int SDB_PAGESIZE_DEFAULT
```
    0 means using database's default pagesize, it 64k now
    
    另请参阅:
    常量字段值
  - SDB_LIST_CONTEXTS
```
public static final int SDB_LIST_CONTEXTS
```
    另请参阅:
    常量字段值
  - SDB_LIST_CONTEXTS_CURRENT
```
public static final int SDB_LIST_CONTEXTS_CURRENT
```
    另请参阅:
    常量字段值
  - SDB_LIST_SESSIONS
```
public static final int SDB_LIST_SESSIONS
```
    另请参阅:
    常量字段值
  - SDB_LIST_SESSIONS_CURRENT
```
public static final int SDB_LIST_SESSIONS_CURRENT
```
    另请参阅:
    常量字段值
  - SDB_LIST_COLLECTIONS
```
public static final int SDB_LIST_COLLECTIONS
```
    另请参阅:
    常量字段值
  - SDB_LIST_COLLECTIONSPACES
```
public static final int SDB_LIST_COLLECTIONSPACES
```
    另请参阅:
    常量字段值
  - SDB_LIST_STORAGEUNITS
```
public static final int SDB_LIST_STORAGEUNITS
```
    另请参阅:
    常量字段值
  - SDB_LIST_GROUPS
```
public static final int SDB_LIST_GROUPS
```
    另请参阅:
    常量字段值
  - SDB_LIST_STOREPROCEDURES
```
public static final int SDB_LIST_STOREPROCEDURES
```
    另请参阅:
    常量字段值
  - SDB_LIST_DOMAINS
```
public static final int SDB_LIST_DOMAINS
```
    另请参阅:
    常量字段值
  - SDB_LIST_TASKS
```
public static final int SDB_LIST_TASKS
```
    另请参阅:
    常量字段值
  - SDB_LIST_CS_IN_DOMAIN
```
public static final int SDB_LIST_CS_IN_DOMAIN
```
    另请参阅:
    常量字段值
  - SDB_LIST_CL_IN_DOMAIN
```
public static final int SDB_LIST_CL_IN_DOMAIN
```
    另请参阅:
    常量字段值
  - SDB_SNAP_CONTEXTS
```
public static final int SDB_SNAP_CONTEXTS
```
    另请参阅:
    常量字段值
  - SDB_SNAP_CONTEXTS_CURRENT
```
public static final int SDB_SNAP_CONTEXTS_CURRENT
```
    另请参阅:
    常量字段值
  - SDB_SNAP_SESSIONS
```
public static final int SDB_SNAP_SESSIONS
```
    另请参阅:
    常量字段值
  - SDB_SNAP_SESSIONS_CURRENT
```
public static final int SDB_SNAP_SESSIONS_CURRENT
```
    另请参阅:
    常量字段值
  - SDB_SNAP_COLLECTIONS
```
public static final int SDB_SNAP_COLLECTIONS
```
    另请参阅:
    常量字段值
  - SDB_SNAP_COLLECTIONSPACES
```
public static final int SDB_SNAP_COLLECTIONSPACES
```
    另请参阅:
    常量字段值
  - SDB_SNAP_DATABASE
```
public static final int SDB_SNAP_DATABASE
```
    另请参阅:
    常量字段值
  - SDB_SNAP_SYSTEM
```
public static final int SDB_SNAP_SYSTEM
```
    另请参阅:
    常量字段值
  - SDB_SNAP_CATALOG
```
public static final int SDB_SNAP_CATALOG
```
    另请参阅:
    常量字段值
  - FMP_FUNC_TYPE_INVALID
```
public static final int FMP_FUNC_TYPE_INVALID
```
    另请参阅:
    常量字段值
  - FMP_FUNC_TYPE_JS
```
public static final int FMP_FUNC_TYPE_JS
```
    另请参阅:
    常量字段值
  - FMP_FUNC_TYPE_C
```
public static final int FMP_FUNC_TYPE_C
```
    另请参阅:
    常量字段值
  - FMP_FUNC_TYPE_JAVA
```
public static final int FMP_FUNC_TYPE_JAVA
```
    另请参阅:
    常量字段值
  - CATALOG_GROUP_NAME
```
public static final String CATALOG_GROUP_NAME
```
    另请参阅:
    常量字段值
- 构造器详细资料
  - Sequoiadb
```
public Sequoiadb(String username,
         String password)
          throws BaseException
```
    参数:
    username - the user's name of the account
    password - the password of the account
    
    抛出:
    
    BaseException - "SDB_NETWORK" means network error, "SDB_INVALIDARG" means wrong address or the address don't map to the hosts table
  - Sequoiadb
```
public Sequoiadb(String connString,
         String username,
         String password)
          throws BaseException
```
    参数:
    connString - remote server address "IP : Port" or "IP"(port is 50000)
    username - the user's name of the account
    password - the password of the account
    
    抛出:
    
    BaseException - "SDB_NETWORK" means network error, "SDB_INVALIDARG" means wrong address or the address don't map to the hosts table
  - Sequoiadb
```
public Sequoiadb(String connString,
         String username,
         String password,
         ConfigOptions options)
          throws BaseException
```
    参数:
    connString - remote server address "IP : Port" or "IP"(port is 11810)
    username - the user's name of the account
    password - the password of the account
    options - the options for connection
    
    抛出:
    
    BaseException - "SDB_NETWORK" means network error, "SDB_INVALIDARG" means wrong address or the address don't map to the hosts table
  - Sequoiadb
```
public Sequoiadb(List<String> connStrings,
         String username,
         String password,
         ConfigOptions options)
          throws BaseException
```
    参数:
    connStrings - The array of the coord's address
    username - the user's name of the account
    password - the password of the account
    options - the options for connection
    
    抛出:
    
    BaseException - "SDB_NETWORK" means network error, "SDB_INVALIDARG" means wrong address or the address don't map to the hosts table in local computer
  - Sequoiadb
```
public Sequoiadb(String addr,
         int port,
         String username,
         String password)
          throws BaseException
```
    参数:
    addr - the address of coord
    port - the port of coord
    username - the user's name of the account
    password - the password of the account
    
    抛出:
    
    BaseException - "SDB_NETWORK" means network error, "SDB_INVALIDARG" means wrong address or the address don't map to the hosts table
  - Sequoiadb
```
public Sequoiadb(String addr,
         int port,
         String username,
         String password,
         ConfigOptions options)
          throws BaseException
```
    参数:
    addr - the address of coord
    port - the port of coord
    username - the user's name of the account
    password - the password of the account
    
    抛出:
    
    BaseException - "SDB_NETWORK" means network error, "SDB_INVALIDARG" means wrong address or the address don't map to the hosts table
- 方法详细资料
  - getConnection
```
public IConnection getConnection()
```
    返回:
    IConnection
  - getServerAddress
```
public ServerAddress getServerAddress()
```
    返回:
    ServerAddress
  - setServerAddress
```
public void setServerAddress(ServerAddress serverAddress)
```
    参数:
    serverAddress - the serverAddress object of remote server
  - isEndianConvert
```
public boolean isEndianConvert()
```
    返回:
    Big-Endian for true while Little-Endian for false
  - createUser
```
public void createUser(String username,
              String password)
                throws BaseException
```
    参数:
    username - The connection user name
    password - The connection password
    
    抛出:
    
    BaseException
  - removeUser
```
public void removeUser(String username,
              String password)
                throws BaseException
```
    参数:
    username - The connection user name
    password - The connection password
    
    抛出:
    
    BaseException
  - disconnect
```
public void disconnect()
                throws BaseException
```
    抛出:
    
    BaseException
  - isValid
```
public boolean isValid()
                throws BaseException
```
    返回:
    if the connection is valid, return true
    
    抛出:
    
    BaseException
  - changeConnectionOptions
```
public void changeConnectionOptions(ConfigOptions opts)
                             throws BaseException
```
    参数:
    opts - The connection options
    
    抛出:
    
    BaseException
  - createCollectionSpace
```
public CollectionSpace createCollectionSpace(String csName)
                                      throws BaseException
```
    参数:
    csName - The collection space name
    
    抛出:
    
    BaseException
  - createCollectionSpace
```
public CollectionSpace createCollectionSpace(String csName,
                                    int pageSize)
                                      throws BaseException
```
    参数:
    csName - The name of collection space
    pageSize - The Page Size as below:
    
    SDB_PAGESIZE_4K
    SDB_PAGESIZE_8K
    SDB_PAGESIZE_16K
    SDB_PAGESIZE_32K
    SDB_PAGESIZE_64K
    SDB_PAGESIZE_DEFAULT
    返回:
    the newly created collection space object
    
    抛出:
    
    BaseException
  - createCollectionSpace
```
public CollectionSpace createCollectionSpace(String csName,
                                    BSONObject options)
                                      throws BaseException
```
    参数:
    csName - The name of collection space
    options - Contains configuration informations for create collection space. The options are as below:
    
    PageSize : Assign how large the page size is for the collection created in this collection space, default to be 64K
    Domain : Assign which domain does current collection space belong to, it will belongs to the system domain if not assign this option
    返回:
    the newly created collection space object
    
    抛出:
    
    BaseException
  - dropCollectionSpace
```
public void dropCollectionSpace(String csName)
                         throws BaseException
```
    参数:
    csName - The collection space name
    
    抛出:
    
    BaseException
  - getCollectionSpace
```
public CollectionSpace getCollectionSpace(String csName)
                                   throws BaseException
```
    参数:
    csName - The collection space name.
    
    返回:
    The CollecionSpace handle.
    
    抛出:
    
    BaseException
  - isCollectionSpaceExist
```
public boolean isCollectionSpaceExist(String csName)
                               throws BaseException
```
    参数:
    csName - The collecion space name
    
    返回:
    True if existed or False if not existed
    
    抛出:
    
    BaseException
  - listCollectionSpaces
```
public DBCursor listCollectionSpaces()
                              throws BaseException
```
    返回:
    cursor of all collecionspace names
    
    抛出:
    
    BaseException
  - getCollectionSpaceNames
```
public ArrayList<String> getCollectionSpaceNames()
                                          throws BaseException
```
    返回:
    A list of all collecion space names
    
    抛出:
    
    BaseException
  - listCollections
```
public DBCursor listCollections()
                         throws BaseException
```
    返回:
    dbCursor of all collecions
    
    抛出:
    
    BaseException
  - getCollectionNames
```
public ArrayList<String> getCollectionNames()
                                     throws BaseException
```
    返回:
    A list of all collecion names
    
    抛出:
    
    BaseException
  - getStorageUnits
```
public ArrayList<String> getStorageUnits()
                                  throws BaseException
```
    返回:
    A list of all storage units
    
    抛出:
    
    BaseException
  - resetSnapshot
```
public void resetSnapshot()
                   throws BaseException
```
    抛出:
    
    BaseException
  - getList
```
public DBCursor getList(int listType,
               BSONObject query,
               BSONObject selector,
               BSONObject orderBy)
                 throws BaseException
```
    参数:
    listType - The list type as below:
    
    Sequoiadb.SDB_LIST_CONTEXTS : Get all contexts list
    Sequoiadb.SDB_LIST_CONTEXTS_CURRENT : Get contexts list for the current session
    Sequoiadb.SDB_LIST_SESSIONS : Get all sessions list
    Sequoiadb.SDB_LIST_SESSIONS_CURRENT : Get the current session
    Sequoiadb.SDB_LIST_COLLECTIONS : Get all collections list
    Sequoiadb.SDB_LIST_COLLECTIONSPACES : Get all collection spaces list
    Sequoiadb.SDB_LIST_STORAGEUNITS : Get storage units list
    Sequoiadb.SDB_LIST_GROUPS : Get replica group list ( only applicable in sharding env )
    Sequoiadb.SDB_LIST_STOREPROCEDURES : Get stored procedure list ( only applicable in sharding env )
    Sequoiadb.SDB_LIST_DOMAINS : Get all the domains list ( only applicable in sharding env )
    Sequoiadb.SDB_LIST_TASKS : Get all the running split tasks ( only applicable in sharding env )
    query - The matching rule, match all the documents if null.
    selector - The selective rule, return the whole document if null.
    orderBy - The ordered rule, never sort if null.
    
    抛出:
    
    BaseException
  - flushConfigure
```
public void flushConfigure(BSONObject param)
                    throws BaseException
```
    参数:
    param - The param of flush, pass {"Global":true} or {"Global":false} In cluster environment, passing {"Global":true} will flush data's and catalog's configuration file, while passing {"Global":false} will flush coord's configuration file In stand-alone environment, both them have the same behaviour
    
    抛出:
    
    BaseException
  - execUpdate
```
public void execUpdate(String sql)
                throws BaseException
```
    参数:
    sql - the SQL command.
    
    抛出:
    
    BaseException
  - exec
```
public DBCursor exec(String sql)
              throws BaseException
```
    参数:
    sql - the SQL command
    
    返回:
    the DBCursor of the result
    
    抛出:
    
    BaseException
  - getSnapshot
```
public DBCursor getSnapshot(int snapType,
                   String matcher,
                   String selector,
                   String orderBy)
                     throws BaseException
```
    参数:
    snapType - The snapshot types are as below:
    
    Sequoiadb.SDB_SNAP_CONTEXTS : Get all contexts' snapshot
    Sequoiadb.SDB_SNAP_CONTEXTS_CURRENT : Get the current context's snapshot
    Sequoiadb.SDB_SNAP_SESSIONS : Get all sessions' snapshot
    Sequoiadb.SDB_SNAP_SESSIONS_CURRENT : Get the current session's snapshot
    Sequoiadb.SDB_SNAP_COLLECTIONS : Get the collections' snapshot
    Sequoiadb.SDB_SNAP_COLLECTIONSPACES : Get the collection spaces' snapshot
    Sequoiadb.SDB_SNAP_DATABASE : Get database's snapshot
    Sequoiadb.SDB_SNAP_SYSTEM : Get system's snapshot
    Sequoiadb.SDB_SNAP_CATALOG : Get catalog's snapshot
    Sequoiadb.SDB_LIST_GROUPS : Get replica group list ( only applicable in sharding env )
    Sequoiadb.SDB_LIST_STOREPROCEDURES : Get stored procedure list ( only applicable in sharding env )
    matcher - the matching rule, match all the documents if null
    selector - the selective rule, return the whole document if null
    orderBy - the ordered rule, never sort if null
    
    返回:
    the DBCursor instance of the result
    
    抛出:
    
    BaseException
  - getSnapshot
```
public DBCursor getSnapshot(int snapType,
                   BSONObject matcher,
                   BSONObject selector,
                   BSONObject orderBy)
                     throws BaseException
```
    参数:
    snapType - The snapshot types are as below:
    
    Sequoiadb.SDB_SNAP_CONTEXTS : Get all contexts' snapshot
    Sequoiadb.SDB_SNAP_CONTEXTS_CURRENT : Get the current context's snapshot
    Sequoiadb.SDB_SNAP_SESSIONS : Get all sessions' snapshot
    Sequoiadb.SDB_SNAP_SESSIONS_CURRENT : Get the current session's snapshot
    Sequoiadb.SDB_SNAP_COLLECTIONS : Get the collections' snapshot
    Sequoiadb.SDB_SNAP_COLLECTIONSPACES : Get the collection spaces' snapshot
    Sequoiadb.SDB_SNAP_DATABASE : Get database's snapshot
    Sequoiadb.SDB_SNAP_SYSTEM : Get system's snapshot
    Sequoiadb.SDB_SNAP_CATALOG : Get catalog's snapshot
    Sequoiadb.SDB_LIST_GROUPS : Get replica group list ( only applicable in sharding env )
    Sequoiadb.SDB_LIST_STOREPROCEDURES : Get stored procedure list ( only applicable in sharding env )
    matcher - the matching rule, match all the documents if null
    selector - the selective rule, return the whole document if null
    orderBy - the ordered rule, never sort if null
    
    返回:
    the DBCursor instance of the result
    
    抛出:
    
    BaseException
  - beginTransaction
```
public void beginTransaction()
                      throws BaseException
```
    抛出:
    
    BaseException
  - commit
```
public void commit()
            throws BaseException
```
    抛出:
    
    BaseException
  - rollback
```
public void rollback()
              throws BaseException
```
    抛出:
    
    BaseException
  - crtJSProcedure
```
public void crtJSProcedure(String code)
                    throws BaseException
```
    参数:
    code - The code of store procedure
    
    抛出:
    
    BaseException
  - rmProcedure
```
public void rmProcedure(String name)
                 throws BaseException
```
    参数:
    name - The name of store procedure to be removed
    
    抛出:
    
    BaseException
  - listProcedures
```
public DBCursor listProcedures(BSONObject condition)
                        throws BaseException
```
    参数:
    condition - The condition of list eg: {"name":"sum"}
    
    抛出:
    
    BaseException
  - evalJS
```
public Sequoiadb.SptEvalResult evalJS(String code)
                               throws BaseException
```
    参数:
    code - The javasript code
    
    返回:
    The result of the eval operation, including the return value type, the return data and the error message. If succeed to eval, error message is null, and we can extract the eval result from the return cursor and return type, if not, the return cursor and the return type are null, we can extract the error mssage for more detail.
    
    抛出:
    
    BaseException
  - backupOffline
```
public void backupOffline(BSONObject options)
                   throws BaseException
```
    参数:
    options - Contains a series of backup configuration infomations. Backup the whole cluster if null. The "options" contains 5 options as below. All the elements in options are optional. eg: {"GroupName":["rgName1", "rgName2"], "Path":"/opt/sequoiadb/backup", "Name":"backupName", "Description":description, "EnsureInc":true, "OverWrite":true}
    
    GroupID : The id(s) of replica group(s) which to be backuped
    GroupName : The name(s) of replica group(s) which to be backuped
    Name : The name for the backup
    Path : The backup path, if not assign, use the backup path assigned in the configuration file, the path support to use wildcard(%g/%G:group name, %h/%H:host name, %s/%S:service name). e.g. {Path:"/opt/sequoiadb/backup/%g"}
    isSubDir : Whether the path specified by paramer "Path" is a subdirectory of the path specified in the configuration file, default to be false
    Prefix : The prefix of name for the backup, default to be null. e.g. {Prefix:"%g_bk_"}
    EnableDateDir : Whether turn on the feature which will create subdirectory named to current date like "YYYY-MM-DD" automatically, default to be false
    Description : The description for the backup
    EnsureInc : Whether turn on increment synchronization, default to be false
    OverWrite : Whether overwrite the old backup file with the same name, default to be false
    抛出:
    
    BaseException
  - listBackup
```
public DBCursor listBackup(BSONObject options,
                  BSONObject matcher,
                  BSONObject selector,
                  BSONObject orderBy)
                    throws BaseException
```
    参数:
    options - Contains configuration infomations for remove backups, list all the backups in the default backup path if null. The "options" contains 3 options as below. All the elements in options are optional. eg: {"GroupName":["rgName1", "rgName2"], "Path":"/opt/sequoiadb/backup", "Name":"backupName"}
    
    GroupName : Assign the backups of specifed replica groups to be list
    Path : Assign the backups in specifed path to be list, if not assign, use the backup path asigned in the configuration file
    Name : Assign the backups with specifed name to be list
    matcher - The matching rule, return all the documents if null
    selector - The selective rule, return the whole document if null
    orderBy - The ordered rule, never sort if null
    
    返回:
    the DBCursor of the backup or null while having no backup infonation.
    
    抛出:
    
    BaseException
  - removeBackup
```
public void removeBackup(BSONObject options)
                  throws BaseException
```
    参数:
    options - Contains configuration infomations for remove backups, remove all the backups in the default backup path if null. The "options" contains 3 options as below. All the elements in options are optional. eg: {"GroupName":["rgName1", "rgName2"], "Path":"/opt/sequoiadb/backup", "Name":"backupName"}
    
    GroupName : Assign the backups of specifed replica grouops to be remove
    Path : Assign the backups in specifed path to be remove, if not assign, use the backup path asigned in the configuration file
    Name : Assign the backups with specifed name to be remove
    抛出:
    
    BaseException
  - listTasks
```
public DBCursor listTasks(BSONObject matcher,
                 BSONObject selector,
                 BSONObject orderBy,
                 BSONObject hint)
                   throws BaseException
```
    参数:
    matcher - The matching rule, return all the documents if null
    selector - The selective rule, return the whole document if null
    orderBy - The ordered rule, never sort if null
    hint - The hint, automatically match the optimal hint if null
    
    抛出:
    
    BaseException
  - waitTasks
```
public void waitTasks(long[] taskIDs)
               throws BaseException
```
    参数:
    taskIDs - The array of task id
    
    抛出:
    
    BaseException
  - cancelTask
```
public void cancelTask(long taskID,
              boolean isAsync)
                throws BaseException
```
    参数:
    taskID - The task id
    isAsync - The operation "cancel task" is async or not, "true" for async, "false" for sync. Default sync.
    
    抛出:
    
    BaseException
  - setSessionAttr
```
public void setSessionAttr(BSONObject options)
                    throws BaseException
```
    参数:
    options - The configuration options for the current session.The options are as below:
    
    PreferedInstance : indicate which instance to respond read request in current session. eg:{"PreferedInstance":"m"/"M"/"s"/"S"/"a"/"A"/1-7}, prefer to choose "read and write instance"/"read only instance"/"anyone instance"/instance1-insatance7, default to be {"PreferedInstance":"A"}, means would like to choose anyone instance to respond read request such as query.
    抛出:
    
    BaseException
  - closeAllCursors
```
public void closeAllCursors()
                     throws BaseException
```
    抛出:
    
    BaseException
  - listReplicaGroups
```
public DBCursor listReplicaGroups()
                           throws BaseException
```
    返回:
    cursor of all collecionspace names
    
    抛出:
    
    BaseException
  - isDomainExist
```
public boolean isDomainExist(String domainName)
                      throws BaseException
```
    参数:
    domainName - the name of domain
    
    返回:
    True if existed or False if not existed
    
    抛出:
    
    BaseException
  - createDomain
```
public Domain createDomain(String domainName,
                  BSONObject options)
                    throws BaseException
```
    参数:
    domainName - The name of the creating domain
    options - The options for the domain. The options are as below:
    
    Groups : the list of the replica groups' names which the domain is going to contain. eg: { "Groups": [ "group1", "group2", "group3" ] } If this argument is not included, the domain will contain all replica groups in the cluster.
    AutoSplit : If this option is set to be true, while creating collection(ShardingType is "hash") in this domain, the data of this collection will be split(hash split) into all the groups in this domain automatically. However, it won't automatically split data into those groups which were add into this domain later. eg: { "Groups": [ "group1", "group2", "group3" ], "AutoSplit: true" }
    返回:
    the newly created collection space object
    
    抛出:
    
    BaseException
  - dropDomain
```
public void dropDomain(String domainName)
                throws BaseException
```
    参数:
    domainName - the name of the domain
    
    抛出:
    
    BaseException
  - getDomain
```
public Domain getDomain(String domainName)
                 throws BaseException
```
    参数:
    domainName - the name of the domain
    
    返回:
    the Domain instance
    
    抛出:
    
    BaseException - If the domain not exit, throw BaseException with the error type "SDB_CAT_DOMAIN_NOT_EXIST"
  - listDomains
```
public DBCursor listDomains(BSONObject matcher,
                   BSONObject selector,
                   BSONObject orderBy,
                   BSONObject hint)
                     throws BaseException
```
    参数:
    matcher - the matching rule, return all the documents if null
    selector - the selective rule, return the whole document if null
    orderBy - the ordered rule, never sort if null
    hint - the hint, automatically match the optimal hint if null
    
    抛出:
    
    BaseException
  - getReplicaGroupNames
```
public ArrayList<String> getReplicaGroupNames()
                                       throws BaseException
```
    返回:
    A list of all the replica groups' names.
    
    抛出:
    
    BaseException
  - getReplicaGroupsInfo
```
public ArrayList<String> getReplicaGroupsInfo()
                                       throws BaseException
```
    返回:
    A list of informations of the replica groups.
    
    抛出:
    
    BaseException
  - getReplicaGroup
```
public ReplicaGroup getReplicaGroup(String rgName)
                             throws BaseException
```
    参数:
    rgName - replica group's name
    
    返回:
    A replica group object or null for not exit.
    
    抛出:
    
    BaseException
  - getReplicaGroup
```
public ReplicaGroup getReplicaGroup(int rgId)
                             throws BaseException
```
    参数:
    rgId - replica group id
    
    返回:
    A replica group object or null for not exit.
    
    抛出:
    
    BaseException
  - createReplicaGroup
```
public ReplicaGroup createReplicaGroup(String rgName)
                                throws BaseException
```
    参数:
    rgName - replica group's name
    
    返回:
    A replica group object.
    
    抛出:
    
    BaseException
  - removeReplicaGroup
```
public void removeReplicaGroup(String rgName)
                        throws BaseException
```
    参数:
    rgName - replica group's name
    
    抛出:
    
    BaseException
  - activateReplicaGroup
```
public void activateReplicaGroup(String rgName)
                          throws BaseException
```
    参数:
    rgName - replica group name
    
    抛出:
    
    BaseException
  - createReplicaCataGroup
```
public void createReplicaCataGroup(String hostName,
                          int port,
                          String dbPath,
                          Map<String,String> configure)
```
    参数:
    hostName - The host name
    port - The port
    dbpath - The database path
    configure - The configure options
    
    抛出:
    
    BaseException

类 Sequoiadb

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

SDB_PAGESIZE_4K

SDB_PAGESIZE_8K

SDB_PAGESIZE_16K

SDB_PAGESIZE_32K

SDB_PAGESIZE_64K

SDB_PAGESIZE_DEFAULT

SDB_LIST_CONTEXTS

SDB_LIST_CONTEXTS_CURRENT

SDB_LIST_SESSIONS

SDB_LIST_SESSIONS_CURRENT

SDB_LIST_COLLECTIONS

SDB_LIST_COLLECTIONSPACES

SDB_LIST_STORAGEUNITS

SDB_LIST_GROUPS

SDB_LIST_STOREPROCEDURES

SDB_LIST_DOMAINS

SDB_LIST_TASKS

SDB_LIST_CS_IN_DOMAIN

SDB_LIST_CL_IN_DOMAIN

SDB_SNAP_CONTEXTS

SDB_SNAP_CONTEXTS_CURRENT

SDB_SNAP_SESSIONS

SDB_SNAP_SESSIONS_CURRENT

SDB_SNAP_COLLECTIONS

SDB_SNAP_COLLECTIONSPACES

SDB_SNAP_DATABASE

SDB_SNAP_SYSTEM

SDB_SNAP_CATALOG

FMP_FUNC_TYPE_INVALID

FMP_FUNC_TYPE_JS

FMP_FUNC_TYPE_C

FMP_FUNC_TYPE_JAVA

CATALOG_GROUP_NAME

构造器详细资料

Sequoiadb

Sequoiadb

Sequoiadb

Sequoiadb

Sequoiadb

Sequoiadb

方法详细资料

getConnection

getServerAddress

setServerAddress

isEndianConvert

createUser

removeUser

disconnect

isValid

changeConnectionOptions

createCollectionSpace

createCollectionSpace

createCollectionSpace

dropCollectionSpace

getCollectionSpace

isCollectionSpaceExist

listCollectionSpaces

getCollectionSpaceNames

listCollections

getCollectionNames

getStorageUnits

resetSnapshot

getList

flushConfigure

execUpdate

exec

getSnapshot

getSnapshot

beginTransaction

commit

rollback

crtJSProcedure

rmProcedure