DBCollection (SequoiaDB Java Driver 3.0 API)

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

public class DBCollection
extends Object

Collection of SequoiaDB.

字段概要

字段
限定符和类型	字段和说明
`static int`	`FLG_INSERT_CONTONDUP` This flags represent that bulkInsert will continue when duplicate key exist(the duplicate record will be ignored).
`static int`	`FLG_UPDATE_KEEP_SHARDINGKEY` The sharding key in update rule is not filtered, when executing update or upsert.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`DBCursor`	`aggregate(List<BSONObject> objs)` Execute aggregate operation in current collection.
`void`	`alterCollection(BSONObject options)` Alter the attributes of current collection.
`void`	`attachCollection(String subClFullName, BSONObject options)` Attach the specified collection.
`void`	`createIdIndex(BSONObject options)` Create the id index.
`void`	`createIndex(String name, BSONObject key, boolean isUnique, boolean enforced)` Create a index with name and key
`void`	`createIndex(String name, BSONObject key, boolean isUnique, boolean enforced, int sortBufferSize)` Create a index with name and key.
`void`	`createIndex(String name, String key, boolean isUnique, boolean enforced)` Create a index with name and key.
`void`	`createIndex(String name, String key, boolean isUnique, boolean enforced, int sortBufferSize)` Create a index with name and key.
`DBLob`	`createLob()` Create a lob.
`DBLob`	`createLob(ObjectId id)` Create a lob with a given id.
`void`	`delete(BSONObject matcher)` Delete the matching BSONObject of current collection.
`void`	`delete(BSONObject matcher, BSONObject hint)` Delete the matching BSONObject of current collection.
`void`	`delete(String matcher)` Delete the matching of current collection.
`void`	`delete(String matcher, String hint)` Delete the matching bson's string of current collection.
`void`	`detachCollection(String subClFullName)` Detach the specified collection.
`void`	`disableCompression()` Alter the attributes of current collection to disable compression
`void`	`disableSharding()` Alter the attributes of current collection to disable sharding
`void`	`dropIdIndex()` Drop the id index.
`void`	`dropIndex(String name)` Remove the named index of current collection.
`void`	`enableCompression(BSONObject options)` Alter the attributes of current collection to enable compression
`void`	`enableSharding(BSONObject options)` Alter the attributes of current collection to enable sharding
`void`	`ensureOID(boolean flag)` Set whether ensure OID of record when bulk insert records to SequoiaDB.
`DBCursor`	`explain(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, long skipRows, long returnRows, int flag, BSONObject options)` Explain query of current collection.
`CollectionSpace`	`getCollectionSpace()` Get the CollectionSpace instance of current collection.
`long`	`getCount()` Get the amount of documents in current collection.
`long`	`getCount(BSONObject matcher)` Get the amount of matching documents in current collection.
`long`	`getCount(BSONObject matcher, BSONObject hint)` Get the count of matching BSONObject in current collection.
`long`	`getCount(String matcher)` Get the amount of matching documents in current collection.
`String`	`getCSName()` Get the full name of specified collection in current collection space.
`String`	`getFullName()` Get the full name of specified collection in current collection space.
`DBCursor`	`getIndexes()` Get all the indexes of current collection
`BSONObject`	`getIndexInfo(String name)` Get the information of specified index in current collection.
`String`	`getName()` Get the name of current collection.
`DBCursor`	`getQueryMeta(BSONObject matcher, BSONObject orderBy, BSONObject hint, long skipRows, long returnRows, int flag)` Get index blocks' or data blocks' information for concurrent query.
`Sequoiadb`	`getSequoiadb()` Get the Sequoiadb instance of current collection.
`Object`	`insert(BSONObject insertor)` Insert a document into current collection, if the document does not contain field "_id", it will be added.
`void`	`insert(List<BSONObject> insertor)` Insert a bulk of bson objects into current collection.
`void`	`insert(List<BSONObject> insertor, int flag)` Insert a bulk of bson objects into current collection.
`Object`	`insert(String insertor)` Insert a document into current collection, if the document does not contain field "_id", it will be added.
`boolean`	`isIndexExist(String name)` Test the specified index exist or not.
`boolean`	`isOIDEnsured()`
`DBCursor`	`listLobs()` Get all of the lobs in current collection.
`DBLob`	`openLob(ObjectId id)` Open an existing lob with id.
`DBLob`	`openLob(ObjectId id, int mode)` Open an existing lob with id.
`void`	`pop(BSONObject options)` Pop records from the collection.
`DBCursor`	`query()` Get all documents of current collection.
`DBCursor`	`query(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint)` Get the matching documents in current collection.
`DBCursor`	`query(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, int flag)` Get the matching documents in current collection.
`DBCursor`	`query(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, long skipRows, long returnRows)` Get the matching documents in current collection.
`DBCursor`	`query(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, long skipRows, long returnRows, int flags)` Get the matching documents in current collection.
`DBCursor`	`query(DBQuery matcher)` Get the matching documents in current collection.
`DBCursor`	`query(String matcher, String selector, String orderBy, String hint)` Get the matching documents in current collection.
`DBCursor`	`query(String matcher, String selector, String orderBy, String hint, int flag)` Get the matching documents in current collection.
`DBCursor`	`query(String matcher, String selector, String orderBy, String hint, long skipRows, long returnRows)` Get the matching documents in current collection.
`DBCursor`	`queryAndRemove(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, long skipRows, long returnRows, int flag)` Get the matching documents in current collection and remove.
`DBCursor`	`queryAndUpdate(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, BSONObject update, long skipRows, long returnRows, int flag, boolean returnNew)` Get the matching documents in current collection and update.
`BSONObject`	`queryOne()` Get one document from current collection.
`BSONObject`	`queryOne(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, int flag)` Get one matched document from current collection.
`void`	`removeLob(ObjectId lobId)` Remove an existing lob.
`<T> void`	`save(List<T> type)` Insert an object into current collection.
`<T> void`	`save(List<T> type, Boolean ignoreNullValue)` Insert an object into current collection.
`<T> void`	`save(List<T> type, Boolean ignoreNullValue, int flag)` Insert an object into current collection.
`<T> void`	`save(T type)` Insert an object into current collection.
`<T> void`	`save(T type, Boolean ignoreNullValue)` Insert an object into current collection when save include update shardingKey field, the shardingKey modify action is not take effect, but the other field update is take effect.
`<T> void`	`save(T type, Boolean ignoreNullValue, int flag)` Insert an object into current collection.
`void`	`setAttributes(BSONObject options)` Alter the attributes of current collection Can't alter attributes about split in partition collection; After altering a collection to be a partition collection, need to split this collection manually.
`void`	`setMainKeys(String[] keys)` Set the main keys used in save(). if no main keys are set, use the default main key "_id".
`void`	`split(String sourceGroupName, String destGroupName, BSONObject splitCondition, BSONObject splitEndCondition)` Split the specified collection from source group to target group by range.
`void`	`split(String sourceGroupName, String destGroupName, double percent)` Split the specified collection from source group to target group by percent.
`long`	`splitAsync(String sourceGroupName, String destGroupName, BSONObject splitCondition, BSONObject splitEndCondition)` Split the specified collection from source group to target group by range asynchronously.
`long`	`splitAsync(String sourceGroupName, String destGroupName, double percent)` Split the specified collection from source group to target group by percent asynchronously.
`void`	`truncate()` Truncate the collection.
`void`	`truncateLob(ObjectId lobId, long length)` Truncate an existing lob.
`void`	`update(BSONObject matcher, BSONObject modifier, BSONObject hint)` Update the BSONObject of current collection.
`void`	`update(BSONObject matcher, BSONObject modifier, BSONObject hint, int flag)` Update the BSONObject of current collection.
`void`	`update(DBQuery query)` Update the document of current collection.
`void`	`update(String matcher, String modifier, String hint)` Update the BSONObject of current collection.
`void`	`update(String matcher, String modifier, String hint, int flag)` Update the BSONObject of current collection.
`void`	`upsert(BSONObject matcher, BSONObject modifier, BSONObject hint)` Update the BSONObject of current collection, insert if no matching.
`void`	`upsert(BSONObject matcher, BSONObject modifier, BSONObject hint, BSONObject setOnInsert)` Update the BSONObject of current collection, insert if no matching.
`void`	`upsert(BSONObject matcher, BSONObject modifier, BSONObject hint, BSONObject setOnInsert, int flag)` Update the BSONObject of current collection, insert if no matching.

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

