Sequoiadb (SequoiaDB Java Driver 3.0 API)

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

所有已实现的接口:

Closeable, AutoCloseable
```
public class Sequoiadb
extends Object
implements Closeable
```
The connection with SequoiaDB server.

嵌套类概要

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

static class Sequoiadb.SptEvalResult
Class for executing stored procedure result.

static class Sequoiadb.SptReturnType

嵌套类
限定符和类型	类和说明
`static class`	`Sequoiadb.SptEvalResult` Class for executing stored procedure result.
`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_LIST_TRANSACTIONS`
`static int`	`SDB_LIST_TRANSACTIONS_CURRENT`
`static int`	`SDB_PAGESIZE_16K` specified the package size of the collections in current collection space to be 16K
`static int`	`SDB_PAGESIZE_32K` specified the package size of the collections in current collection space to be 32K
`static int`	`SDB_PAGESIZE_4K` specified the package size of the collections in current collection space to be 4K
`static int`	`SDB_PAGESIZE_64K` specified the package size of the collections in current collection space to be 64K
`static int`	`SDB_PAGESIZE_8K` specified the package size of the collections in current collection space to be 8K
`static int`	`SDB_PAGESIZE_DEFAULT` 0 means using database's default pagesize, it 64k now
`static int`	`SDB_SNAP_ACCESSPLANS`
`static int`	`SDB_SNAP_CATALOG`
`static int`	`SDB_SNAP_COLLECTIONS`
`static int`	`SDB_SNAP_COLLECTIONSPACES`
`static int`	`SDB_SNAP_CONFIGS`
`static int`	`SDB_SNAP_CONTEXTS`
`static int`	`SDB_SNAP_CONTEXTS_CURRENT`
`static int`	`SDB_SNAP_DATABASE`
`static int`	`SDB_SNAP_HEALTH`
`static int`	`SDB_SNAP_SESSIONS`
`static int`	`SDB_SNAP_SESSIONS_CURRENT`
`static int`	`SDB_SNAP_SYSTEM`
`static int`	`SDB_SNAP_TRANSACTIONS`
`static int`	`SDB_SNAP_TRANSACTIONS_CURRENT`

构造器概要

