Sequoiadb (SequoiaDB Java Driver 3.4 API)

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

All Implemented Interfaces:

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Sequoiadb.Builder` The builder of Sequoiadb.
`static class`	`Sequoiadb.SptEvalResult` Class for executing stored procedure result.
`static class`	`Sequoiadb.SptReturnType`

Field Summary

Fields
Modifier and Type	Field and Description
`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_BACKUPS` List of backups
`static int`	`SDB_LIST_CL_IN_DOMAIN`
`static int`	`SDB_LIST_COLLECTIONS` List of collections
`static int`	`SDB_LIST_COLLECTIONSPACES` List of collection spaces
`static int`	`SDB_LIST_CONTEXTS` List of all the contexts of all the sessions
`static int`	`SDB_LIST_CONTEXTS_CURRENT` List of the contexts of current session
`static int`	`SDB_LIST_CS_IN_DOMAIN`
`static int`	`SDB_LIST_DATASOURCES` List of data source
`static int`	`SDB_LIST_DOMAINS` List of domains
`static int`	`SDB_LIST_GROUPS` List of all the groups
`static int`	`SDB_LIST_SEQUENCES` List of sequences
`static int`	`SDB_LIST_SESSIONS` List of all the sessions
`static int`	`SDB_LIST_SESSIONS_CURRENT` List of current session
`static int`	`SDB_LIST_STORAGEUNITS` List of strorage units
`static int`	`SDB_LIST_STOREPROCEDURES` List of store procedures
`static int`	`SDB_LIST_SVCTASKS` List of service tasks
`static int`	`SDB_LIST_TASKS` List of tasks
`static int`	`SDB_LIST_TRANSACTIONS` List of all the transactions of all the sessions
`static int`	`SDB_LIST_TRANSACTIONS_CURRENT` List of all transactions of current session
`static int`	`SDB_LIST_USERS` List of users
`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` Snapshot of access plans
`static int`	`SDB_SNAP_CATALOG` Snapshot of catalog
`static int`	`SDB_SNAP_COLLECTIONS` Snapshot of collections
`static int`	`SDB_SNAP_COLLECTIONSPACES` Snapshot of collection spaces
`static int`	`SDB_SNAP_CONFIGS` Snapshot of configs
`static int`	`SDB_SNAP_CONTEXTS` Snapshot of all the contexts of all the sessions
`static int`	`SDB_SNAP_CONTEXTS_CURRENT` Snapshot of the contexts of current session
`static int`	`SDB_SNAP_DATABASE` Snapshot of database
`static int`	`SDB_SNAP_HEALTH` Snapshot of health
`static int`	`SDB_SNAP_INDEXSTATS` Snapshot of index statistics
`static int`	`SDB_SNAP_LATCHWAITS` Snapshot of latch waits
`static int`	`SDB_SNAP_LOCKWAITS` Snapshot of lock waits
`static int`	`SDB_SNAP_QUERIES` Snapshot of queries
`static int`	`SDB_SNAP_SEQUENCES` Snapshot of sequences
`static int`	`SDB_SNAP_SESSIONS` Snapshot of all the sessions
`static int`	`SDB_SNAP_SESSIONS_CURRENT` Snapshot of current session
`static int`	`SDB_SNAP_SVCTASKS` Snapshot of service tasks
`static int`	`SDB_SNAP_SYSTEM` Snapshot of system
`static int`	`SDB_SNAP_TRANSACTIONS` Snapshot of all the transactions of all the sessions
`static int`	`SDB_SNAP_TRANSACTIONS_CURRENT` Snapshot of all transactions of current session
`static int`	`SDB_SNAP_TRANSDEADLOCK` Snapshot of transaction deadlock
`static int`	`SDB_SNAP_TRANSWAITS` Snapshot of transaction waits

Constructor Summary

Constructors
Constructor and Description
`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)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`	`backup(BSONObject options)` Backup database.
`void`	`beginTransaction()` Begin the transaction.
`static Sequoiadb.Builder`	`builder()` Get a builder to create Sequoiadb instance.
`void`	`cancelTask(long taskID, boolean isAsync)` Cancel the specified task.
`protected void`	`cleanRequestBuff()`
`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.
`DataSource`	`createDataSource(String dataSourceName, String addresses, String user, String password, String type, BSONObject option)` Create data source.
`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.
`DBSequence`	`createSequence(String seqName)` Create a sequence.
`DBSequence`	`createSequence(String seqName, BSONObject options)` Create a sequence with the specified options.
`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`	`dropCollectionSpace(String csName, BSONObject options)` Remove the named collection space.
`void`	`dropDataSource(String dataSourceName)` Drop data source.
`void`	`dropDomain(String domainName)` Drop a domain.
`void`	`dropSequence(String seqName)` Drop the specified sequence.
`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.
`void`	`forceSession(long sessionID)` Stop the specified session's current operation and terminate it.
`void`	`forceSession(long sessionID, BSONObject option)` Stop the specified session's current operation and terminate it.
`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.
`com.sequoiadb.net.ConnectionProxy`	`getConnProxy()` Get the connection proxy object, which can be used to update the configuration of the connection object.
`int`	`getCurrentCacheSize()` Reserve.
`DataSource`	`getDataSource(String dataSourceName)` Get data source.
`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.
`DBCursor`	`getList(int listType, BSONObject query, BSONObject selector, BSONObject orderBy, BSONObject hint, long skipRows, long returnRows)` Get the information of specified type.
`String`	`getLocalAddress()`
`String`	`getNodeName()`
`int`	`getPort()`
`String`	`getRemoteAddress()`
`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.
`DBSequence`	`getSequence(String seqName)` Get the specified sequence.
`BSONObject`	`getSessionAttr()` Get the attributes of the current session from the local cache if possible.
`BSONObject`	`getSessionAttr(boolean useCache)` 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.
`ArrayList<String>`	`getStorageUnits()` Get all the storage units.
`static void`	`initClient(ClientOptions options)` Initialize the global configuration of SequoiaDB driver.
`void`	`interrupt()` Send an interrupt message to engine.
`void`	`interruptOperation()` Send "INTERRUPT_SELF" message to engine to stop the current operation.
`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`	`isDataSourceExist(String dataSourceName)` Whether the data source exists or not.
`boolean`	`isDomainExist(String domainName)` Verify the existence of domain.
`boolean`	`isRelicaGroupExist(String rgName)` This interface will be deprecated, please use `isReplicaGroupExist(String)`.
`boolean`	`isReplicaGroupExist(int rgId)` whether the replica group exists in the database or not
`boolean`	`isReplicaGroupExist(String rgName)` 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`	`listDataSources(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint)` List data source.
`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`	`renameSequence(String oldName, String newName)` Rename sequence.
`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)` Force the node to update configs online.
`void`	`updateConfig(BSONObject configs, BSONObject options)` Force the node to update configs online.
`void`	`waitTasks(long[] taskIDs)` Wait the tasks to finish.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CATALOG_GROUP_NAME
```
public static final String CATALOG_GROUP_NAME
```
    See Also:
    
    Constant Field Values
  - FMP_FUNC_TYPE_C