- 字段详细资料
  - FLG_INSERT_CONTONDUP
```
public static final int FLG_INSERT_CONTONDUP
```
    This flags represent that bulkInsert will continue when duplicate key exist(the duplicate record will be ignored).
    
    另请参阅:
    
    常量字段值
  - FLG_UPDATE_KEEP_SHARDINGKEY
```
public static final int FLG_UPDATE_KEEP_SHARDINGKEY
```
    The sharding key in update rule is not filtered, when executing update or upsert.
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - aggregate
```
public DBCursor aggregate(List<BSONObject> objs)
                   throws BaseException
```
    Execute aggregate operation in current collection.
    
    参数:
    
    objs - The Bson object of rule list, can't be null
    
    抛出:
    
    BaseException - If error happens.
  - alterCollection
```
public void alterCollection(BSONObject options)
                     throws BaseException
```
    Alter the attributes of current collection. Can't alter attributes about split in partition collection; After altering a collection to be a partition collection, need to split this collection manually.
    参数:
    options - The options for altering current collection are as below:
    
    ReplSize : Assign how many replica nodes need to be synchronized when a write request(insert, update, etc) is executed
    ShardingKey : Assign the sharding key
    ShardingType : Assign the sharding type
    Partition : When the ShardingType is "hash", need to assign Partition, it's the bucket number for hash, the range is [2^3,2^20].
    CompressionType : The compression type of data, could be "snappy" or "lzw"
    EnsureShardingIndex : Assign to true to build sharding index
    StrictDataMode : Using strict date mode in numeric operations or not e.g. {RepliSize:0, ShardingKey:{a:1}, ShardingType:"hash", Partition:1024}
    抛出:
    
    BaseException - If error happens.
  - attachCollection
```
public void attachCollection(String subClFullName,
                             BSONObject options)
                      throws BaseException
```
    Attach the specified collection.
    
    参数:
    
    subClFullName - The full name of the sub-collection
    
    options - The low boundary and up boundary eg: {"LowBound":{a:1},"UpBound":{a:100}}
    
    抛出:
    
    BaseException - If error happens.
  - createIdIndex
```
public void createIdIndex(BSONObject options)
                   throws BaseException
```
    Create the id index.
    
    参数:
    
    options - can be empty or specify option. e.g. {SortBufferSize:64}
    
    抛出:
    
    BaseException - If error happens.
  - createIndex
```
public void createIndex(String name,
                        BSONObject key,
                        boolean isUnique,
                        boolean enforced)
                 throws BaseException
```
    Create a index with name and key
    
    参数:
    
    name - The index name
    
    key - The index keys in JSON format, like: "{\"a\":1, \"b\":-1}"
    
    isUnique - Whether the index elements are unique or not
    
    enforced - Whether the index is enforced unique This element is meaningful when isUnique is set to true
    
    抛出:
    
    BaseException - If error happens.
  - createIndex