构造器
构造器和说明
`Sequoiadb(List<String> connStrings, String username, String password, ConfigOptions options)` Use a random valid address to connect to database.
`Sequoiadb(String host, int port, String username, String password)`
`Sequoiadb(String host, int port, String username, String password, ConfigOptions options)`
`Sequoiadb(String connString, String username, String password)`
`Sequoiadb(String connString, String username, String password, ConfigOptions options)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`activateReplicaGroup(String rgName)` Active replica group by name.
`void`	`analyze()` Analyze all collections and indexes to collect statistics information
`void`	`analyze(BSONObject options)` Analyze collection or index to collect statistics information
`void`	`backupOffline(BSONObject options)` Backup the whole database or specified replica group.
`void`	`beginTransaction()` Begin the transaction.
`void`	`cancelTask(long taskID, boolean isAsync)` Cancel the specified task.
`void`	`close()` Close the connection.
`void`	`closeAllCursors()` Close all the cursors created in current connection, we can't use those cursors to get data again.
`void`	`commit()` Commit the transaction.
`CollectionSpace`	`createCollectionSpace(String csName)` Create the named collection space with default SDB_PAGESIZE_64K.
`CollectionSpace`	`createCollectionSpace(String csName, BSONObject options)` Create collection space.
`CollectionSpace`	`createCollectionSpace(String csName, int pageSize)` Create collection space.
`Domain`	`createDomain(String domainName, BSONObject options)` Create a domain.
`void`	`createReplicaCataGroup(String hostName, int port, String dbPath, BSONObject options)` Create the replica Catalog group with the given options.
`ReplicaGroup`	`createReplicaGroup(String rgName)` Create replica group by name.
`void`	`createUser(String username, String password)` Create an user in current database.
`void`	`crtJSProcedure(String code)` Create a storage procedure.
`void`	`deleteConfig(BSONObject configs, BSONObject options)` Force the node to delete configs online.
`void`	`dropCollectionSpace(String csName)` Remove the named collection space.
`void`	`dropDomain(String domainName)` Drop a domain.
`Sequoiadb.SptEvalResult`	`evalJS(String code)` Eval javascript code.
`DBCursor`	`exec(String sql)` Execute sql in database.
`void`	`execUpdate(String sql)` Execute sql in database.
`void`	`flushConfigure(BSONObject options)` Flush the options to configuration file.
`ByteOrder`	`getByteOrder()`
`ArrayList<String>`	`getCollectionNames()` Get all the collection names.
`CollectionSpace`	`getCollectionSpace(String csName)` Get the named collection space.
`ArrayList<String>`	`getCollectionSpaceNames()` Get all the collection space names.
`Domain`	`getDomain(String domainName)` Get the specified domain.
`String`	`getHost()`
`String`	`getIP()`
`long`	`getLastUseTime()`
`DBCursor`	`getList(int listType, BSONObject query, BSONObject selector, BSONObject orderBy)` Get the information of specified type.
`String`	`getNodeName()`
`int`	`getPort()`
`ReplicaGroup`	`getReplicaGroup(int rgId)` Get replica group by id.
`ReplicaGroup`	`getReplicaGroup(String rgName)` Get replica group by name.
`ArrayList<String>`	`getReplicaGroupNames()` Get all the replica groups' name.
`ArrayList<String>`	`getReplicaGroupsInfo()` Get the information of the replica groups.
`BSONObject`	`getSessionAttr()` Get the attributes of the current session.
`DBCursor`	`getSnapshot(int snapType, BSONObject matcher, BSONObject selector, BSONObject orderBy)` Get snapshot of the database.
`DBCursor`	`getSnapshot(int snapType, BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, long skipRows, long returnRows)` Get snapshot of the database.
`DBCursor`	`getSnapshot(int snapType, String matcher, String selector, String orderBy)` Get snapshot of the database.
`ArrayList<String>`	`getStorageUnits()` Get all the storage units.
`static void`	`initClient(ClientOptions options)` Initialize the configuration options for client.
`void`	`invalidateCache(BSONObject options)` Clear the cache of the nodes (data/coord node).
`boolean`	`isClosed()` Whether the connection has been closed or not.
`boolean`	`isCollectionSpaceExist(String csName)` Verify the existence of collection space.
`boolean`	`isDomainExist(String domainName)` Verify the existence of domain.
`boolean`	`isRelicaGroupExist(String rgName)` whether the replica group exists in the database or not
`boolean`	`isReplicaGroupExist(int rgId)` whether the replica group exists in the database or not
`boolean`	`isValid()` Send a test message to database to test whether the connection is valid or not.
`DBCursor`	`listBackup(BSONObject options, BSONObject matcher, BSONObject selector, BSONObject orderBy)` List the backups.
`DBCursor`	`listCollections()` Get all the collections.
`DBCursor`	`listCollectionSpaces()` Get all the collection spaces.
`DBCursor`	`listDomains(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint)` List domains.
`DBCursor`	`listProcedures(BSONObject condition)` List the storage procedures.
`DBCursor`	`listReplicaGroups()` List all the replica group.
`DBCursor`	`listTasks(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint)` List the tasks.
`void`	`loadCollectionSpace(String csName, BSONObject options)`
`void`	`msg(String message)` Send message to server.
`void`	`releaseResource()` Release the resource of the connection.
`void`	`removeBackup(BSONObject options)` Remove the backups.
`void`	`removeReplicaGroup(String rgName)` Remove replica group by name.
`void`	`removeUser(String username, String password)` Remove the specified user from current database.
`void`	`renameCollectionSpace(String oldName, String newName)`
`void`	`resetSnapshot()` Reset the snapshot.
`void`	`resetSnapshot(BSONObject options)` Reset the snapshot.
`void`	`rmProcedure(String name)` Remove a store procedure.
`void`	`rollback()` Rollback the transaction.
`void`	`setSessionAttr(BSONObject options)` Set the attributes of the current session.
`void`	`sync()` Sync the whole database to disk.
`void`	`sync(BSONObject options)` Sync the database to disk.
`String`	`toString()`
`void`	`unloadCollectionSpace(String csName, BSONObject options)`
`void`	`updateConfig(BSONObject configs, BSONObject options)` Force the node to update configs online.
`void`	`waitTasks(long[] taskIDs)` Wait the tasks to finish.

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

- 字段详细资料
  - CATALOG_GROUP_NAME
```
public static final String CATALOG_GROUP_NAME
```
    另请参阅:
    
    常量字段值
  - FMP_FUNC_TYPE_C
```
public static final int FMP_FUNC_TYPE_C
```
    另请参阅:
    
    常量字段值
  - FMP_FUNC_TYPE_INVALID
```
public static final int FMP_FUNC_TYPE_INVALID
```
    另请参阅:
    
    常量字段值
  - FMP_FUNC_TYPE_JAVA
```
public static final int FMP_FUNC_TYPE_JAVA
```
    另请参阅:
    
    常量字段值
  - FMP_FUNC_TYPE_JS
```
public static final int FMP_FUNC_TYPE_JS
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_CL_IN_DOMAIN
```
public static final int SDB_LIST_CL_IN_DOMAIN
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_COLLECTIONS
```
public static final int SDB_LIST_COLLECTIONS
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_COLLECTIONSPACES
```
public static final int SDB_LIST_COLLECTIONSPACES
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_CONTEXTS
```
public static final int SDB_LIST_CONTEXTS
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_CONTEXTS_CURRENT
```
public static final int SDB_LIST_CONTEXTS_CURRENT
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_CS_IN_DOMAIN
```
public static final int SDB_LIST_CS_IN_DOMAIN
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_DOMAINS
```
public static final int SDB_LIST_DOMAINS
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_GROUPS
```
public static final int SDB_LIST_GROUPS
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_SESSIONS
```
public static final int SDB_LIST_SESSIONS
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_SESSIONS_CURRENT
```
public static final int SDB_LIST_SESSIONS_CURRENT
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_STORAGEUNITS
```
public static final int SDB_LIST_STORAGEUNITS
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_STOREPROCEDURES
```
public static final int SDB_LIST_STOREPROCEDURES
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_TASKS
```
public static final int SDB_LIST_TASKS
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_TRANSACTIONS
```
public static final int SDB_LIST_TRANSACTIONS
```
    另请参阅:
    
    常量字段值
  - SDB_LIST_TRANSACTIONS_CURRENT
```
public static final int SDB_LIST_TRANSACTIONS_CURRENT
```
    另请参阅:
    
    常量字段值
  - SDB_PAGESIZE_16K
```
public static final int SDB_PAGESIZE_16K
```
    specified the package size of the collections in current collection space to be 16K
    
    另请参阅:
    
    常量字段值
  - SDB_PAGESIZE_32K
```
public static final int SDB_PAGESIZE_32K
```
    specified the package size of the collections in current collection space to be 32K
    
    另请参阅:
    
    常量字段值
  - SDB_PAGESIZE_4K
```
public static final int SDB_PAGESIZE_4K
```
    specified the package size of the collections in current collection space to be 4K
    
    另请参阅:
    
    常量字段值
  - SDB_PAGESIZE_64K
```
public static final int SDB_PAGESIZE_64K
```
    specified the package size of the collections in current collection space to be 64K
    
    另请参阅:
    
    常量字段值
  - SDB_PAGESIZE_8K
```
public static final int SDB_PAGESIZE_8K
```
    specified the package size of the collections in current collection space to be 8K
    
    另请参阅:
    
    常量字段值
  - SDB_PAGESIZE_DEFAULT
```
public static final int SDB_PAGESIZE_DEFAULT
```
    0 means using database's default pagesize, it 64k now
    
    另请参阅:
    
    常量字段值
  - SDB_SNAP_ACCESSPLANS
```
public static final int SDB_SNAP_ACCESSPLANS
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_CATALOG
```
public static final int SDB_SNAP_CATALOG
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_COLLECTIONS
```
public static final int SDB_SNAP_COLLECTIONS
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_COLLECTIONSPACES
```
public static final int SDB_SNAP_COLLECTIONSPACES
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_CONFIGS
```
public static final int SDB_SNAP_CONFIGS
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_CONTEXTS
```
public static final int SDB_SNAP_CONTEXTS
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_CONTEXTS_CURRENT
```
public static final int SDB_SNAP_CONTEXTS_CURRENT
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_DATABASE
```
public static final int SDB_SNAP_DATABASE
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_HEALTH
```
public static final int SDB_SNAP_HEALTH
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_SESSIONS
```
public static final int SDB_SNAP_SESSIONS
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_SESSIONS_CURRENT
```
public static final int SDB_SNAP_SESSIONS_CURRENT
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_SYSTEM
```
public static final int SDB_SNAP_SYSTEM
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_TRANSACTIONS
```
public static final int SDB_SNAP_TRANSACTIONS
```
    另请参阅:
    
    常量字段值
  - SDB_SNAP_TRANSACTIONS_CURRENT
```
public static final int SDB_SNAP_TRANSACTIONS_CURRENT
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - Sequoiadb
```
public Sequoiadb(List<String> connStrings,
                 String username,
                 String password,
                 ConfigOptions options)
          throws BaseException
```
    Use a random valid address to connect to database.
    
    参数:
    
    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 - If error happens.
  - Sequoiadb
