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

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

public class DBCollection
extends Object

字段概要

字段
限定符和类型字段和说明

static int FLG_INSERT_CONTONDUP

字段
限定符和类型	字段和说明
`static int`	`FLG_INSERT_CONTONDUP`

方法概要

方法
限定符和类型	方法和说明
`DBCursor`	`aggregate(List<BSONObject> obj)`
`void`	`alterCollection(BSONObject options)`
`void`	`attachCollection(String subClFullName, BSONObject options)`
`void`	`bulkInsert(List<BSONObject> insertor, int flag)`
`void`	`createIndex(String name, BSONObject key, boolean isUnique, boolean enforced)`
`void`	`createIndex(String name, String key, boolean isUnique, boolean enforced)`
`DBLob`	`createLob()`
`DBLob`	`createLob(ObjectId id)`
`void`	`delete(BSONObject matcher)`
`void`	`delete(BSONObject matcher, BSONObject hint)`
`void`	`delete(String matcher)`
`void`	`delete(String matcher, String hint)`
`void`	`detachCollection(String subClFullName)`
`void`	`dropIndex(String name)`
`DBCursor`	`explain(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, long skipRows, long returnRows, int flag, BSONObject options)`
`CollectionSpace`	`getCollectionSpace()`
`IConnection`	`getConnection()`
`long`	`getCount()`
`long`	`getCount(BSONObject matcher)`
`long`	`getCount(BSONObject condition, BSONObject hint)`
`long`	`getCount(String matcher)`
`String`	`getCSName()`
`String`	`getFullName()`
`DBCursor`	`getIndex(String name)`
`DBCursor`	`getIndexes()`
`String`	`getName()`
`DBCursor`	`getQueryMeta(BSONObject query, BSONObject orderBy, BSONObject hint, long skipRows, long returnRows, int flag)`
`Sequoiadb`	`getSequoiadb()`
`Object`	`insert(BSONObject insertor)`
`Object`	`insert(String insertor)`
`DBCursor`	`listLobs()`
`DBLob`	`openLob(ObjectId id)`
`DBCursor`	`query()`
`DBCursor`	`query(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint)`
`DBCursor`	`query(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, int flag)`
`DBCursor`	`query(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, long skipRows, long returnRows)`
`DBCursor`	`query(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, long skipRows, long returnRows, int flag)`
`DBCursor`	`query(DBQuery matcher)`
`DBCursor`	`query(String matcher, String selector, String orderBy, String hint)`
`DBCursor`	`query(String matcher, String selector, String orderBy, String hint, int flag)`
`DBCursor`	`query(String matcher, String selector, String orderBy, String hint, long skipRows, long returnRows)`
`BSONObject`	`queryOne()`
`BSONObject`	`queryOne(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, int flag)`
`void`	`removeLob(ObjectId lobID)`
`<T> void`	`save(List<T> type)`
`<T> void`	`save(T type)`
`void`	`setConnection(IConnection connection)`
`void`	`setMainKeys(String[] keys)`
`void`	`split(String sourceGroupName, String destGroupName, BSONObject splitCondition, BSONObject splitEndCondition)`
`void`	`split(String sourceGroupName, String destGroupName, double percent)`
`long`	`splitAsync(String sourceGroupName, String destGroupName, BSONObject splitCondition, BSONObject splitEndCondition)`
`long`	`splitAsync(String sourceGroupName, String destGroupName, double percent)`
`void`	`update(BSONObject matcher, BSONObject modifier, BSONObject hint)`
`void`	`update(DBQuery query)`
`void`	`update(String matcher, String modifier, String hint)`
`void`	`upsert(BSONObject matcher, BSONObject modifier, BSONObject hint)`

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

- 字段详细资料
  - FLG_INSERT_CONTONDUP
```
public static final int FLG_INSERT_CONTONDUP
```
    另请参阅:
    常量字段值
- 方法详细资料
  - getConnection
```
public IConnection getConnection()
```
  - setConnection
```
public void setConnection(IConnection connection)
```
  - getName
```
public String getName()
```
    返回:
    The collection name
  - getFullName
```
public String getFullName()
```
    返回:
    The full name of specified collection
  - getCSName