```
public void createIndex(String name,
                        BSONObject key,
                        boolean isUnique,
                        boolean enforced,
                        int sortBufferSize)
                 throws BaseException
```
    Create a index with name and key.
    
    参数:
    
    name - The index name
    
    key - The index keys in JSON format, like: "{\"a\":1, \"b\":-1}"
    
    isUnique - Whether the index elements are unique or not
    
    enforced - Whether the index is enforced unique This element is meaningful when isUnique is set to true
    
    sortBufferSize - The size(MB) of sort buffer used when creating index, zero means don't use sort buffer
    
    抛出:
    
    BaseException - If error happens.
  - createIndex
```
public void createIndex(String name,
                        String key,
                        boolean isUnique,
                        boolean enforced)
                 throws BaseException
```
    Create a index with name and key.
    
    参数:
    
    name - The index name
    
    key - The index keys in JSON format, like: "{\"a\":1, \"b\":-1}"
    
    isUnique - Whether the index elements are unique or not
    
    enforced - Whether the index is enforced unique This element is meaningful when isUnique is set to true
    
    抛出:
    
    BaseException - If error happens.
  - createIndex
```
public void createIndex(String name,
                        String key,
                        boolean isUnique,
                        boolean enforced,
                        int sortBufferSize)
                 throws BaseException
```
    Create a index with name and key.
    
    参数:
    
    name - The index name
    
    key - The index keys in JSON format, like: "{\"a\":1, \"b\":-1}"
    
    isUnique - Whether the index elements are unique or not
    
    enforced - Whether the index is enforced unique This element is meaningful when isUnique is set to true
    
    sortBufferSize - The size(MB) of sort buffer used when creating index, zero means don't use sort buffer
    
    抛出:
    
    BaseException - If error happens.
  - createLob
```
public DBLob createLob()
                throws BaseException
```
    Create a lob.
    
    返回:
    
    DBLob object
    
    抛出:
    
    BaseException - If error happens..
  - createLob
```
public DBLob createLob(ObjectId id)
                throws BaseException
```
    Create a lob with a given id.
    
    参数:
    
    id - the lob's id. if id is null, it will be generated in this function
    
    返回:
    
    DBLob object
    
    抛出:
    
    BaseException - If error happens..
  - delete
```
public void delete(BSONObject matcher)
            throws BaseException
```
    Delete the matching BSONObject of current collection.
    
    参数:
    
    matcher - The matching condition, delete all the documents if null
    
    抛出:
    
    BaseException - If error happens.
  - delete
```
public void delete(BSONObject matcher,
                   BSONObject hint)
            throws BaseException
```
    Delete the matching BSONObject of current collection.
    
    参数:
    
    matcher - The matching condition, delete all the documents 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.
  - delete
```
public void delete(String matcher)
            throws BaseException
```
    Delete the matching of current collection.
    
    参数:
    
    matcher - The matching condition, delete all the documents if null
    
    抛出:
    
    BaseException - If error happens.
  - delete
```
public void delete(String matcher,
                   String hint)
            throws BaseException
```
    Delete the matching bson's string of current collection.
    
    参数:
    
    matcher - The matching condition, delete all the documents 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.
  - detachCollection
```
public void detachCollection(String subClFullName)
                      throws BaseException
```
    Detach the specified collection.
    
    参数:
    
    subClFullName - The full name of the sub-collection
    
    抛出:
    
    BaseException - If error happens.
  - disableCompression
```
public void disableCompression()
                        throws BaseException
```
    Alter the attributes of current collection to disable compression
    
    抛出:
    
    BaseException - If error happens.
  - disableSharding
```
public void disableSharding()
                     throws BaseException
```
    Alter the attributes of current collection to disable sharding
    
    抛出:
    
    BaseException - If error happens.
  - dropIdIndex
```
public void dropIdIndex()
                 throws BaseException
```
    Drop the id index.
    
    抛出:
    
    BaseException - If error happens.
  - dropIndex
```
public void dropIndex(String name)
               throws BaseException
```
    Remove the named index of current collection.
    
    参数:
    
    name - The index name
    
    抛出:
    
    BaseException - If error happens.
  - enableCompression
```
public void enableCompression(BSONObject options)
                       throws BaseException
```
    Alter the attributes of current collection to enable compression
    参数:
    options - The options for altering current collection are as below:
    
    CompressionType : The compression type of data, could be "snappy" or "lzw"
    抛出:
    
    BaseException - If error happens.
  - enableSharding
```
public void enableSharding(BSONObject options)
                    throws BaseException
```
    Alter the attributes of current collection to enable sharding
    参数:
    options - The options for altering current collection are as below:
    
    ShardingKey : Assign the sharding key
    ShardingType : Assign the sharding type
    Partition : When the ShardingType is "hash", need to assign Partition, it's the bucket number for hash, the range is [2^3,2^20].
    EnsureShardingIndex : Assign to true to build sharding index
    抛出:
    
    BaseException - If error happens.
  - ensureOID
```
public void ensureOID(boolean flag)
```
    Set whether ensure OID of record when bulk insert records to SequoiaDB.
    
    参数:
    
    flag - whether ensure OID of record
  - explain
```
public DBCursor explain(BSONObject matcher,
                        BSONObject selector,
                        BSONObject orderBy,
                        BSONObject hint,
                        long skipRows,
                        long returnRows,
                        int flag,
                        BSONObject options)
                 throws BaseException
```
    Explain query of current collection.
    参数:
    
    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.
    
    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
    flag - the query flag, default to be 0. Please see the definition of follow flags for more detail. Usage: e.g. set ( DBQuery.FLG_QUERY_FORCE_HINT | DBQuery.FLG_QUERY_WITH_RETURNDATA ) to param flag
    
    DBQuery.FLG_QUERY_STRINGOUT
    DBQuery.FLG_QUERY_FORCE_HINT
    DBQuery.FLG_QUERY_PARALLED
    DBQuery.FLG_QUERY_WITH_RETURNDATA
    options - The rules of query explain, the options are as below:
    
    Run : Whether execute query explain or not, true for executing query explain then get the data and time information; false for not executing query explain but get the query explain information only. e.g. {Run:true}
    返回:
    
    a DBCursor instance of the result
    
    抛出:
    
    BaseException - If error happens.
  - getCollectionSpace