```
public Sequoiadb(String host,
                 int port,
                 String username,
                 String password)
          throws BaseException
```
    参数:
    
    host - 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 host,
                 int port,
                 String username,
                 String password,
                 ConfigOptions options)
          throws BaseException
```
    参数:
    
    host - 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 connString,
                 String username,
                 String password)
          throws BaseException
```
    参数:
    
    connString - remote server address "Host:Port"
    
    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 "Host:Port"
    
    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.
- 方法详细资料
  - activateReplicaGroup
```
public void activateReplicaGroup(String rgName)
                          throws BaseException
```
    Active replica group by name.
    
    参数:
    
    rgName - replica group name
    
    抛出:
    
    BaseException - If error happens.
  - analyze
```
public void analyze()
             throws BaseException
```
    Analyze all collections and indexes to collect statistics information
    
    抛出:
    
    BaseException - If error happens.
    
    从以下版本开始:
    
    2.9
  - analyze
```
public void analyze(BSONObject options)
             throws BaseException
```
    Analyze collection or index to collect statistics information
    参数:
    options - The control options:(can be null)
    
    CollectionSpace: (String) Specify the collection space to be analyzed.
    
    Collection: (String) Specify the collection to be analyzed.
    
    Index: (String) Specify the index to be analyzed.
    
    Mode: (Int32) Specify the analyze mode (default is 1):
    
    Mode 1 will analyze with data samples.
    
    Mode 2 will analyze with full data.
    
    Mode 3 will generate default statistics.
    
    Mode 4 will reload statistics into memory cache.
    
    Mode 5 will clear statistics from memory cache.
    
    Other options: Some of other options are as below:(only take effect in coordinate nodes, please visit the official website to search "analyze" or "Location Elements" for more detail.) GroupID:int, GroupName:String, NodeID:int, HostName:String, svcname:String, ...
    抛出:
    
    BaseException - If error happens.
    
    从以下版本开始:
    
    2.9
  - backupOffline
```
public void backupOffline(BSONObject options)
                   throws BaseException
```
    Backup the whole database or specified replica group.
    参数:
    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 - If error happens.
  - beginTransaction
```
public void beginTransaction()
                      throws BaseException
```
    Begin the transaction.
    
    抛出:
    
    BaseException - If error happens.
  - cancelTask
```
public void cancelTask(long taskID,
                       boolean isAsync)
                throws BaseException
```
    Cancel the specified task.
    
    参数:
    
    taskID - The task id
    
    isAsync - The operation "cancel task" is async or not, "true" for async, "false" for sync. Default sync.
    
    抛出:
    
    BaseException - If error happens.
  - close