```
public static final int FMP_FUNC_TYPE_C
```
    See Also:
    
    Constant Field Values
  - FMP_FUNC_TYPE_INVALID
```
public static final int FMP_FUNC_TYPE_INVALID
```
    See Also:
    
    Constant Field Values
  - FMP_FUNC_TYPE_JAVA
```
public static final int FMP_FUNC_TYPE_JAVA
```
    See Also:
    
    Constant Field Values
  - FMP_FUNC_TYPE_JS
```
public static final int FMP_FUNC_TYPE_JS
```
    See Also:
    
    Constant Field Values
  - SDB_LIST_BACKUPS
```
public static final int SDB_LIST_BACKUPS
```
    List of backups
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_CL_IN_DOMAIN
```
public static final int SDB_LIST_CL_IN_DOMAIN
```
    See Also:
    
    Constant Field Values
  - SDB_LIST_COLLECTIONS
```
public static final int SDB_LIST_COLLECTIONS
```
    List of collections
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_COLLECTIONSPACES
```
public static final int SDB_LIST_COLLECTIONSPACES
```
    List of collection spaces
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_CONTEXTS
```
public static final int SDB_LIST_CONTEXTS
```
    List of all the contexts of all the sessions
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_CONTEXTS_CURRENT
```
public static final int SDB_LIST_CONTEXTS_CURRENT
```
    List of the contexts of current session
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_CS_IN_DOMAIN
```
public static final int SDB_LIST_CS_IN_DOMAIN
```
    See Also:
    
    Constant Field Values
  - SDB_LIST_DATASOURCES
```
public static final int SDB_LIST_DATASOURCES
```
    List of data source
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_DOMAINS
```
public static final int SDB_LIST_DOMAINS
```
    List of domains
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_GROUPS
```
public static final int SDB_LIST_GROUPS
```
    List of all the groups
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_SEQUENCES
```
public static final int SDB_LIST_SEQUENCES
```
    List of sequences
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_SESSIONS
```
public static final int SDB_LIST_SESSIONS
```
    List of all the sessions
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_SESSIONS_CURRENT
```
public static final int SDB_LIST_SESSIONS_CURRENT
```
    List of current session
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_STORAGEUNITS
```
public static final int SDB_LIST_STORAGEUNITS
```
    List of strorage units
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_STOREPROCEDURES
```
public static final int SDB_LIST_STOREPROCEDURES
```
    List of store procedures
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_SVCTASKS
```
public static final int SDB_LIST_SVCTASKS
```
    List of service tasks
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_TASKS
```
public static final int SDB_LIST_TASKS
```
    List of tasks
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_TRANSACTIONS
```
public static final int SDB_LIST_TRANSACTIONS
```
    List of all the transactions of all the sessions
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_TRANSACTIONS_CURRENT
```
public static final int SDB_LIST_TRANSACTIONS_CURRENT
```
    List of all transactions of current session
    
    See Also:
    
    Constant Field Values
  - SDB_LIST_USERS
```
public static final int SDB_LIST_USERS
```
    List of users
    
    See Also:
    
    Constant Field Values
  - SDB_PAGESIZE_16K
```
public static final int SDB_PAGESIZE_16K
```
    specified the package size of the collections in current collection space to be 16K
    
    See Also:
    
    Constant Field Values
  - SDB_PAGESIZE_32K
```
public static final int SDB_PAGESIZE_32K
```
    specified the package size of the collections in current collection space to be 32K
    
    See Also:
    
    Constant Field Values
  - SDB_PAGESIZE_4K
```
public static final int SDB_PAGESIZE_4K
```
    specified the package size of the collections in current collection space to be 4K
    
    See Also:
    
    Constant Field Values
  - SDB_PAGESIZE_64K
```
public static final int SDB_PAGESIZE_64K
```
    specified the package size of the collections in current collection space to be 64K
    
    See Also:
    
    Constant Field Values
  - SDB_PAGESIZE_8K