```
public String getCSName()
```
    返回:
    The full name of specified collection
  - getSequoiadb
```
public Sequoiadb getSequoiadb()
```
    返回:
    Sequoiadb object
  - getCollectionSpace
```
public CollectionSpace getCollectionSpace()
```
    返回:
    CollectionSpace object
  - setMainKeys
```
public void setMainKeys(String[] keys)
                 throws BaseException
```
    参数:
    keys - the main keys specified by user.
    
    抛出:
    
    com.sequoiadb.Exception.BaseException - when keys is null
    
    BaseException
  - insert
```
public Object insert(BSONObject insertor)
              throws BaseException
```
    参数:
    insertor - The Bson object of insertor, can't be null
    
    返回:
    Object the value of the filed "_id"
    
    抛出:
    
    BaseException
  - insert
```
public Object insert(String insertor)
              throws BaseException
```
    参数:
    insertor - The string of insertor
    
    返回:
    Object the value of the filed "_id"
    
    抛出:
    
    BaseException
  - save
```
public <T> void save(T type)
          throws BaseException
```
    参数:
    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"
    另请参阅:
    com.sequoiadb.base.DBCollection.setMainKeys
  - save
```
public <T> void save(List<T> type)
          throws BaseException
```
    参数:
    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
    另请参阅:
    com.sequoiadb.base.DBCollection.setMainKeys
  - bulkInsert
```
public void bulkInsert(List<BSONObject> insertor,
              int flag)
                throws BaseException
```
    参数:
    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
  - delete
```
public void delete(BSONObject matcher)
            throws BaseException
```
    参数:
    matcher - The matching condition
    
    抛出:
    
    BaseException
  - delete
```
public void delete(String matcher)
            throws BaseException
```
    参数:
    matcher - The matching condition
    
    抛出:
    
    BaseException
  - delete
```
public void delete(String matcher,
          String hint)
            throws BaseException
```
    参数:
    matcher - The matching condition
    hint - Hint
    
    抛出:
    
    BaseException
  - delete
```
public void delete(BSONObject matcher,
          BSONObject hint)
            throws BaseException
```
    参数:
    matcher - The matching condition
    hint - Hint
    
    抛出:
    
    BaseException
  - update
```
public void update(DBQuery query)
            throws BaseException
```
    参数:
    query - DBQuery with matching condition, updating rule and hint
    
    抛出:
    
    BaseException
  - update
```
public void update(BSONObject matcher,
          BSONObject modifier,
          BSONObject hint)
            throws BaseException
```
    参数:
    matcher - The matching condition
    modifier - The updating rule
    hint - Hint
    
    抛出:
    
    BaseException
  - update
```
public void update(String matcher,
          String modifier,
          String hint)
            throws BaseException
```
    参数:
    matcher - The matching condition
    modifier - The updating rule
    hint - Hint
    
    抛出:
    
    BaseException
  - upsert
```
public void upsert(BSONObject matcher,
          BSONObject modifier,
          BSONObject hint)
            throws BaseException
```
    参数:
    matcher - The matching condition
    modifier - The updating rule
    hint - Hint
    
    抛出:
    
    BaseException
  - explain
```
public DBCursor explain(BSONObject matcher,
               BSONObject selector,
               BSONObject orderBy,
               BSONObject hint,
               long skipRows,
               long returnRows,
               int flag,
               BSONObject options)
                 throws BaseException
```
    参数:
    matcher - the matching rule, return all the documents if null
    selector - the selective rule, return the whole document if null
    orderBy - the ordered rule, never sort if null
    hint - the hint, automatically match the optimal hint if null
    skipRows - skip the first numToSkip documents, never skip if this parameter is 0
    returnRows - only return returnRows documents, return all if this parameter is -1
    flag - the flag is used to choose the way to query, the optional options are as below:
    
    DBQuery.FLG_QUERY_STRINGOUT
    DBQuery.FLG_QUERY_FORCE_HINT
    DBQuery.FLG_QUERY_PARALLED
    DBQuery.FLG_QUERY_WITH_RETURNDATA
    DBQuery.FLG_QUERY_EXPLAIN
    options - The rules of query explain, the options are as below:
    
    Run : Whether execute query explain or not, true for excuting query explain then get the data and time information; false for not excuting query explain but get the query explain information only. e.g. {Run:true}
    返回:
    a DBCursor instance of the result
    
    抛出:
    
    BaseException
  - query