```
public void close()
           throws BaseException
```
    Close the connection.
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    BaseException - If error happens.
  - closeAllCursors
```
public void closeAllCursors()
                     throws BaseException
```
    Close all the cursors created in current connection, we can't use those cursors to get data again.
    
    抛出:
    
    BaseException - If error happens.
  - commit
```
public void commit()
            throws BaseException
```
    Commit the transaction.
    
    抛出:
    
    BaseException - If error happens.
  - createCollectionSpace
```
public CollectionSpace createCollectionSpace(String csName)
                                      throws BaseException
```
    Create the named collection space with default SDB_PAGESIZE_64K.
    
    参数:
    
    csName - The collection space name
    
    返回:
    
    the newly created collection space object
    
    抛出:
    
    BaseException - If error happens.
  - createCollectionSpace
```
public CollectionSpace createCollectionSpace(String csName,
                                             BSONObject options)
                                      throws BaseException
```
    Create collection space.
    参数:
    
    csName - The name of collection space
    options - Contains configuration information 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 - If error happens.
  - createCollectionSpace
```
public CollectionSpace createCollectionSpace(String csName,
                                             int pageSize)
                                      throws BaseException
```
    Create collection space.
    参数:
    
    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 - If error happens.
  - createDomain
```
public Domain createDomain(String domainName,
                           BSONObject options)
                    throws BaseException
```
    Create a domain.
    参数:
    
    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 - If error happens.
  - createReplicaCataGroup
```
public void createReplicaCataGroup(String hostName,
                                   int port,
                                   String dbPath,
                                   BSONObject options)
```
    Create the replica Catalog group with the given options.
    
    参数:
    
    hostName - The host name
    
    port - The port
    
    dbPath - The database path
    
    options - The configure options
    
    抛出:
    
    BaseException - If error happens.
  - createReplicaGroup
```
public ReplicaGroup createReplicaGroup(String rgName)
                                throws BaseException
```
    Create replica group by name.
    
    参数:
    
    rgName - replica group's name
    
    返回:
    
    A replica group object.
    
    抛出:
    
    BaseException - If error happens.
  - createUser
```
public void createUser(String username,
                       String password)
                throws BaseException
```
    Create an user in current database.
    
    参数:
    
    username - The connection user name
    
    password - The connection password
    
    抛出:
    
    BaseException - If error happens.
  - crtJSProcedure
```
public void crtJSProcedure(String code)
                    throws BaseException
```
    Create a storage procedure.
    
    参数:
    
    code - The code of storage procedure
    
    抛出:
    
    BaseException - If error happens.
  - deleteConfig
```
public void deleteConfig(BSONObject configs,
                         BSONObject options)
                  throws BaseException
```
    Force the node to delete configs online.
    
    参数:
    
    configs - The specific configuration parameters to delete
    
    options - Options The control options:(Only take effect in coordinate nodes) GroupID:INT32, GroupName:String, NodeID:INT32, HostName:String, svcname:String, ...
    
    抛出:
    
    BaseException - If error happens.
  - dropCollectionSpace
```
public void dropCollectionSpace(String csName)
                         throws BaseException
```
    Remove the named collection space.
    
    参数:
    
    csName - The collection space name
    
    抛出:
    
    BaseException - If error happens.
  - dropDomain
```
public void dropDomain(String domainName)
                throws BaseException
```
    Drop a domain.
    
    参数:
    
    domainName - the name of the domain
    
    抛出:
    
    BaseException - If error happens.
  - evalJS
```
public Sequoiadb.SptEvalResult evalJS(String code)
                               throws BaseException
```
    Eval javascript code.
    
    参数:
    
    code - The javascript 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 message for more detail.
    
    抛出:
    
    BaseException - If error happens.
  - exec
```
public DBCursor exec(String sql)
              throws BaseException
```
    Execute sql in database.
    
    参数:
    
    sql - the SQL command
    
    返回:
    
    the DBCursor of the result
    
    抛出:
    
    BaseException - If error happens.
  - execUpdate
```
public void execUpdate(String sql)
                throws BaseException
```
    Execute sql in database.
    
    参数:
    
    sql - the SQL command.
    
    抛出:
    
    BaseException - If error happens.
  - flushConfigure
```
public void flushConfigure(BSONObject options)
                    throws BaseException
```
    Flush the options to configuration file.
    
    参数:
    
    options - 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 - If error happens.
  - getByteOrder
```
public ByteOrder getByteOrder()
```
    返回:
    
    ByteOrder of SequoiaDB server.
    
    从以下版本开始:
    
    2.9
  - getCollectionNames
```
public ArrayList<String> getCollectionNames()
                                     throws BaseException
```
    Get all the collection names.
    
    返回:
    
    A list of all collection names
    
    抛出:
    
    BaseException - If error happens.
  - getCollectionSpace
```
public CollectionSpace getCollectionSpace(String csName)
                                   throws BaseException
```
    Get the named collection space. If the collection space not exit, throw BaseException with errcode SDB_DMS_CS_NOTEXIST.
    
    参数:
    
    csName - The collection space name.
    
    返回:
    
    the object of the specified collection space, or an exception when the collection space does not exist.
    
    抛出:
    
    BaseException - If error happens.
  - getCollectionSpaceNames