```
public CollectionSpace getCollectionSpace()
```
    Get the CollectionSpace instance of current collection.
    
    返回:
    
    CollectionSpace instance
  - getCount
```
public long getCount()
              throws BaseException
```
    Get the amount of documents in current collection.
    
    返回:
    
    the amount of matching documents
    
    抛出:
    
    BaseException - If error happens.
  - getCount
```
public long getCount(BSONObject matcher)
              throws BaseException
```
    Get the amount of matching documents in current collection.
    
    参数:
    
    matcher - The matching rule, when condition is null, the return amount contains all the records.
    
    返回:
    
    the amount of matching documents
    
    抛出:
    
    BaseException - If error happens.
  - getCount
```
public long getCount(BSONObject matcher,
                     BSONObject hint)
              throws BaseException
```
    Get the count of matching BSONObject in current collection.
    
    参数:
    
    matcher - The matching rule, when condition is null, the return amount contains all the records.
    
    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.
    
    返回:
    
    The count of matching BSONObjects
    
    抛出:
    
    BaseException - If error happens.
  - getCount
```
public long getCount(String matcher)
              throws BaseException
```
    Get the amount of matching documents in current collection.
    
    参数:
    
    matcher - the matching rule
    
    返回:
    
    the amount of matching documents
    
    抛出:
    
    BaseException - If error happens.
  - getCSName
```
public String getCSName()
```
    Get the full name of specified collection in current collection space.
    
    返回:
    
    The full name of specified collection.
  - getFullName
```
public String getFullName()
```
    Get the full name of specified collection in current collection space.
    
    返回:
    
    The full name of specified collection
  - getIndexes
```
public DBCursor getIndexes()
                    throws BaseException
```
    Get all the indexes of current collection
    
    返回:
    
    DBCursor of indexes
    
    抛出:
    
    BaseException - If error happens.
  - getIndexInfo
```
public BSONObject getIndexInfo(String name)
                        throws BaseException
```
    Get the information of specified index in current collection.
    
    参数:
    
    name - The index name.
    
    返回:
    
    The information of the specified index.
    
    抛出:
    
    BaseException - If error happens or the specified index does not exist.
  - getName
```
public String getName()
```
    Get the name of current collection.
    
    返回:
    
    The collection name
  - getQueryMeta
```
public DBCursor getQueryMeta(BSONObject matcher,
                             BSONObject orderBy,
                             BSONObject hint,
                             long skipRows,
                             long returnRows,
                             int flag)
                      throws BaseException
```
    Get index blocks' or data blocks' information for concurrent query.
    
    参数:
    
    matcher - the matching rule, return all the meta information 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.
    
    skipRows - The rows to be skipped
    
    returnRows - return the specified amount of documents, when returnRows is 0, return nothing, when returnRows is -1, return all the documents
    
    flag - The flag to use which form for record data 0: bson stream 1: binary data stream, form: col1|col2|col3
    
    返回:
    
    DBCursor of data
    
    抛出:
    
    BaseException - If error happens.
  - getSequoiadb
```
public Sequoiadb getSequoiadb()
```
    Get the Sequoiadb instance of current collection.
    
    返回:
    
    Sequoiadb instance
  - insert
```
public Object insert(BSONObject insertor)
              throws BaseException
```
    Insert a document into current collection, if the document does not contain field "_id", it will be added.
    
    参数:
    
    insertor - The Bson object of insertor, can't be null
    
    返回:
    
    the value of the filed "_id"
    
    抛出:
    
    BaseException - If error happens.
  - insert
```
public void insert(List<BSONObject> insertor)
            throws BaseException
```
    Insert a bulk of bson objects into current collection.
    
    参数:
    
    insertor - The Bson object of insertor list, can't be null. insert will interrupt when Duplicate key exist.
    
    抛出:
    
    BaseException - If error happens.
    
    从以下版本开始:
    
    2.9
  - insert
```
public void insert(List<BSONObject> insertor,
                   int flag)
            throws BaseException
```
    Insert a bulk of bson objects into current collection.
    
    参数:
    
    insertor - The Bson object of insertor list, can't be null
    
    flag - available value is FLG_INSERT_CONTONDUP or 0. if flag = FLG_INSERT_CONTONDUP, bulkInsert will continue when Duplicate key exist.(the duplicate record will be ignored); if flag = 0, bulkInsert will interrupt when Duplicate key exist.
    
    抛出:
    
    BaseException - If error happens.
    
    从以下版本开始:
    
    2.9
  - insert
```
public Object insert(String insertor)
              throws BaseException
```
    Insert a document into current collection, if the document does not contain field "_id", it will be added.
    
    参数:
    
    insertor - The string of insertor
    
    返回:
    
    the value of the filed "_id"
    
    抛出:
    
    BaseException - If error happens.
  - isIndexExist
```
public boolean isIndexExist(String name)
```
    Test the specified index exist or not.
    
    参数:
    
    name - The index name.
    
    返回:
    
    True for exist while false for not exist..
  - isOIDEnsured
```
public boolean isOIDEnsured()
```
    返回:
    
    True if ensure OID of record when bulk insert records to SequoiaDB and false if not.
  - listLobs
```
public DBCursor listLobs()
                  throws BaseException
```
    Get all of the lobs in current collection.
    
    返回:
    
    DBCursor of lobs
    
    抛出:
    
    BaseException - If error happens.
  - openLob