```
public DBCursor query()
               throws BaseException
```
    返回:
    a DBCursor instance of the result
    
    抛出:
    
    BaseException
  - query
```
public DBCursor query(DBQuery matcher)
               throws BaseException
```
    参数:
    matcher - the matching rule, return all the documents if null
    
    返回:
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException
    另请参阅:
    DBQuery
  - query
```
public DBCursor query(BSONObject matcher,
             BSONObject selector,
             BSONObject orderBy,
             BSONObject hint)
               throws BaseException
```
    参数:
    matcher - the matching rule, return all the documents if null
    selector - the selective rule, return the whole document if null
    orderBy - the ordered rule, never sort if null
    hint - the hint, automatically match the optimal hint if null
    
    返回:
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException
  - query
```
public DBCursor query(BSONObject matcher,
             BSONObject selector,
             BSONObject orderBy,
             BSONObject hint,
             int flag)
               throws BaseException
```
    参数:
    matcher - the matching rule, return all the documents if null
    selector - the selective rule, return the whole document if null
    orderBy - the ordered rule, never sort if null
    hint - the hint, automatically match the optimal hint if null
    flag - the flag is used to choose the way to query, the optional options are as below:
    
    BDQuery.FLG_QUERY_STRINGOUT
    BDQuery.FLG_QUERY_FORCE_HINT
    BDQuery.FLG_QUERY_PARALLED
    返回:
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException
  - query
```
public DBCursor query(String matcher,
             String selector,
             String orderBy,
             String hint)
               throws BaseException
```
    参数:
    matcher - the matching rule, return all the documents if null
    selector - the selective rule, return the whole document if null
    orderBy - the ordered rule, never sort if null
    hint - the hint, automatically match the optimal hint if null
    
    返回:
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException
  - query
```
public DBCursor query(String matcher,
             String selector,
             String orderBy,
             String hint,
             int flag)
               throws BaseException
```
    参数:
    matcher - the matching rule, return all the documents if null
    selector - the selective rule, return the whole document if null
    orderBy - the ordered rule, never sort if null
    hint - the hint, automatically match the optimal hint if null
    flag - the flag is used to choose the way to query, the optional options are as below:
    
    BDQuery.FLG_QUERY_STRINGOUT
    BDQuery.FLG_QUERY_FORCE_HINT
    BDQuery.FLG_QUERY_PARALLED
    返回:
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException
  - query
```
public DBCursor query(String matcher,
             String selector,
             String orderBy,
             String hint,
             long skipRows,
             long returnRows)
               throws BaseException
```
    参数:
    matcher - the matching rule, return all the documents if null
    selector - the selective rule, return the whole document if null
    orderBy - the ordered rule, never sort if null
    hint - the hint, automatically match the optimal hint if null
    skipRows - skip the first numToSkip documents, never skip if this parameter is 0
    returnRows - only return returnRows documents, return all if this parameter is -1
    
    返回:
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException
  - query
```
public DBCursor query(BSONObject matcher,
             BSONObject selector,
             BSONObject orderBy,
             BSONObject hint,
             long skipRows,
             long returnRows)
               throws BaseException
```
    参数:
    matcher - the matching rule, return all the documents if null
    selector - the selective rule, return the whole document if null
    orderBy - the ordered rule, never sort if null
    hint - the hint, automatically match the optimal hint if null
    skipRows - skip the first numToSkip documents, never skip if this parameter is 0
    returnRows - only return returnRows documents, return all if this parameter is -1
    
    返回:
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException
  - query