```
public ArrayList<String> getCollectionSpaceNames()
                                          throws BaseException
```
    Get all the collection space names.
    
    返回:
    
    A list of all collection space names
    
    抛出:
    
    BaseException - If error happens.
  - getDomain
```
public Domain getDomain(String domainName)
                 throws BaseException
```
    Get the specified domain.
    
    参数:
    
    domainName - the name of the domain
    
    返回:
    
    the Domain instance
    
    抛出:
    
    BaseException - If the domain not exit, throw BaseException with the error SDB_CAT_DOMAIN_NOT_EXIST.
  - getHost
```
public String getHost()
```
    返回:
    
    Host name of SequoiaDB server.
  - getIP
```
public String getIP()
```
    返回:
    
    IP address of SequoiaDB server.
  - getLastUseTime
```
public long getLastUseTime()
```
    返回:
    
    The last used time of this connection.
    
    从以下版本开始:
    
    2.9
  - getList
```
public DBCursor getList(int listType,
                        BSONObject query,
                        BSONObject selector,
                        BSONObject orderBy)
                 throws BaseException
```
    Get the information of specified type.
    
    参数:
    
    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 )
    Sequoiadb.SDB_LIST_TRANSACTIONS : Get all the transactions information.
    Sequoiadb.SDB_LIST_TRANSACTIONS_CURRENT : Get the transactions information of current session.
    
    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.
    
    返回:
    
    The target information by cursor.
    
    抛出:
    
    BaseException - If error happens.
  - getNodeName
```
public String getNodeName()
```
    返回:
    
    the node name of current coord node in format of "ip:port".
  - getPort
```
public int getPort()
```
    返回:
    
    Service port of SequoiaDB server.
  - getReplicaGroup
```
public ReplicaGroup getReplicaGroup(int rgId)
                             throws BaseException
```
    Get replica group by id.
    
    参数:
    
    rgId - replica group id
    
    返回:
    
    A replica group object or null for not exit.
    
    抛出:
    
    BaseException - If error happens.
  - getReplicaGroup
```
public ReplicaGroup getReplicaGroup(String rgName)
                             throws BaseException
```
    Get replica group by name.
    
    参数:
    
    rgName - replica group's name
    
    返回:
    
    A replica group object or null for not exit.
    
    抛出:
    
    BaseException - If error happens.
  - getReplicaGroupNames
```
public ArrayList<String> getReplicaGroupNames()
                                       throws BaseException
```
    Get all the replica groups' name.
    
    返回:
    
    A list of all the replica groups' names.
    
    抛出:
    
    BaseException - If error happens.
  - getReplicaGroupsInfo
```
public ArrayList<String> getReplicaGroupsInfo()
                                       throws BaseException
```
    Get the information of the replica groups.
    
    返回:
    
    A list of information of the replica groups.
    
    抛出:
    
    BaseException - If error happens.
  - getSessionAttr
```
public BSONObject getSessionAttr()
                          throws BaseException
```
    Get the attributes of the current session.
    
    返回:
    
    the BSONObject of the session attribute.
    
    抛出:
    
    BaseException - If error happens.
    
    从以下版本开始:
    
    2.8.5
  - getSnapshot
```
public DBCursor getSnapshot(int snapType,
                            BSONObject matcher,
                            BSONObject selector,
                            BSONObject orderBy)
                     throws BaseException
```
    Get snapshot of the database.
    
    参数:
    
    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_SNAP_TRANSACTIONS : Get snapshot of transactions in current session
    Sequoiadb.SDB_SNAP_TRANSACTIONS_CURRENT : Get snapshot of all the transactions
    SequoiaDB.SDB_SNAP_ACCESSPLANS : Get the snapshot of cached access plans
    Sequoiadb.SDB_SNAP_HEALTH : Get the snapshot of node health detection
    Sequoiadb.SDB_SNAP_CONFIGS : Get the snapshot of node configurations
    
    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 - If error happens.
  - getSnapshot
```
public DBCursor getSnapshot(int snapType,
                            BSONObject matcher,
                            BSONObject selector,
                            BSONObject orderBy,
                            BSONObject hint,
                            long skipRows,
                            long returnRows)
                     throws BaseException
```
    Get snapshot of the database.
    
    参数:
    
    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_SNAP_TRANSACTIONS : Get snapshot of transactions in current session
    Sequoiadb.SDB_SNAP_TRANSACTIONS_CURRENT : Get snapshot of all the transactions
    SequoiaDB.SDB_SNAP_ACCESSPLANS : Get the snapshot of cached access plans
    Sequoiadb.SDB_SNAP_HEALTH : Get the snapshot of node health detection
    Sequoiadb.SDB_SNAP_CONFIGS : Get the snapshot of node configurations
    
    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
    
    hint - the hint rule, the options provided for specific snapshot type format:{ '$Options': { } }
    
    skipRows - skip the first numToSkip documents, never skip if this parameter is 0
    
    returnRows - return the specified amount of documents, when returnRows is 0, return nothing, when returnRows is -1, return all the documents
    
    返回:
    
    the DBCursor instance of the result
    
    抛出:
    
    BaseException - If error happens.
  - getSnapshot