```
public static final int SDB_PAGESIZE_8K
```
    specified the package size of the collections in current collection space to be 8K
    
    See Also:
    
    Constant Field Values
  - SDB_PAGESIZE_DEFAULT
```
public static final int SDB_PAGESIZE_DEFAULT
```
    0 means using database's default pagesize, it 64k now
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_ACCESSPLANS
```
public static final int SDB_SNAP_ACCESSPLANS
```
    Snapshot of access plans
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_CATALOG
```
public static final int SDB_SNAP_CATALOG
```
    Snapshot of catalog
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_COLLECTIONS
```
public static final int SDB_SNAP_COLLECTIONS
```
    Snapshot of collections
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_COLLECTIONSPACES
```
public static final int SDB_SNAP_COLLECTIONSPACES
```
    Snapshot of collection spaces
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_CONFIGS
```
public static final int SDB_SNAP_CONFIGS
```
    Snapshot of configs
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_CONTEXTS
```
public static final int SDB_SNAP_CONTEXTS
```
    Snapshot of all the contexts of all the sessions
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_CONTEXTS_CURRENT
```
public static final int SDB_SNAP_CONTEXTS_CURRENT
```
    Snapshot of the contexts of current session
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_DATABASE
```
public static final int SDB_SNAP_DATABASE
```
    Snapshot of database
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_HEALTH
```
public static final int SDB_SNAP_HEALTH
```
    Snapshot of health
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_INDEXSTATS
```
public static final int SDB_SNAP_INDEXSTATS
```
    Snapshot of index statistics
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_LATCHWAITS
```
public static final int SDB_SNAP_LATCHWAITS
```
    Snapshot of latch waits
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_LOCKWAITS
```
public static final int SDB_SNAP_LOCKWAITS
```
    Snapshot of lock waits
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_QUERIES
```
public static final int SDB_SNAP_QUERIES
```
    Snapshot of queries
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_SEQUENCES
```
public static final int SDB_SNAP_SEQUENCES
```
    Snapshot of sequences
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_SESSIONS
```
public static final int SDB_SNAP_SESSIONS
```
    Snapshot of all the sessions
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_SESSIONS_CURRENT
```
public static final int SDB_SNAP_SESSIONS_CURRENT
```
    Snapshot of current session
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_SVCTASKS
```
public static final int SDB_SNAP_SVCTASKS
```
    Snapshot of service tasks
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_SYSTEM
```
public static final int SDB_SNAP_SYSTEM
```
    Snapshot of system
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_TRANSACTIONS
```
public static final int SDB_SNAP_TRANSACTIONS
```
    Snapshot of all the transactions of all the sessions
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_TRANSACTIONS_CURRENT
```
public static final int SDB_SNAP_TRANSACTIONS_CURRENT
```
    Snapshot of all transactions of current session
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_TRANSDEADLOCK
```
public static final int SDB_SNAP_TRANSDEADLOCK
```
    Snapshot of transaction deadlock
    
    See Also:
    
    Constant Field Values
  - SDB_SNAP_TRANSWAITS
```
public static final int SDB_SNAP_TRANSWAITS
```
    Snapshot of transaction waits
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Sequoiadb
```
public Sequoiadb(List<String> connStrings,
                 String username,
                 String password,
                 ConfigOptions options)
          throws BaseException
```
    Use a random valid address to connect to database.
    
    Parameters:
    
    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.
    
    Throws:
    
    BaseException - If error happens.
  - Sequoiadb
```
public Sequoiadb(String host,
                 int port,
                 String username,
                 String password)
          throws BaseException
```
    Parameters:
    
    host - the address of coord
    
    port - the port of coord
    
    username - the user's name of the account
    
    password - the password of the account
    
    Throws:
    
    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
```
    Parameters:
    
    host - the address of coord
    
    port - the port of coord
    
    username - the user's name of the account
    
    password - the password of the account
    
    Throws:
    
    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
```
    Parameters:
    
    connString - remote server address "Host:Port"
    
    username - the user's name of the account
    
    password - the password of the account
    
    Throws:
    
    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
```
    Parameters:
    
    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
    
    Throws:
    
    BaseException - SDB_NETWORK means network error, SDB_INVALIDARG means wrong address or the address don't map to the hosts table.
- Method Detail
  - activateReplicaGroup
```
public void activateReplicaGroup(String rgName)
                          throws BaseException
```
    Active replica group by name.
    
    Parameters:
    
    rgName - replica group name
    
    Throws:
    
    BaseException - If error happens.
  - analyze
```
public void analyze()
             throws BaseException
```
    Analyze all collections and indexes to collect statistics information
    
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    2.9
  - analyze
```
public void analyze(BSONObject options)
             throws BaseException
```
    Analyze collection or index to collect statistics information
    Parameters:
    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, ...
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    2.9
  - backup
```
public void backup(BSONObject options)
            throws BaseException
```
    Backup database.
    Parameters:
    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
    Throws:
    
    BaseException - If error happens.
  - beginTransaction
```
public void beginTransaction()
                      throws BaseException
```
    Begin the transaction.
    
    Throws:
    
    BaseException - If error happens.
  - builder
```
public static Sequoiadb.Builder builder()
```
    Get a builder to create Sequoiadb instance.
    
    Returns:
    
    A builder of Sequoiadb
  - cancelTask
```
public void cancelTask(long taskID,
                       boolean isAsync)
                throws BaseException