```
public DBCursor query(BSONObject matcher,
             BSONObject selector,
             BSONObject orderBy,
             BSONObject hint,
             long skipRows,
             long returnRows,
             int flag)
               throws BaseException
```
    参数:
    matcher - the matching rule, return all the documents if null
    selector - the selective rule, return the whole document if null
    orderBy - the ordered rule, never sort if null
    hint - the hint, automatically match the optimal hint if null
    skipRows - skip the first numToSkip documents, never skip if this parameter is 0
    returnRows - only return returnRows documents, return all if this parameter is -1
    flag - the flag is used to choose the way to query, the optional options are as below:
    
    DBQuery.FLG_QUERY_STRINGOUT
    DBQuery.FLG_QUERY_FORCE_HINT
    DBQuery.FLG_QUERY_PARALLED
    DBQuery.FLG_QUERY_WITH_RETURNDATA
    DBQuery.FLG_QUERY_EXPLAIN
    返回:
    a DBCursor instance of the result or null if no any matched document
    
    抛出:
    
    BaseException
  - queryOne
```
public BSONObject queryOne(BSONObject matcher,
                  BSONObject selector,
                  BSONObject orderBy,
                  BSONObject hint,
                  int flag)
                    throws BaseException
```
    参数:
    matcher - the matching rule, return all the documents if null
    selector - the selective rule, return the whole document if null
    orderBy - the ordered rule, never sort if null
    hint - the hint, automatically match the optimal hint if null
    flag - the flag is used to choose the way to query, the optional options are as below:
    
    BDQuery.FLG_QUERY_STRINGOUT
    BDQuery.FLG_QUERY_FORCE_HINT
    BDQuery.FLG_QUERY_PARALLED
    返回:
    the matched document or null if no such document
    
    抛出:
    
    BaseException
  - queryOne
```
public BSONObject queryOne()
                    throws BaseException
```
    返回:
    the document or null if no any document in current collection
    
    抛出:
    
    BaseException
  - getIndexes
```
public DBCursor getIndexes()
                    throws BaseException
```
    返回:
    DBCursor of indexes
    
    抛出:
    
    BaseException
  - getIndex
```
public DBCursor getIndex(String name)
                  throws BaseException
```
    参数:
    name - The index name, returns all of the indexes if this parameter is null
    
    返回:
    dbCursor of indexes
    
    抛出:
    
    BaseException
  - createIndex