```
public DBCursor getSnapshot(int snapType,
                            String matcher,
                            String selector,
                            String orderBy)
                     throws BaseException
```
    Get snapshot of the database.
    
    参数:
    
    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_SNAP_TRANSACTIONS : Get the snapshot of all the transactions
    Sequoiadb.SDB_SNAP_TRANSACTIONS_CURRENT : Get the snapshot of current transactions
    Sequoiadb.SDB_SNAP_ACCESSPLANS : Get the snapshot of cached access plans
    Sequoiadb.SDB_SNAP_HEALTH : Get the snapshot of node health detection
    Sequoiadb.SDB_SNAP_CONFIGS : Get the snapshot of node configurations
    
    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 of the result
    
    抛出:
    
    BaseException - If error happens.
  - getStorageUnits
```
public ArrayList<String> getStorageUnits()
                                  throws BaseException
```
    Get all the storage units.
    
    返回:
    
    A list of all storage units
    
    抛出:
    
    BaseException - If error happens.
  - initClient
```
public static void initClient(ClientOptions options)
```
    Initialize the configuration options for client.
    
    参数:
    
    options - the configuration options for client
  - invalidateCache
```
public void invalidateCache(BSONObject options)
```
    Clear the cache of the nodes (data/coord node).
    参数:
    options - The control options:(Only take effect in coordinate nodes). About the parameter 'options', please reference to the official website(www.sequoiadb.com) and then search "命令位置参数" for more details. Some of its optional parameters are as bellow:
    
    Global(Bool) : execute this command in global or not. While 'options' is null, it's equals to {Glocal: true}.
    GroupID(INT32 or INT32 Array) : specified one or several groups by their group IDs. e.g. {GroupID:[1001, 1002]}.
    GroupName(String or String Array) : specified one or several groups by their group names. e.g. {GroupID:"group1"}.
    ...
  - isClosed
```
public boolean isClosed()
```
    Whether the connection has been closed or not.
    
    返回:
    
    return true when the connection has been closed
    
    从以下版本开始:
    
    2.2
  - isCollectionSpaceExist
```
public boolean isCollectionSpaceExist(String csName)
                               throws BaseException
```
    Verify the existence of collection space.
    
    参数:
    
    csName - The collection space name.
    
    返回:
    
    True if existed or false if not existed.
    
    抛出:
    
    BaseException - If error happens.
  - isDomainExist
```
public boolean isDomainExist(String domainName)
                      throws BaseException
```
    Verify the existence of domain.
    
    参数:
    
    domainName - the name of domain
    
    返回:
    
    True if existed or False if not existed
    
    抛出:
    
    BaseException - If error happens.
  - isRelicaGroupExist
```
public boolean isRelicaGroupExist(String rgName)
```
    whether the replica group exists in the database or not
    
    参数:
    
    rgName - replica group's name
    
    返回:
    
    true or false
  - isReplicaGroupExist
```
public boolean isReplicaGroupExist(int rgId)
```
    whether the replica group exists in the database or not
    
    参数:
    
    rgId - id of replica group
    
    返回:
    
    true or false
  - isValid
```
public boolean isValid()
                throws BaseException
```
    Send a test message to database to test whether the connection is valid or not.
    
    返回:
    
    if the connection is valid, return true
    
    抛出:
    
    BaseException - If error happens.
  - listBackup
```
public DBCursor listBackup(BSONObject options,
                           BSONObject matcher,
                           BSONObject selector,
                           BSONObject orderBy)
                    throws BaseException
```
    List the backups.
    参数:
    options - Contains configuration information for listing backups, list all the backups in the default backup path if null. The "options" contains several options as below. All the elements in options are optional. eg: {"GroupName":["rgName1", "rgName2"], "Path":"/opt/sequoiadb/backup", "Name":"backupName"}
    
    GroupID : Specified the group id of the backups, default to list all the backups of all the groups.
    GroupName : Specified the group name of the backups, default to list all the backups of all the groups.
    Path : Specified the path of the backups, default to use the backup path asigned in the configuration file.
    Name : Specified the name of backup, default to list all the backups.
    IsSubDir : Specified the "Path" is a subdirectory of the backup path asigned in the configuration file or not, default to be false.
    Prefix : Specified the prefix name of the backups, support for using wildcards("%g","%G","%h","%H","%s","%s"),such as: Prefix:"%g_bk_", default to not using wildcards.
    Detail : Display the detail of the backups or not, default to be false.
    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 information.
    
    抛出:
    
    BaseException - If error happens.
  - listCollections
```
public DBCursor listCollections()
                         throws BaseException
```
    Get all the collections.
    
    返回:
    
    Cursor of all collections
    
    抛出:
    
    BaseException - If error happens.
  - listCollectionSpaces
```
public DBCursor listCollectionSpaces()
                              throws BaseException
```
    Get all the collection spaces.
    
    返回:
    
    Cursor of all collection space names.
    
    抛出:
    
    BaseException - If error happens.
  - listDomains
```
public DBCursor listDomains(BSONObject matcher,
                            BSONObject selector,
                            BSONObject orderBy,
                            BSONObject hint)
                     throws BaseException
```
    List domains.
    
    参数:
    
    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 - Specified the index used to scan data. e.g. {"":"ageIndex"} means using index "ageIndex" to scan data(index scan); {"":null} means table scan. when hint is null, database automatically match the optimal index to scan data.
    
    抛出:
    
    BaseException - If error happens.
  - listProcedures
```
public DBCursor listProcedures(BSONObject condition)
                        throws BaseException
```
    List the storage procedures.
    
    参数:
    
    condition - The condition of list eg: {"name":"sum"}. return all if null
    
    抛出:
    
    BaseException - If error happens.
  - listReplicaGroups