```
    Cancel the specified task.
    
    Parameters:
    
    taskID - The task id
    
    isAsync - The operation "cancel task" is async or not, "true" for async, "false" for sync. Default sync.
    
    Throws:
    
    BaseException - If error happens.
  - cleanRequestBuff
```
protected void cleanRequestBuff()
```
  - close
```
public void close()
           throws BaseException
```
    Close the connection.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    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.
    
    Throws:
    
    BaseException - If error happens.
  - commit
```
public void commit()
            throws BaseException
```
    Commit the transaction.
    
    Throws:
    
    BaseException - If error happens.
  - createCollectionSpace
```
public CollectionSpace createCollectionSpace(String csName)
                                      throws BaseException
```
    Create the named collection space with default SDB_PAGESIZE_64K.
    
    Parameters:
    
    csName - The collection space name
    
    Returns:
    
    the newly created collection space object
    
    Throws:
    
    BaseException - If error happens.
  - createCollectionSpace
```
public CollectionSpace createCollectionSpace(String csName,
                                             BSONObject options)
                                      throws BaseException
```
    Create collection space.
    Parameters:
    
    csName - The name of collection space
    options - Contains configuration information for create collection space. The options are as below:
    
    PageSize(int) : Assign how large the page size is for the collection created in this collection space, default to be 64K
    Domain(String) : Assign which domain does current collection space belong to, it will belongs to the system domain if not assign this option
    LobPageSize(int) : The Lob data page size, default value is 262144 and the unit is byte
    DataSource(String) : Assign which data source does current collection space belong to
    Mapping(String) : The name of the collection space mapped by the current collection space
    Returns:
    
    the newly created collection space object
    
    Throws:
    
    BaseException - If error happens.
  - createCollectionSpace
```
public CollectionSpace createCollectionSpace(String csName,
                                             int pageSize)
                                      throws BaseException
```
    Create collection space.
    Parameters:
    
    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
    Returns:
    
    the newly created collection space object
    
    Throws:
    
    BaseException - If error happens.
  - createDataSource
```
public DataSource createDataSource(String dataSourceName,
                                   String addresses,
                                   String user,
                                   String password,
                                   String type,
                                   BSONObject option)
                            throws BaseException
```
    Create data source.
    Parameters:
    
    dataSourceName - The data source name
    
    addresses - The list of coord addresses for the target sequoiadb cluster, spearated by ','
    
    user - User name of the data source
    
    password - User password of the data source
    
    type - Data source type, default is "SequoiaDB"
    option - Optional configuration option for create data source, as follows:
    
    AccessMode(String) : Configure access permissions for the data source, default is "ALL", the values are as follows:
    
    "READ" : Allow read-only operation
    "WRITE" : Allow write-only operation
    "ALL" or "READ|WRITE" : Allow all operations
    "NONE" : Neither read nor write operation is allowed
    
    ErrorFilterMask(String) : Configure error filtering for data operations on data sources, default is "NONE", the values are as follows:
    
    "READ" : Filter data read errors
    "WRITE" : Filter data write errors
    "ALL" or "READ|WRITE" : Filter both data read and write errors
    "NONE" : Do not filter any errors
    
    ErrorControlLevel(String) : Configure the error control level when performing unsupported data operations(such as DDL) on the mapping collection or collection space, default is "low", the values are as follows:
    
    "high" : Report an error and output an error message
    "low" : Ignore unsupported data operations and do not execute on data source
    
    TransPropagateMode(String) : Configure the transaction propagation mode on data source, default is "never", the values are as follows:
    
    "never": Transaction operation is forbidden. Report an error and output and error message.
    "notsupport": Transaction operation is not supported on data source. The operation will be converted to non-transactional and send to data source.
    
    InheritSessionAttr(Bool): Configure whether the session between the coordination node and the data source inherits properties of the local session, default is true. The supported attributes include PreferedInstance, PreferedInstanceMode, PreferedStrict, PreferedPeriod and Timeout.
    Returns:
    
    A data source object
    
    Throws:
    
    BaseException - If error happens.
  - createDomain
```
public Domain createDomain(String domainName,
                           BSONObject options)
                    throws BaseException
```
    Create a domain.
    Parameters:
    
    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" }
    Returns:
    
    the newly created collection space object
    
    Throws:
    
    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.
    
    Parameters:
    
    hostName - The host name
    
    port - The port
    
    dbPath - The database path
    
    options - The configure options
    
    Throws:
    
    BaseException - If error happens.
  - createReplicaGroup
```
public ReplicaGroup createReplicaGroup(String rgName)
                                throws BaseException
```
    Create replica group by name.
    
    Parameters:
    
    rgName - replica group's name
    
    Returns:
    
    A replica group object.
    
    Throws:
    
    BaseException - If error happens.
  - createSequence
```
public DBSequence createSequence(String seqName)
```
    Create a sequence.
    
    Parameters:
    
    seqName - The name of sequence
    
    Returns:
    
    A sequence object of creation
  - createSequence
```
public DBSequence createSequence(String seqName,
                                 BSONObject options)
```
    Create a sequence with the specified options.
    Parameters:
    
    seqName - The name of sequence
    options - The options specified by user, details as bellow:
    
    StartValue(long) : The start value of sequence
    MinValue(long) : The minimum value of sequence
    MaxValue(long) : The maxmun value of sequence
    Increment(int) : The increment value of sequence
    CacheSize(int) : The cache size of sequence
    AcquireSize(int) : The acquire size of sequence
    Cycled(boolean) : The cycled flag of sequence
    Returns:
    
    A sequence object of creation
  - createUser
```
public void createUser(String username,
                       String password)
                throws BaseException