```
public void createIndex(String name,
               BSONObject key,
               boolean isUnique,
               boolean enforced)
                 throws BaseException
```
    参数:
    name - The index name
    key - The index key, like: {"key":1/-1}, ASC(1)/DESC(-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
  - createIndex
```
public void createIndex(String name,
               String key,
               boolean isUnique,
               boolean enforced)
                 throws BaseException
```
    参数:
    name - The index name
    key - The index key, like: {"key":1/-1}, ASC(1)/DESC(-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
  - dropIndex
```
public void dropIndex(String name)
               throws BaseException
```
    参数:
    name - The index name
    
    抛出:
    
    BaseException
  - getCount
```
public long getCount()
              throws BaseException
```
    返回:
    the amount of matching documents
    
    抛出:
    
    BaseException
  - getCount
```
public long getCount(String matcher)
              throws BaseException
```
    参数:
    matcher - the matching rule
    
    返回:
    the amount of matching documents
    
    抛出:
    
    BaseException
  - getCount
```
public long getCount(BSONObject matcher)
              throws BaseException
```
    参数:
    matcher - The matching rule
    
    返回:
    the amount of matching documents
    
    抛出:
    
    BaseException
  - getCount
```
public long getCount(BSONObject condition,
            BSONObject hint)
              throws BaseException
```
    参数:
    condition - The matching rule
    hint - The hint, automatically match the optimal hint if null
    
    返回:
    The count of matching BSONObjects
    
    抛出:
    
    BaseException
  - split
```
public void split(String sourceGroupName,
         String destGroupName,
         BSONObject splitCondition,
         BSONObject splitEndCondition)
           throws BaseException
```
    参数:
    sourceGroupName - the source group name
    destGroupName - the destination group name
    splitCondition - the split condition
    splitEndCondition - the split end condition or null eg:If we create a collection with the option {ShardingKey:{"age":1},ShardingType:"Hash",Partition:2^10}, 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
  - split
```
public void split(String sourceGroupName,
         String destGroupName,
         double percent)
           throws BaseException
```
    参数:
    sourceGroupName - the source group name
    destGroupName - the destination group name
    percent - the split percent, Range:(0,100]
    
    抛出:
    
    BaseException
  - splitAsync
```
public long splitAsync(String sourceGroupName,
              String destGroupName,
              BSONObject splitCondition,
              BSONObject splitEndCondition)
                throws BaseException
```
    参数:
    sourceGroupName - the source group name
    destGroupName - the destination group name
    splitCondition - the split condition
    splitEndCondition - the split end condition or null eg:If we create a collection with the option {ShardingKey:{"age":1},ShardingType:"Hash",Partition:2^10}, we can fill {age:30} as the splitCondition, and fill {age:60} as the splitEndCondition. when split, the targe 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 backgroup.
    
    抛出:
    
    BaseException
    另请参阅:
    listTask, cancelTask
  - splitAsync
```
public long splitAsync(String sourceGroupName,
              String destGroupName,
              double percent)
                throws BaseException
```
    参数:
    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 backgroup.
    
    抛出:
    
    BaseException
  - aggregate
```
public DBCursor aggregate(List<BSONObject> obj)
                   throws BaseException
```
    参数:
    obj - The Bson object of rule list, can't be null
    
    抛出:
    
    BaseException
  - getQueryMeta
```
public DBCursor getQueryMeta(BSONObject query,
                    BSONObject orderBy,
                    BSONObject hint,
                    long skipRows,
                    long returnRows,
                    int flag)
                      throws BaseException
```
    参数:
    query - The matching condition
    orderBy - The ordered rule
    hint - One of the indexs of current collection, using default index to query if not provided eg:{"":"ageIndex"}
    skipRows - The rows to be skipped
    returnRows - The rows to return
    flag - The flag to use which form for record data 0: bson stream 1: binary data stream, form: col1|col2|col3
    
    返回:
    DBCursor of datas
    
    抛出:
    
    BaseException
  - attachCollection
```
public void attachCollection(String subClFullName,
                    BSONObject options)
                      throws BaseException
```
    参数:
    subClFullName - The full name of the subcollection
    options - The low boudary and up boudary eg: {"LowBound":{a:1},"UpBound":{a:100}}
    
    抛出:
    
    BaseException
  - detachCollection
```
public void detachCollection(String subClFullName)
                      throws BaseException
```
    参数:
    subClFullName - The full name of the subcollection
    
    抛出:
    
    BaseException
  - alterCollection
```
public void alterCollection(BSONObject options)
                     throws BaseException
```
    参数:
    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]. e.g. {RepliSize:0, ShardingKey:{a:1}, ShardingType:"hash", Partition:1024}
    抛出:
    
    BaseException
  - listLobs
```
public DBCursor listLobs()
                  throws BaseException
```
    返回:
    DBCursor of lobs
    
    抛出:
    
    BaseException
  - createLob
```
public DBLob createLob()
                throws BaseException
```
    返回:
    DBLob object
    
    抛出:
    
    com.sequoiadb.exception.BaseException.
    
    BaseException
  - createLob
```
public DBLob createLob(ObjectId id)
                throws BaseException
```
    参数:
    id - the lob's id. if id is null, it will be generated in this function
    
    返回:
    DBLob object
    
    抛出:
    
    com.sequoiadb.exception.BaseException.
    
    BaseException
  - openLob
```
public DBLob openLob(ObjectId id)
              throws BaseException
```
    参数:
    id - the lob's id.
    
    返回:
    DBLob object
    
    抛出:
    
    com.sequoiadb.exception.BaseException.
    
    BaseException
  - removeLob
```
public void removeLob(ObjectId lobID)
               throws BaseException
```
    参数:
    id - the lob's id.
    
    抛出:
    
    com.sequoiadb.exception.BaseException.
    
    BaseException

类 DBCollection

字段概要

方法概要

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

字段详细资料

FLG_INSERT_CONTONDUP

方法详细资料

getConnection

setConnection

getName

getFullName

getCSName

getSequoiadb

getCollectionSpace

setMainKeys

insert

insert

save

save

bulkInsert

delete

delete

delete

delete

update

update

update

upsert

explain

query

query

query

query

query

query

query

query

query

queryOne

queryOne

getIndexes

getIndex

createIndex

createIndex

dropIndex

getCount

getCount

getCount

getCount

split

split

splitAsync

splitAsync

aggregate

getQueryMeta

attachCollection

detachCollection

alterCollection

listLobs

createLob

createLob

openLob

removeLob