```
public DBCursor listReplicaGroups()
                           throws BaseException
```
    List all the replica group.
    
    返回:
    
    information of all replica groups.
    
    抛出:
    
    BaseException - If error happens.
  - listTasks
```
public DBCursor listTasks(BSONObject matcher,
                          BSONObject selector,
                          BSONObject orderBy,
                          BSONObject hint)
                   throws BaseException
```
    List the tasks.
    
    参数:
    
    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 - Specified the index used to scan data. e.g. {"":"ageIndex"} means using index "ageIndex" to scan data(index scan); {"":null} means table scan. when hint is null, database automatically match the optimal index to scan data.
    
    抛出:
    
    BaseException - If error happens.
  - loadCollectionSpace
```
public void loadCollectionSpace(String csName,
                                BSONObject options)
                         throws BaseException
```
    参数:
    
    csName - The collection space name
    options - The control options:(Only take effect in coordinate nodes, can be null)
    
    GroupID:int
    
    GroupName:String
    
    NodeID:int
    
    HostName:String
    
    svcname:String
    
    ...
    抛出:
    
    BaseException - If error happens.
    
    从以下版本开始:
    
    2.8
  - msg
```
public void msg(String message)
```
    Send message to server.
    
    参数:
    
    message - The message to send to server.
  - releaseResource
```
public void releaseResource()
                     throws BaseException
```
    Release the resource of the connection.
    
    抛出:
    
    BaseException - If error happens.
    
    从以下版本开始:
    
    2.2
  - removeBackup
```
public void removeBackup(BSONObject options)
                  throws BaseException
```
    Remove the backups.
    参数:
    options - Contains configuration information for removing backups, remove all the backups in the default backup path if null. The "options" contains several options as below. All the elements in options are optional. eg: {"GroupName":["rgName1", "rgName2"], "Path":"/opt/sequoiadb/backup", "Name":"backupName"}
    
    GroupID : Specified the group id of the backups, default to list all the backups of all the groups.
    GroupName : Specified the group name of the backups, default to list all the backups of all the groups.
    Path : Specified the path of the backups, default to use the backup path asigned in the configuration file.
    Name : Specified the name of backup, default to list all the backups.
    IsSubDir : Specified the "Path" is a subdirectory of the backup path assigned in the configuration file or not, default to be false.
    Prefix : Specified the prefix name of the backups, support for using wildcards("%g","%G","%h","%H","%s","%s"),such as: Prefix:"%g_bk_", default to not using wildcards.
    Detail : Display the detail of the backups or not, default to be false.
    抛出:
    
    BaseException - If error happens.
  - removeReplicaGroup
```
public void removeReplicaGroup(String rgName)
                        throws BaseException
```
    Remove replica group by name.
    
    参数:
    
    rgName - replica group's name
    
    抛出:
    
    BaseException - If error happens.
  - removeUser
```
public void removeUser(String username,
                       String password)
                throws BaseException
```
    Remove the specified user from current database.
    
    参数:
    
    username - The connection user name
    
    password - The connection password
    
    抛出:
    
    BaseException - If error happens.
  - renameCollectionSpace
```
public void renameCollectionSpace(String oldName,
                                  String newName)
                           throws BaseException
```
    参数:
    
    oldName - The old collection space name
    
    newName - The new collection space name
    
    抛出:
    
    BaseException - If error happens.
    
    从以下版本开始:
    
    2.8
  - resetSnapshot
```
public void resetSnapshot()
                   throws BaseException
```
    Reset the snapshot.
    
    抛出:
    
    BaseException - If error happens.
  - resetSnapshot
```
public void resetSnapshot(BSONObject options)
                   throws BaseException
```
    Reset the snapshot.
    参数:
    options - The control options:(can be null)
    
    Type: (String) Specify the snapshot type to be reset (default is "all"):
    
    "sessions"
    
    "sessions current"
    
    "database"
    
    "health"
    
    "all"
    
    SessionID: (Int32) Specify the session ID to be reset.
    
    Other options: Some of other options are as below:(please visit the official website to search "Location Elements" for more detail.)
    
    GroupID:int,
    
    GroupName:String,
    
    NodeID:int,
    
    HostName:String,
    
    svcname:String,
    
    ...
    抛出:
    
    BaseException - If error happens.
  - rmProcedure
```
public void rmProcedure(String name)
                 throws BaseException
```
    Remove a store procedure.
    
    参数:
    
    name - The name of store procedure to be removed
    
    抛出:
    
    BaseException - If error happens.
  - rollback
```
public void rollback()
              throws BaseException
```
    Rollback the transaction.
    
    抛出:
    
    BaseException - If error happens.
  - setSessionAttr