```
    Create an user in current database.
    
    Parameters:
    
    username - The connection user name
    
    password - The connection password
    
    Throws:
    
    BaseException - If error happens.
  - crtJSProcedure
```
public void crtJSProcedure(String code)
                    throws BaseException
```
    Create a storage procedure.
    
    Parameters:
    
    code - The code of storage procedure
    
    Throws:
    
    BaseException - If error happens.
  - deleteConfig
```
public void deleteConfig(BSONObject configs,
                         BSONObject options)
                  throws BaseException
```
    Force the node to delete configs online.
    
    Parameters:
    
    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, ...
    
    Throws:
    
    BaseException - If error happens.
  - dropCollectionSpace
```
public void dropCollectionSpace(String csName)
                         throws BaseException
```
    Remove the named collection space.
    
    Parameters:
    
    csName - The collection space name
    
    Throws:
    
    BaseException - If error happens.
  - dropCollectionSpace
```
public void dropCollectionSpace(String csName,
                                BSONObject options)
                         throws BaseException
```
    Remove the named collection space.
    Parameters:
    
    csName - The collection space name
    options - Contains configuration information for drop collection space. The options are as below:
    
    EnsureEmpty(boolean) : check whether the collection space is empty when drop, false means drop directly, true means only empty can drop, default value is false
    Throws:
    
    BaseException - If error happens.
  - dropDataSource
```
public void dropDataSource(String dataSourceName)
                    throws BaseException
```
    Drop data source.
    
    Parameters:
    
    dataSourceName - The data source name
    
    Throws:
    
    BaseException - If error happens.
  - dropDomain
```
public void dropDomain(String domainName)
                throws BaseException
```
    Drop a domain.
    
    Parameters:
    
    domainName - the name of the domain
    
    Throws:
    
    BaseException - If error happens.
  - dropSequence
```
public void dropSequence(String seqName)
```
    Drop the specified sequence.
    
    Parameters:
    
    seqName - The name of sequence
  - evalJS
```
public Sequoiadb.SptEvalResult evalJS(String code)
                               throws BaseException
```
    Eval javascript code.
    
    Parameters:
    
    code - The javascript code
    
    Returns:
    
    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.
    
    Throws:
    
    BaseException - If error happens.
  - exec
```
public DBCursor exec(String sql)
              throws BaseException
```
    Execute sql in database.
    
    Parameters:
    
    sql - the SQL command
    
    Returns:
    
    the DBCursor of the result
    
    Throws:
    
    BaseException - If error happens.
  - execUpdate
```
public void execUpdate(String sql)
                throws BaseException
```
    Execute sql in database.
    
    Parameters:
    
    sql - the SQL command.
    
    Throws:
    
    BaseException - If error happens.
  - flushConfigure
```
public void flushConfigure(BSONObject options)
                    throws BaseException
```
    Flush the options to configuration file.
    
    Parameters:
    
    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
    
    Throws:
    
    BaseException - If error happens.
  - forceSession
```
public void forceSession(long sessionID)
```
    Stop the specified session's current operation and terminate it.
    
    Parameters:
    
    sessionID - The ID of the session.
  - forceSession
```
public void forceSession(long sessionID,
                         BSONObject option)
```
    Stop the specified session's current operation and terminate it.
    
    Parameters:
    
    sessionID - The ID of the session.
    
    option - The control options, Please reference here for more detail.
  - getByteOrder
```
public ByteOrder getByteOrder()
```
    Returns:
    
    ByteOrder of SequoiaDB server.
    
    Since:
    
    2.9
  - getCollectionNames
```
public ArrayList<String> getCollectionNames()
                                     throws BaseException
```
    Get all the collection names.
    
    Returns:
    
    A list of all collection names
    
    Throws:
    
    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.
    
    Parameters:
    
    csName - The collection space name.
    
    Returns:
    
    the object of the specified collection space, or an exception when the collection space does not exist.
    
    Throws:
    
    BaseException - If error happens.
  - getCollectionSpaceNames
```
public ArrayList<String> getCollectionSpaceNames()
                                          throws BaseException
```
    Get all the collection space names.
    
    Returns:
    
    A list of all collection space names
    
    Throws:
    
    BaseException - If error happens.
  - getConnProxy
```
public com.sequoiadb.net.ConnectionProxy getConnProxy()
```
    Get the connection proxy object, which can be used to update the configuration of the connection object.
    
    Returns:
    
    The connection proxy object
  - getCurrentCacheSize
```
public int getCurrentCacheSize()
```
    Reserve.
  - getDataSource
```
public DataSource getDataSource(String dataSourceName)
                         throws BaseException
```
    Get data source.
    
    Parameters:
    
    dataSourceName - The data source name
    
    Returns:
    
    The data source object
    
    Throws:
    
    BaseException - If error happens.
  - getDomain
```
public Domain getDomain(String domainName)
                 throws BaseException
```
    Get the specified domain.
    
    Parameters:
    
    domainName - the name of the domain
    
    Returns:
    
    the Domain instance
    
    Throws:
    
    BaseException - If the domain not exit, throw BaseException with the error SDB_CAT_DOMAIN_NOT_EXIST.
  - getHost
```
public String getHost()
```
    Returns:
    
    Host name of SequoiaDB server.
  - getIP
```
public String getIP()
```
    Returns:
    
    IP address of SequoiaDB server.
  - getLastUseTime
```
public long getLastUseTime()
```
    Returns:
    
    The last used time of this connection.
    
    Since:
    
    2.9
  - getList
```
public DBCursor getList(int listType,
                        BSONObject query,
                        BSONObject selector,
                        BSONObject orderBy)
                 throws BaseException