```
public DBLob openLob(ObjectId id)
              throws BaseException
```
    Open an existing lob with id.
    
    参数:
    
    id - the lob's id.
    
    返回:
    
    DBLob object
    
    抛出:
    
    BaseException - If error happens.
  - openLob
```
public DBLob openLob(ObjectId id,
                     int mode)
              throws BaseException
```
    Open an existing lob with id.
    
    参数:
    
    id - the lob's id.
    
    mode - open mode: DBLob.SDB_LOB_READ for reading, DBLob.SDB_LOB_WRITE for writing.
    
    返回:
    
    DBLob object
    
    抛出:
    
    BaseException - If error happens..
  - pop
```
public void pop(BSONObject options)
         throws BaseException
```
    Pop records from the collection.
    
    参数:
    
    options - the pop option for the operation, including a record LogicalID, and an optional Direction: 1 for forward pop and -1 for backward pop
    
    抛出:
    
    BaseException - If error happens.
  - query
```
public DBCursor query()
               throws BaseException
```
    Get all documents of current collection.
    
    返回:
    
    a DBCursor instance of the result
    
    抛出:
    
    BaseException - If error happens.
  - query
```
public DBCursor query(BSONObject matcher,
                      BSONObject selector,
                      BSONObject orderBy,
                      BSONObject hint)
               throws BaseException
```
    Get the matching documents in current collection.
    
    参数:
    
    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.
    
    返回:
    
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException - If error happens.
  - query
```
public DBCursor query(BSONObject matcher,
                      BSONObject selector,
                      BSONObject orderBy,
                      BSONObject hint,
                      int flag)
               throws BaseException
```
    Get the matching documents in current collection.
    参数:
    
    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.
    flag - the query flag, default to be 0. Please see the definition of follow flags for more detail. Usage: e.g. set ( DBQuery.FLG_QUERY_FORCE_HINT | DBQuery.FLG_QUERY_WITH_RETURNDATA ) to param flag
    
    DBQuery.FLG_QUERY_STRINGOUT
    DBQuery.FLG_QUERY_FORCE_HINT
    DBQuery.FLG_QUERY_PARALLED
    DBQuery.FLG_QUERY_WITH_RETURNDATA
    DBQuery.FLG_QUERY_FOR_UPDATE
    返回:
    
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException - If error happens.
  - query
```
public DBCursor query(BSONObject matcher,
                      BSONObject selector,
                      BSONObject orderBy,
                      BSONObject hint,
                      long skipRows,
                      long returnRows)
               throws BaseException
```
    Get the matching documents in current collection.
    
    参数:
    
    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.
    
    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
    
    返回:
    
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException - If error happens.
  - query
```
public DBCursor query(BSONObject matcher,
                      BSONObject selector,
                      BSONObject orderBy,
                      BSONObject hint,
                      long skipRows,
                      long returnRows,
                      int flags)
               throws BaseException
```
    Get the matching documents in current collection.
    参数:
    
    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.
    
    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
    flags - the query flags, default to be 0. Please see the definition of follow flags for more detail. Usage: e.g. set ( DBQuery.FLG_QUERY_FORCE_HINT | DBQuery.FLG_QUERY_WITH_RETURNDATA ) to param flag
    
    DBQuery.FLG_QUERY_STRINGOUT
    DBQuery.FLG_QUERY_FORCE_HINT
    DBQuery.FLG_QUERY_PARALLED
    DBQuery.FLG_QUERY_WITH_RETURNDATA
    DBQuery.FLG_QUERY_FOR_UPDATE
    返回:
    
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException - If error happens.
  - query
```
public DBCursor query(DBQuery matcher)
               throws BaseException
```
    Get the matching documents in current collection.
    
    参数:
    
    matcher - the matching rule, return all the documents if null
    
    返回:
    
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException - If error happens.
    
    另请参阅:
    
    DBQuery
  - query
```
public DBCursor query(String matcher,
                      String selector,
                      String orderBy,
                      String hint)
               throws BaseException
```
    Get the matching documents in current collection.
    
    参数:
    
    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.
    
    返回:
    
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException - If error happens.
  - query
```
public DBCursor query(String matcher,
                      String selector,
                      String orderBy,
                      String hint,
                      int flag)
               throws BaseException
```
    Get the matching documents in current collection.
    参数:
    
    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.
    flag - the query flag, default to be 0. Please see the definition of follow flags for more detail. Usage: e.g. set ( DBQuery.FLG_QUERY_FORCE_HINT | DBQuery.FLG_QUERY_WITH_RETURNDATA ) to param flag
    
    DBQuery.FLG_QUERY_STRINGOUT
    DBQuery.FLG_QUERY_FORCE_HINT
    DBQuery.FLG_QUERY_PARALLED
    DBQuery.FLG_QUERY_WITH_RETURNDATA
    DBQuery.FLG_QUERY_FOR_UPDATE
    返回:
    
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException - If error happens.
  - query
```
public DBCursor query(String matcher,
                      String selector,
                      String orderBy,
                      String hint,
                      long skipRows,
                      long returnRows)
               throws BaseException
```
    Get the matching documents in current collection.
    
    参数:
    
    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.
    
    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
    
    返回:
    
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException - If error happens.
  - queryAndRemove