```
public void setSessionAttr(BSONObject options)
                    throws BaseException
```
    Set the attributes of the current session.
    参数:
    options - The configuration options for the current session.The options are as below:
    
    PreferedInstance : Preferred instance for read request in the current session. Could be single value in "M", "m", "S", "s", "A", "a", 1-255, or BSON Array to include multiple values. e.g. { "PreferedInstance" : [ 1, 7 ] }.
    
    "M", "m": read and write instance( master instance ). If multiple numeric instances are given with "M", matched master instance will be chosen in higher priority. If multiple numeric instances are given with "M" or "m", master instance will be chosen if no numeric instance is matched.
    
    "S", "s": read only instance( slave instance ). If multiple numeric instances are given with "S", matched slave instances will be chosen in higher priority. If multiple numeric instances are given with "S" or "s", slave instance will be chosen if no numeric instance is matched.
    
    "A", "a": any instance.
    
    1-255: the instance with specified instance ID.
    
    If multiple alphabet instances are given, only first one will be used.
    
    If matched instance is not found, will choose instance by random.
    
    PreferedInstanceMode : The mode to choose query instance when multiple preferred instances are found in the current session. e.g. { "PreferedInstanceMode : "random" }.
    
    "random": choose the instance from matched instances by random.
    
    "ordered": choose the instance from matched instances by the order of "PreferedInstance".
    
    Timeout : The timeout (in ms) for operations in the current session. -1 means no timeout for operations. e.g. { "Timeout" : 10000 }.
    抛出:
    
    BaseException - If error happens.
  - sync
```
public void sync()
          throws BaseException
```
    Sync the whole database to disk.
    
    抛出:
    
    BaseException - If error happens.
    
    从以下版本开始:
    
    2.8
  - sync
```
public void sync(BSONObject options)
          throws BaseException
```
    Sync the database to disk.
    参数:
    options - The control options:(can be null)
    
    Deep:int Flush with deep mode or not. 1 in default. 0 for non-deep mode,1 for deep mode,-1 means use the configuration with server
    
    Block:boolean Flush with block mode or not. false in default.
    
    CollectionSpace:String Specify the collectionspace to sync. If not set, will sync all the collection spaces and logs, otherwise, will only sync the collection space specified.
    
    Some of other options are as below:(only take effect in coordinate nodes, please visit the official website to search "sync" or "Location Elements" for more detail.) GroupID:int, GroupName:String, NodeID:int, HostName:String, svcname:String ...
    抛出:
    
    BaseException - If error happens.
    
    从以下版本开始:
    
    2.8
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - unloadCollectionSpace
```
public void unloadCollectionSpace(String csName,
                                  BSONObject options)
                           throws BaseException
```
    参数:
    
    csName - The collection space name
    options - The control options:(Only take effect in coordinate nodes, can be null)
    
    GroupID:int
    
    GroupName:String
    
    NodeID:int
    
    HostName:String
    
    svcname:String
    
    ...
    抛出:
    
    BaseException - If error happens.
    
    从以下版本开始:
    
    2.8
  - updateConfig
```
public void updateConfig(BSONObject configs,
                         BSONObject options)
                  throws BaseException
```
    Force the node to update configs online.
    
    参数:
    
    configs - The specific configuration parameters to update
    
    options - Options The control options:(Only take effect in coordinate nodes) GroupID:INT32, GroupName:String, NodeID:INT32, HostName:String, svcname:String, ...
    
    抛出:
    
    BaseException - If error happens.
  - waitTasks
```
public void waitTasks(long[] taskIDs)
               throws BaseException
```
    Wait the tasks to finish.
    
    参数:
    
    taskIDs - The array of task id
    
    抛出:
    
    BaseException - If error happens.

类 Sequoiadb

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

CATALOG_GROUP_NAME

FMP_FUNC_TYPE_C

FMP_FUNC_TYPE_INVALID

FMP_FUNC_TYPE_JAVA

FMP_FUNC_TYPE_JS

SDB_LIST_CL_IN_DOMAIN

SDB_LIST_COLLECTIONS

SDB_LIST_COLLECTIONSPACES

SDB_LIST_CONTEXTS

SDB_LIST_CONTEXTS_CURRENT

SDB_LIST_CS_IN_DOMAIN

SDB_LIST_DOMAINS

SDB_LIST_GROUPS

SDB_LIST_SESSIONS

SDB_LIST_SESSIONS_CURRENT

SDB_LIST_STORAGEUNITS

SDB_LIST_STOREPROCEDURES

SDB_LIST_TASKS

SDB_LIST_TRANSACTIONS

SDB_LIST_TRANSACTIONS_CURRENT

SDB_PAGESIZE_16K

SDB_PAGESIZE_32K

SDB_PAGESIZE_4K

SDB_PAGESIZE_64K

SDB_PAGESIZE_8K

SDB_PAGESIZE_DEFAULT

SDB_SNAP_ACCESSPLANS

SDB_SNAP_CATALOG

SDB_SNAP_COLLECTIONS

SDB_SNAP_COLLECTIONSPACES

SDB_SNAP_CONFIGS

SDB_SNAP_CONTEXTS

SDB_SNAP_CONTEXTS_CURRENT

SDB_SNAP_DATABASE

SDB_SNAP_HEALTH

SDB_SNAP_SESSIONS

SDB_SNAP_SESSIONS_CURRENT

SDB_SNAP_SYSTEM

SDB_SNAP_TRANSACTIONS

SDB_SNAP_TRANSACTIONS_CURRENT

构造器详细资料

Sequoiadb

Sequoiadb

Sequoiadb

Sequoiadb

Sequoiadb

方法详细资料

activateReplicaGroup

analyze

analyze

backupOffline

beginTransaction

cancelTask

close

closeAllCursors

commit

createCollectionSpace

createCollectionSpace

createCollectionSpace

createDomain

createReplicaCataGroup

createReplicaGroup

createUser

crtJSProcedure

deleteConfig

dropCollectionSpace

dropDomain

evalJS

exec

execUpdate

flushConfigure

getByteOrder

getCollectionNames