```
    Get the information of specified type.
    Parameters:
    listType - The list type as below:
    
    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_TRANSACTIONS
    SDB_LIST_TRANSACTIONS_CURRENT
    SDB_LIST_SVCTASKS
    SDB_LIST_SEQUENCES
    SDB_LIST_USERS
    SDB_LIST_BACKUPS
    SDB_LIST_DATASOURCES
    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.
    
    Returns:
    
    The target information by cursor.
    
    Throws:
    
    BaseException - If error happens.
  - getList
```
public DBCursor getList(int listType,
                        BSONObject query,
                        BSONObject selector,
                        BSONObject orderBy,
                        BSONObject hint,
                        long skipRows,
                        long returnRows)
                 throws BaseException
```
    Get the information of specified type.
    Parameters:
    listType - The list type as below:
    
    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_TRANSACTIONS
    SDB_LIST_TRANSACTIONS_CURRENT
    SDB_LIST_SVCTASKS
    SDB_LIST_SEQUENCES
    SDB_LIST_USERS
    SDB_LIST_BACKUPS
    SDB_LIST_DATASOURCES
    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.
    
    hint - The options provided for specific list type. Reserved.
    
    skipRows - Skip the first skipRows documents.
    
    returnRows - Only return returnRows documents. -1 means return all matched results.
    
    Returns:
    
    The target information by cursor.
    
    Throws:
    
    BaseException - If error happens.
  - getLocalAddress
```
public String getLocalAddress()
```
    Returns:
    
    the socket address of localhost.
  - getNodeName
```
public String getNodeName()
```
    Returns:
    
    the node name of current coord node in format of "ip:port".
  - getPort
```
public int getPort()
```
    Returns:
    
    Service port of SequoiaDB server.
  - getRemoteAddress
```
public String getRemoteAddress()
```
    Returns:
    
    the socket address of remote host.
  - getReplicaGroup
```
public ReplicaGroup getReplicaGroup(int rgId)
                             throws BaseException
```
    Get replica group by id.
    
    Parameters:
    
    rgId - replica group id
    
    Returns:
    
    A replica group object or null for not exit.
    
    Throws:
    
    BaseException - If error happens.
  - getReplicaGroup
```
public ReplicaGroup getReplicaGroup(String rgName)
                             throws BaseException
```
    Get replica group by name.
    
    Parameters:
    
    rgName - replica group's name
    
    Returns:
    
    A replica group object or null for not exit.
    
    Throws:
    
    BaseException - If error happens.
  - getReplicaGroupNames
```
public ArrayList<String> getReplicaGroupNames()
                                       throws BaseException
```
    Get all the replica groups' name.
    
    Returns:
    
    A list of all the replica groups' names.
    
    Throws:
    
    BaseException - If error happens.
  - getReplicaGroupsInfo
```
public ArrayList<String> getReplicaGroupsInfo()
                                       throws BaseException
```
    Get the information of the replica groups.
    
    Returns:
    
    A list of information of the replica groups.
    
    Throws:
    
    BaseException - If error happens.
  - getSequence
```
public DBSequence getSequence(String seqName)
```
    Get the specified sequence.
    
    Parameters:
    
    seqName - The name of sequence
    
    Returns:
    
    The specified sequence object
  - getSessionAttr
```
public BSONObject getSessionAttr()
                          throws BaseException
```
    Get the attributes of the current session from the local cache if possible.
    
    Returns:
    
    the BSONObject of the session attribute.
    
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    2.8.5
  - getSessionAttr
```
public BSONObject getSessionAttr(boolean useCache)
                          throws BaseException
```
    Get the attributes of the current session.
    
    Parameters:
    
    useCache - use the local cache or not.
    
    Returns:
    
    the BSONObject of the session attribute.
    
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    3.2
  - getSnapshot
```
public DBCursor getSnapshot(int snapType,
                            BSONObject matcher,
                            BSONObject selector,
                            BSONObject orderBy)
                     throws BaseException
```
    Get snapshot of the database.
    Parameters:
    snapType - The snapshot type as below:
    
    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
    SDB_SNAP_TRANSACTIONS
    SDB_SNAP_TRANSACTIONS_CURRENT
    SDB_SNAP_ACCESSPLANS
    SDB_SNAP_HEALTH
    SDB_SNAP_CONFIGS
    SDB_SNAP_SVCTASKS
    SDB_SNAP_SEQUENCES
    SDB_SNAP_QUERIES
    SDB_SNAP_LATCHWAITS
    SDB_SNAP_LOCKWAITS
    SDB_SNAP_INDEXSTATS
    SDB_SNAP_TRANSWAITS
    SDB_SNAP_TRANSDEADLOCK
    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
    
    Returns:
    
    the DBCursor instance of the result
    
    Throws:
    
    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.
    Parameters:
    snapType - The snapshot type as below:
    
    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
    SDB_SNAP_TRANSACTIONS
    SDB_SNAP_TRANSACTIONS_CURRENT
    SDB_SNAP_ACCESSPLANS
    SDB_SNAP_HEALTH
    SDB_SNAP_CONFIGS
    SDB_SNAP_SVCTASKS
    SDB_SNAP_SEQUENCES
    SDB_SNAP_QUERIES
    SDB_SNAP_LATCHWAITS
    SDB_SNAP_LOCKWAITS
    SDB_SNAP_INDEXSTATS
    SDB_SNAP_TRANSWAITS
    SDB_SNAP_TRANSDEADLOCK
    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.
    
    Returns:
    
    the DBCursor instance of the result
    
    Throws:
    
    BaseException - If error happens.
  - getStorageUnits
```
public ArrayList<String> getStorageUnits()
                                  throws BaseException