```
public DBCursor queryAndRemove(BSONObject matcher,
                               BSONObject selector,
                               BSONObject orderBy,
                               BSONObject hint,
                               long skipRows,
                               long returnRows,
                               int flag)
                        throws BaseException
```
    Get the matching documents in current collection and remove. In order to make the remove take effect, user must travel the DBCursor returned by this function.
    参数:
    
    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.
    
    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
    flag - the query flag, default to be 0. Please see the definition of follow flags for more detail. Usage: e.g. set ( DBQuery.FLG_QUERY_FORCE_HINT | DBQuery.FLG_QUERY_WITH_RETURNDATA ) to param flag
    
    DBQuery.FLG_QUERY_STRINGOUT
    DBQuery.FLG_QUERY_FORCE_HINT
    DBQuery.FLG_QUERY_PARALLED
    DBQuery.FLG_QUERY_WITH_RETURNDATA
    DBQuery.FLG_QUERY_FOR_UPDATE
    返回:
    
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException - If error happens.
  - queryAndUpdate
```
public DBCursor queryAndUpdate(BSONObject matcher,
                               BSONObject selector,
                               BSONObject orderBy,
                               BSONObject hint,
                               BSONObject update,
                               long skipRows,
                               long returnRows,
                               int flag,
                               boolean returnNew)
                        throws BaseException
```
    Get the matching documents in current collection and update. In order to make the update take effect, user must travel the DBCursor returned by this function.
    参数:
    
    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
    
    update - the update rule, can't be 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.
    
    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
    flag - the query flags, default to be 0. Please see the definition of follow flags for more detail. Usage: e.g. set ( DBQuery.FLG_QUERY_FORCE_HINT | DBQuery.FLG_QUERY_WITH_RETURNDATA ) to param flag
    
    DBQuery.FLG_QUERY_STRINGOUT
    DBQuery.FLG_QUERY_FORCE_HINT
    DBQuery.FLG_QUERY_PARALLED
    DBQuery.FLG_QUERY_WITH_RETURNDATA
    DBQuery.FLG_QUERY_KEEP_SHARDINGKEY_IN_UPDATE
    DBQuery.FLG_QUERY_FOR_UPDATE
    returnNew - When true, returns the updated document rather than the original
    
    返回:
    
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException - If error happens.
  - queryOne
```
public BSONObject queryOne()
                    throws BaseException
```
    Get one document from current collection.
    
    返回:
    
    the document or null if no any document in current collection
    
    抛出:
    
    BaseException - If error happens.
  - queryOne
```
public BSONObject queryOne(BSONObject matcher,
                           BSONObject selector,
                           BSONObject orderBy,
                           BSONObject hint,
                           int flag)
                    throws BaseException
```
    Get one matched document from current collection.
    参数:
    
    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.
    flag - the query flag, default to be 0. Please see the definition of follow flags for more detail. Usage: e.g. set ( DBQuery.FLG_QUERY_FORCE_HINT | DBQuery.FLG_QUERY_WITH_RETURNDATA ) to param flag
    
    DBQuery.FLG_QUERY_STRINGOUT
    DBQuery.FLG_QUERY_FORCE_HINT
    DBQuery.FLG_QUERY_PARALLED
    DBQuery.FLG_QUERY_WITH_RETURNDATA
    DBQuery.FLG_QUERY_FOR_UPDATE
    返回:
    
    the matched document or null if no such document
    
    抛出:
    
    BaseException - If error happens.
  - removeLob
```
public void removeLob(ObjectId lobId)
               throws BaseException
```
    Remove an existing lob.
    
    参数:
    
    lobId - the lob's id.
    
    抛出:
    
    BaseException - If error happens..
  - save
```
public <T> void save(List<T> type)
              throws BaseException
```
    Insert an object into current collection. when save include update shardingKey field, the shardingKey modify action is not take effect, but the other field update is take effect.
    
    参数:
    
    type - The List instance of insertor, can't be null or empty
    
    抛出:
    
    BaseException - 1.while the input argument is null or the List instance is empty 2.while the type is not support, throw BaseException with the type "SDB_INVALIDARG" 3.while offer main keys by setMainKeys(), and try to update "_id" field, it may get a BaseException with the type of "SDB_IXM_DUP_KEY" when the "_id" field you want to update to had been existing in database
    
    另请参阅:
    
    setMainKeys(String[])
  - save
```
public <T> void save(List<T> type,
                     Boolean ignoreNullValue)
              throws BaseException
```
    Insert an object into current collection. when save include update shardingKey field, the shardingKey modify action is not take effect, but the other field update is take effect.
    
    参数:
    
    type - The List instance of insertor, can't be null or empty
    
    ignoreNullValue - true:if type's inner value is null, it will not save to collection; false:if type's inner value is null, it will save to collection too.
    
    抛出:
    
    BaseException - 1.while the input argument is null or the List instance is empty 2.while the type is not support, throw BaseException with the type "SDB_INVALIDARG" 3.while offer main keys by setMainKeys(), and try to update "_id" field, it may get a BaseException with the type of "SDB_IXM_DUP_KEY" when the "_id" field you want to update to had been existing in database
    
    另请参阅:
    
    setMainKeys(String[])
  - save
```
public <T> void save(List<T> type,
                     Boolean ignoreNullValue,
                     int flag)
              throws BaseException
```
    Insert an object into current collection. When flag is set to 0, it won't work to update the ShardingKey field, but the other fields take effect.
    参数:
    
    type - The List instance of insertor, can't be null or empty
    
    ignoreNullValue - true:if type's inner value is null, it will not save to collection;
    flag - the update flag, default to be 0. Please see the definition of follow flags for more detail.
    
    DBCollection.FLG_UPDATE_KEEP_SHARDINGKEY
    抛出:
    
    BaseException - 1.while the input argument is null or the List instance is empty 2.while the type is not support, throw BaseException with the type "SDB_INVALIDARG" 3.while offer main keys by setMainKeys(), and try to update "_id" field, it may get a BaseException with the type of "SDB_IXM_DUP_KEY" when the "_id" field you want to update to had been existing in database
    
    另请参阅:
    
    setMainKeys(String[])
  - save