```
    Get all the storage units.
    
    Returns:
    
    A list of all storage units
    
    Throws:
    
    BaseException - If error happens.
  - initClient
```
public static void initClient(ClientOptions options)
```
    Initialize the global configuration of SequoiaDB driver.
    
    Parameters:
    
    options - The global configuration of SequoiaDB driver
  - interrupt
```
public void interrupt()
               throws BaseException
```
    Send an interrupt message to engine.
    
    Throws:
    
    BaseException - If error happens.
  - interruptOperation
```
public void interruptOperation()
                        throws BaseException
```
    Send "INTERRUPT_SELF" message to engine to stop the current operation. When the current operation had finish, nothing happened, Otherwise, the current operation will be stop, and return error.
    
    Throws:
    
    BaseException - If error happens.
  - invalidateCache
```
public void invalidateCache(BSONObject options)
```
    Clear the cache of the nodes (data/coord node).
    Parameters:
    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.
    
    Returns:
    
    return true when the connection has been closed
    
    Since:
    
    2.2
  - isCollectionSpaceExist
```
public boolean isCollectionSpaceExist(String csName)
                               throws BaseException
```
    Verify the existence of collection space.
    
    Parameters:
    
    csName - The collection space name.
    
    Returns:
    
    True if existed or false if not existed.
    
    Throws:
    
    BaseException - If error happens.
  - isDataSourceExist
```
public boolean isDataSourceExist(String dataSourceName)
                          throws BaseException
```
    Whether the data source exists or not.
    
    Parameters:
    
    dataSourceName - The data source name
    
    Throws:
    
    BaseException - If error happens.
  - isDomainExist
```
public boolean isDomainExist(String domainName)
                      throws BaseException
```
    Verify the existence of domain.
    
    Parameters:
    
    domainName - the name of domain
    
    Returns:
    
    True if existed or False if not existed
    
    Throws:
    
    BaseException - If error happens.
  - isRelicaGroupExist
```
public boolean isRelicaGroupExist(String rgName)
```
    This interface will be deprecated, please use isReplicaGroupExist(String).
  - isReplicaGroupExist
```
public boolean isReplicaGroupExist(int rgId)
```
    whether the replica group exists in the database or not
    
    Parameters:
    
    rgId - id of replica group
    
    Returns:
    
    true or false
  - isReplicaGroupExist
```
public boolean isReplicaGroupExist(String rgName)
```
    whether the replica group exists in the database or not
    
    Parameters:
    
    rgName - replica group's name
    
    Returns:
    
    true or false
  - isValid
```
public boolean isValid()
                throws BaseException
```
    Send a test message to database to test whether the connection is valid or not.
    
    Returns:
    
    if the connection is valid, return true
    
    Throws:
    
    BaseException - If error happens.
  - listBackup
```
public DBCursor listBackup(BSONObject options,
                           BSONObject matcher,
                           BSONObject selector,
                           BSONObject orderBy)
                    throws BaseException
```
    List the backups.
    Parameters:
    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
    
    Returns:
    
    the DBCursor of the backup or null while having no backup information.
    
    Throws:
    
    BaseException - If error happens.
  - listCollections
```
public DBCursor listCollections()
                         throws BaseException
```
    Get all the collections.
    
    Returns:
    
    Cursor of all collections
    
    Throws:
    
    BaseException - If error happens.
  - listCollectionSpaces
```
public DBCursor listCollectionSpaces()
                              throws BaseException
```
    Get all the collection spaces.
    
    Returns:
    
    Cursor of all collection space names.
    
    Throws:
    
    BaseException - If error happens.
  - listDataSources
```
public DBCursor listDataSources(BSONObject matcher,
                                BSONObject selector,
                                BSONObject orderBy,
                                BSONObject hint)
                         throws BaseException
```
    List data source.
    
    Parameters:
    
    matcher - The matching rule, return all the records if null
    
    selector - The selective rule, return the whole records if null
    
    orderBy - The ordered rule, never sort if null
    
    hint - Reserved, please specify null
    
    Returns:
    
    Cursor of data source information
    
    Throws:
    
    BaseException - If error happens.
  - listDomains
```
public DBCursor listDomains(BSONObject matcher,
                            BSONObject selector,
                            BSONObject orderBy,
                            BSONObject hint)
                     throws BaseException
```
    List domains.
    
    Parameters:
    
    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.
    
    Throws:
    
    BaseException - If error happens.
  - listProcedures
```
public DBCursor listProcedures(BSONObject condition)
                        throws BaseException
```
    List the storage procedures.
    
    Parameters:
    
    condition - The condition of list eg: {"name":"sum"}. return all if null
    
    Throws:
    
    BaseException - If error happens.
  - listReplicaGroups
```
public DBCursor listReplicaGroups()
                           throws BaseException
```
    List all the replica group.
    
    Returns:
    
    information of all replica groups.
    
    Throws:
    
    BaseException - If error happens.
  - listTasks
```
public DBCursor listTasks(BSONObject matcher,
                          BSONObject selector,
                          BSONObject orderBy,
                          BSONObject hint)
                   throws BaseException
```
    List the tasks.
    
    Parameters:
    
    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.
    
    Throws:
    
    BaseException - If error happens.
  - loadCollectionSpace
```
public void loadCollectionSpace(String csName,
                                BSONObject options)
                         throws BaseException