```
public <T> void save(T type)
              throws BaseException
```
    Insert an object into current collection. when save include update shardingKey field, the shardingKey modify action is not take effect, but the other field update is take effect.
    
    参数:
    
    type - The object of insertor, can't be null
    
    抛出:
    
    BaseException - 1.when the type is not support, throw BaseException with the type "SDB_INVALIDARG" 2.when offer main keys by setMainKeys(), and try to update "_id" field, it may get a BaseException with the type of "SDB_IXM_DUP_KEY"
    
    另请参阅:
    
    setMainKeys(String[])
  - save
```
public <T> void save(T type,
                     Boolean ignoreNullValue)
              throws BaseException
```
    Insert an object into current collection when save include update shardingKey field, the shardingKey modify action is not take effect, but the other field update is take effect.
    
    参数:
    
    type - The object of insertor, can't be null
    
    ignoreNullValue - true:if type's inner value is null, it will not save to collection; false:if type's inner value is null, it will save to collection too.
    
    抛出:
    
    BaseException - 1.when the type is not support, throw BaseException with the type "SDB_INVALIDARG" 2.when offer main keys by setMainKeys(), and try to update "_id" field, it may get a BaseException with the type of "SDB_IXM_DUP_KEY"
    
    另请参阅:
    
    setMainKeys(String[])
  - save
```
public <T> void save(T type,
                     Boolean ignoreNullValue,
                     int flag)
              throws BaseException
```
    Insert an object into current collection. When flag is set to 0, it won't work to update the ShardingKey field, but the other fields take effect.
    参数:
    
    type - The object of insertor, can't be null
    
    ignoreNullValue - true:if type's inner value is null, it will not save to collection;
    flag - the update flag, default to be 0. Please see the definition of follow flags for more detail.
    
    DBCollection.FLG_UPDATE_KEEP_SHARDINGKEY
    抛出:
    
    BaseException - 1.when the type is not support, throw BaseException with the type "SDB_INVALIDARG" 2.when offer main keys by setMainKeys(), and try to update "_id" field, it may get a BaseException with the type of "SDB_IXM_DUP_KEY"
    
    另请参阅:
    
    setMainKeys(String[])
  - setAttributes
```
public void setAttributes(BSONObject options)
                   throws BaseException
```
    Alter the attributes of current collection Can't alter attributes about split in partition collection; After altering a collection to be a partition collection, need to split this collection manually.
    参数:
    options - The options for altering current collection are as below:
    
    ReplSize : Assign how many replica nodes need to be synchronized when a write request(insert, update, etc) is executed
    ShardingKey : Assign the sharding key
    ShardingType : Assign the sharding type
    Partition : When the ShardingType is "hash", need to assign Partition, it's the bucket number for hash, the range is [2^3,2^20].
    CompressionType : The compression type of data, could be "snappy" or "lzw"
    EnsureShardingIndex : Assign to true to build sharding index
    StrictDataMode : Using strict date mode in numeric operations or not e.g. {RepliSize:0, ShardingKey:{a:1}, ShardingType:"hash", Partition:1024}
    抛出:
    
    BaseException - If error happens.
  - setMainKeys
```
public void setMainKeys(String[] keys)
                 throws BaseException
```
    Set the main keys used in save(). if no main keys are set, use the default main key "_id". Every time invokes this method, it will remove the main keys set in the last time.
    
    参数:
    
    keys - the main keys specified by user. the main key should exist in the object
    
    抛出:
    
    BaseException - when keys is null
  - split
```
public void split(String sourceGroupName,
                  String destGroupName,
                  BSONObject splitCondition,
                  BSONObject splitEndCondition)
           throws BaseException
```
    Split the specified collection from source group to target group by range.
    
    参数:
    
    sourceGroupName - the source group name
    
    destGroupName - the destination group name
    
    splitCondition - the split condition
    
    splitEndCondition - the split end condition or null, only usable when "ShardingType" is "range". eg:If we create a collection with the option {ShardingKey:{"age":1},ShardingType:"range"}, we can fill {age:30} as the splitCondition, and fill {age:60} as the splitEndCondition. when split, the target group will get the records whose age's hash value are in [30,60). If splitEndCondition is null, they are in [30,max).
    
    抛出:
    
    BaseException - If error happens.
  - split
```
public void split(String sourceGroupName,
                  String destGroupName,
                  double percent)
           throws BaseException
```
    Split the specified collection from source group to target group by percent.
    
    参数:
    
    sourceGroupName - the source group name
    
    destGroupName - the destination group name
    
    percent - the split percent, Range:(0,100]
    
    抛出:
    
    BaseException - If error happens.
  - splitAsync
```
public long splitAsync(String sourceGroupName,
                       String destGroupName,
                       BSONObject splitCondition,
                       BSONObject splitEndCondition)
                throws BaseException
```
    Split the specified collection from source group to target group by range asynchronously.
    
    参数:
    
    sourceGroupName - the source group name
    
    destGroupName - the destination group name
    
    splitCondition - the split condition
    
    splitEndCondition - the split end condition or null, only usable when "ShardingType" is "range". eg:If we create a collection with the option {ShardingKey:{"age":1},ShardingType:"range"}, we can fill {age:30} as the splitCondition, and fill {age:60} as the splitEndCondition. when split, the target group will get the records whose age's hash values are in [30,60). If splitEndCondition is null, they are in [30,max).
    
    返回:
    
    return the task id, we can use the return id to manage the sharding which is run background.
    
    抛出:
    
    BaseException - If error happens.
    
    另请参阅:
    
    Sequoiadb.listTasks(BSONObject, BSONObject, BSONObject, BSONObject), Sequoiadb.cancelTask(long, boolean)
  - splitAsync
```
public long splitAsync(String sourceGroupName,
                       String destGroupName,
                       double percent)
                throws BaseException
```
    Split the specified collection from source group to target group by percent asynchronously.
    
    参数:
    
    sourceGroupName - the source group name
    
    destGroupName - the destination group name
    
    percent - the split percent, Range:(0,100]
    
    返回:
    
    return the task id, we can use the return id to manage the sharding which is run background.
    
    抛出:
    
    BaseException - If error happens.
  - truncate
```
public void truncate()
              throws BaseException
```
    Truncate the collection.
    
    抛出:
    
    BaseException - If error happens.
  - truncateLob
```
public void truncateLob(ObjectId lobId,
                        long length)
                 throws BaseException
```
    Truncate an existing lob.
    
    参数:
    
    lobId - the lob's id.
    
    length - the truncate length
    
    抛出:
    
    BaseException - If error happens.
  - update
```
public void update(BSONObject matcher,
                   BSONObject modifier,
                   BSONObject hint)
            throws BaseException
```
    Update the BSONObject of current collection. It won't work to update the ShardingKey field, but the other fields take effect.
    
    参数:
    
    matcher - The matching condition, update all the documents if null
    
    modifier - The updating rule, can't be 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.
  - update
```
public void update(BSONObject matcher,
                   BSONObject modifier,
                   BSONObject hint,
                   int flag)
            throws BaseException
```
    Update the BSONObject of current collection. When flag is set to 0, it won't work to update the ShardingKey field, but the other fields take effect.
    参数:
    
    matcher - The matching condition, update all the documents if null
    
    modifier - The updating rule, can't be 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.
    flag - the update flag, default to be 0. Please see the definition of follow flags for more detail.
    
    DBCollection.FLG_UPDATE_KEEP_SHARDINGKEY
    抛出:
    
    BaseException - If error happens.
  - update
```
public void update(DBQuery query)
            throws BaseException
```
    Update the document of current collection. It won't work to update the ShardingKey field, but the other fields take effect.
    
    参数:
    
    query - DBQuery with matching condition, updating rule and hint
    
    抛出:
    
    BaseException - If error happens.
  - update
```
public void update(String matcher,
                   String modifier,
                   String hint)
            throws BaseException
```
    Update the BSONObject of current collection. It won't work to update the ShardingKey field, but the other fields take effect.
    
    参数:
    
    matcher - The matching condition, update all the documents if null
    
    modifier - The updating rule, can't be null or empty
    
    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.
  - update
```
public void update(String matcher,
                   String modifier,
                   String hint,
                   int flag)
            throws BaseException
```
    Update the BSONObject of current collection. When flag is set to 0, it won't work to update the ShardingKey field, but the other fields take effect.
    参数:
    
    matcher - The matching condition, update all the documents if null
    
    modifier - The updating rule, can't be null or empty
    
    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.
    flag - the update flag, default to be 0. Please see the definition of follow flags for more detail.
    
    DBCollection.FLG_UPDATE_KEEP_SHARDINGKEY
    抛出:
    
    BaseException - If error happens.
  - upsert
```
public void upsert(BSONObject matcher,
                   BSONObject modifier,
                   BSONObject hint)
            throws BaseException
```
    Update the BSONObject of current collection, insert if no matching. It won't work to update the ShardingKey field, but the other fields take effect.
    
    参数:
    
    matcher - The matching condition, update all the documents if null(that's to say, we match all the documents)
    
    modifier - The updating rule, can't be 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.
  - upsert
```
public void upsert(BSONObject matcher,
                   BSONObject modifier,
                   BSONObject hint,
                   BSONObject setOnInsert)
            throws BaseException
```
    Update the BSONObject of current collection, insert if no matching. It won't work to update the ShardingKey field, but the other fields take effect.
    
    参数:
    
    matcher - The matching condition, update all the documents if null(that's to say, we match all the documents)
    
    modifier - The updating rule, can't be 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.
    
    setOnInsert - When "setOnInsert" is not a null or an empty object, it assigns the specified values to the fields when insert.
    
    抛出:
    
    BaseException - If error happens.
  - upsert
```
public void upsert(BSONObject matcher,
                   BSONObject modifier,
                   BSONObject hint,
                   BSONObject setOnInsert,
                   int flag)
            throws BaseException
```
    Update the BSONObject of current collection, insert if no matching. When flag is set to 0, it won't work to update the ShardingKey field, but the other fields take effect.
    参数:
    
    matcher - The matching condition, update all the documents if null(that's to say, we match all the documents)
    
    modifier - The updating rule, can't be 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.
    
    setOnInsert - When "setOnInsert" is not a null or an empty object, it assigns the specified values to the fields when insert.
    flag - the upsert flag, default to be 0. Please see the definition of follow flags for more detail.
    
    DBCollection.FLG_UPDATE_KEEP_SHARDINGKEY
    抛出:
    
    BaseException - If error happens.

类 DBCollection

字段概要

方法概要

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

字段详细资料

FLG_INSERT_CONTONDUP

FLG_UPDATE_KEEP_SHARDINGKEY

方法详细资料

aggregate

alterCollection

attachCollection

createIdIndex

createIndex

createIndex

createIndex

createIndex

createLob

createLob

delete

delete

delete

delete

detachCollection

disableCompression

disableSharding

dropIdIndex

dropIndex

enableCompression

enableSharding

ensureOID

explain

getCollectionSpace

getCount

getCount

getCount

getCount

getCSName

getFullName

getIndexes

getIndexInfo

getName

getQueryMeta

getSequoiadb

insert

insert

insert

insert

isIndexExist

isOIDEnsured

listLobs

openLob

openLob

pop

query

query

query

query

query

query

query

query

query

queryAndRemove

queryAndUpdate

queryOne

queryOne

removeLob

save

save

save

save

save

save

setAttributes

setMainKeys

split

split

splitAsync

splitAsync

truncate