```
    Parameters:
    
    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
    
    ...
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    2.8
  - msg
```
public void msg(String message)
```
    Send message to server.
    
    Parameters:
    
    message - The message to send to server.
  - releaseResource
```
public void releaseResource()
                     throws BaseException
```
    Release the resource of the connection.
    
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    2.2
  - removeBackup
```
public void removeBackup(BSONObject options)
                  throws BaseException
```
    Remove the backups.
    Parameters:
    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.
    Throws:
    
    BaseException - If error happens.
  - removeReplicaGroup
```
public void removeReplicaGroup(String rgName)
                        throws BaseException
```
    Remove replica group by name.
    
    Parameters:
    
    rgName - replica group's name
    
    Throws:
    
    BaseException - If error happens.
  - removeUser
```
public void removeUser(String username,
                       String password)
                throws BaseException
```
    Remove the specified user from current database.
    
    Parameters:
    
    username - The connection user name
    
    password - The connection password
    
    Throws:
    
    BaseException - If error happens.
  - renameCollectionSpace
```
public void renameCollectionSpace(String oldName,
                                  String newName)
                           throws BaseException
```
    Parameters:
    
    oldName - The old collection space name
    
    newName - The new collection space name
    
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    2.8
  - renameSequence
```
public void renameSequence(String oldName,
                           String newName)
```
    Rename sequence.
    
    Parameters:
    
    oldName - The old name of sequence
    
    newName - The new name of sequence
  - resetSnapshot
```
public void resetSnapshot()
                   throws BaseException
```
    Reset the snapshot.
    
    Throws:
    
    BaseException - If error happens.
  - resetSnapshot
```
public void resetSnapshot(BSONObject options)
                   throws BaseException
```
    Reset the snapshot.
    Parameters:
    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,
    
    ...
    Throws:
    
    BaseException - If error happens.
  - rmProcedure
```
public void rmProcedure(String name)
                 throws BaseException
```
    Remove a store procedure.
    
    Parameters:
    
    name - The name of store procedure to be removed
    
    Throws:
    
    BaseException - If error happens.
  - rollback
```
public void rollback()
              throws BaseException
```
    Rollback the transaction.
    
    Throws:
    
    BaseException - If error happens.
  - setSessionAttr
```
public void setSessionAttr(BSONObject options)
                    throws BaseException
```
    Set the attributes of the current session.
    
    Parameters:
    
    options - The options for setting session attributes. Can not be null. While it's a empty options, the local session attributes cache will be cleanup. Please reference here for more detail.
    
    Throws:
    
    BaseException - If error happens.
  - sync
```
public void sync()
          throws BaseException
```
    Sync the whole database to disk.
    
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    2.8
  - sync
```
public void sync(BSONObject options)
          throws BaseException
```
    Sync the database to disk.
    Parameters:
    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 ...
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    2.8
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - unloadCollectionSpace
```
public void unloadCollectionSpace(String csName,
                                  BSONObject options)
                           throws BaseException
```
    Parameters:
    
    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
    
    ...
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    2.8
  - updateConfig
```
public void updateConfig(BSONObject configs)
                  throws BaseException
```
    Force the node to update configs online.
    
    Parameters:
    
    configs - The specific configuration parameters to update
    
    Throws:
    
    BaseException - If error happens.
  - updateConfig
```
public void updateConfig(BSONObject configs,
                         BSONObject options)
                  throws BaseException
```
    Force the node to update configs online.
    
    Parameters:
    
    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, ...
    
    Throws:
    
    BaseException - If error happens.
  - waitTasks
```
public void waitTasks(long[] taskIDs)
               throws BaseException
```
    Wait the tasks to finish.
    
    Parameters:
    
    taskIDs - The array of task id
    
    Throws:
    
    BaseException - If error happens.

Class Sequoiadb

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CATALOG_GROUP_NAME

FMP_FUNC_TYPE_C

FMP_FUNC_TYPE_INVALID

FMP_FUNC_TYPE_JAVA

FMP_FUNC_TYPE_JS

SDB_LIST_BACKUPS

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_DATASOURCES

SDB_LIST_DOMAINS

SDB_LIST_GROUPS

SDB_LIST_SEQUENCES

SDB_LIST_SESSIONS

SDB_LIST_SESSIONS_CURRENT

SDB_LIST_STORAGEUNITS

SDB_LIST_STOREPROCEDURES

SDB_LIST_SVCTASKS

SDB_LIST_TASKS

SDB_LIST_TRANSACTIONS

SDB_LIST_TRANSACTIONS_CURRENT

SDB_LIST_USERS

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_INDEXSTATS

SDB_SNAP_LATCHWAITS

SDB_SNAP_LOCKWAITS

SDB_SNAP_QUERIES

SDB_SNAP_SEQUENCES

SDB_SNAP_SESSIONS

SDB_SNAP_SESSIONS_CURRENT

SDB_SNAP_SVCTASKS

SDB_SNAP_SYSTEM

SDB_SNAP_TRANSACTIONS

SDB_SNAP_TRANSACTIONS_CURRENT

SDB_SNAP_TRANSDEADLOCK

SDB_SNAP_TRANSWAITS

Constructor Detail

Sequoiadb

Sequoiadb

Sequoiadb

Sequoiadb

Sequoiadb

Method Detail

activateReplicaGroup

analyze

analyze

backup

beginTransaction

builder

cancelTask

cleanRequestBuff

close

closeAllCursors

commit

createCollectionSpace

createCollectionSpace