com.sequoiadb.base

Class DBCollection

java.lang.Object

com.sequoiadb.base.DBCollection

public class DBCollection
extends Object

Collection of SequoiaDB.

Method Summary

Modifier and Type	Method and Description
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.
InsertResult	bulkInsert(List<BSONObject> records) Insert a bulk of bson objects into current collection.
InsertResult	bulkInsert(List<BSONObject> records, InsertOption option) Insert a bulk of bson objects into current collection.
void	createAutoIncrement(BSONObject options) Create auto-increment for current collection.
void	createAutoIncrement(List<BSONObject> options) Create one or more auto-increment for current collection.
void	createIdIndex(BSONObject options) Create the id index.
void	createIndex(String indexName, BSONObject indexKeys, boolean isUnique, boolean enforced) Create a index with indexName and indexKeys
void	createIndex(String indexName, BSONObject indexKeys, boolean isUnique, boolean enforced, int sortBufferSize) Create a index with indexName and indexKeys.
void	createIndex(String indexName, BSONObject indexKeys, BSONObject options) Create a index with name and key.
void	createIndex(String indexName, String indexKeys, boolean isUnique, boolean enforced) Create a index with indexName and indexKeys.
void	createIndex(String indexName, String indexKeys, boolean isUnique, boolean enforced, int sortBufferSize) Create a index with indexName and indexKeys.
DBLob	createLob() Create a lob.
DBLob	createLob(ObjectId id) Create a lob with a given id.
ObjectId	createLobID() Just create a lobID from server.
ObjectId	createLobID(Date d) Just create a lobID from server.
DeleteResult	deleteRecords(BSONObject matcher) Delete the matching records of current collection.
DeleteResult	deleteRecords(BSONObject matcher, DeleteOption option) Delete the matching records 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	dropAutoIncrement(List<String> fieldNames) Drop one or more auto-increment of current collection.
void	dropAutoIncrement(String fieldName) Drop auto-increment of current collection.
void	dropIdIndex() Drop the id index.
void	dropIndex(String indexName) 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
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.
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.
BSONObject	getIndexStat(String name) Get the statistics of the index.
BSONObject	getIndexStat(String name, boolean detail) Get the statistics of the index.
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.
InsertResult	insertRecord(BSONObject record) Insert a document into current collection.
InsertResult	insertRecord(BSONObject record, InsertOption option) Insert a document into current collection.
boolean	isIndexExist(String name) Test the specified index exist or not.
DBCursor	listLobs() Get all of the lobs in current collection.
DBCursor	listLobs(BSONObject matcher, BSONObject selector, BSONObject orderBy, BSONObject hint, long skipRows, long returnRows) Get 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	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().
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.
UpdateResult	updateRecords(BSONObject matcher, BSONObject modifier) Update the matching records of current collection.
UpdateResult	updateRecords(BSONObject matcher, BSONObject modifier, UpdateOption option) Update the matching records of current collection.
UpdateResult	upsertRecords(BSONObject matcher, BSONObject modifier) Update the matching records of current collection, insert if no matching.
UpdateResult	upsertRecords(BSONObject matcher, BSONObject modifier, UpsertOption option) Update the matching records of current collection, insert if no matching.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

aggregate

public DBCursor aggregate(List<BSONObject> objs)
                   throws BaseException

Execute aggregate operation in current collection.

Parameters:

objs - The Bson object of rule list, can't be null

Throws:

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.

Parameters:

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, default is 1
• ShardingKey : Assign the sharding key, foramt: { ShardingKey: { : <1/-1>} }, 1 indicates positive order, -1 indicates reverse order. e.g. { ShardingKey: { age: 1 } }
• ShardingType : Assign the sharding type, default is "hash"
• Partition : The number of partition, it is valid when ShardingType is "hash", the range is [2^3, 2^20], default is 4096
• AutoSplit : Whether to enable the automatic partitioning, it is valid when ShardingType is "hash", defalut is false
• EnsureShardingIndex : Whether to build sharding index, default is true
• Compressed : Whether to enable data compression, default is true
• CompressionType : The compression type of data, could be "snappy" or "lzw"
• StrictDataMode : Whether to enable strict date mode in numeric operations, default is false
• AutoIncrement : Assign attributes of an autoincrement field or batch autoincrement fields e.g. { AutoIncrement : { Field : "a", MaxValue : 2000 } }, { AutoIncrement : [ { Field : "a", MaxValue : 2000}, { Field : "a", MaxValue : 4000 } ] }
• AutoIndexId : Whether to build "$id" index, default is true

Throws:

BaseException - If error happens.

attachCollection

public void attachCollection(String subClFullName,
                             BSONObject options)
                      throws BaseException

Attach the specified collection.

Parameters:

subClFullName - The full name of the sub-collection

options - The low boundary and up boundary eg: {"LowBound":{a:1},"UpBound":{a:100}}

Throws:

BaseException - If error happens.

bulkInsert

public InsertResult bulkInsert(List<BSONObject> records)
                        throws BaseException

Insert a bulk of bson objects into current collection.

Parameters:

records - The Bson object of record list, can't be null. insert will interrupt when Duplicate key exist.

Returns:

InsertResult

Throws:

BaseException - If error happens.

Since:

3.4.5/5.0.3

bulkInsert

public InsertResult bulkInsert(List<BSONObject> records,
                               InsertOption option)
                        throws BaseException

Insert a bulk of bson objects into current collection.

Parameters:

records - The Bson object of record list, can't be null. insert will interrupt when Duplicate key exist.

option - InsertOption

Returns:

InsertResult

Throws:

BaseException - If error happens.

Since:

3.4.5/5.0.3

createAutoIncrement

public void createAutoIncrement(BSONObject options)

Create auto-increment for current collection.

Parameters:

options - The options for creating auto-increment are as below:

• Field : Auto-increment field name
• Increment : The interval between consecutive values
• StartValue : The first value for auto-increment
• MinValue : The minimum value
• MaxValue : The maximum value
• CacheSize : The number of values that are cached in catalog node
• AcquireSize : The number of values that are acquired by coord node
• Cycled : Whether generate the next value after reaching the maximum or minimum
• Generated : Whether generate value if the field has already exist. It can be "default", "always" or "strict".
• default : Generate the value by default if field is not exist. It is default value either.
• always : Always Generate the value, ignore the existent field.
• strict : Like 'default' behavior, but additionally check the type of field. If not number, return error. e.g. {Field:"ID", StartValue:100, Generated:"always"}

Throws:

BaseException - If error happens.

createAutoIncrement

public void createAutoIncrement(List<BSONObject> options)

Create one or more auto-increment for current collection.

Parameters:

options - The options of the auto-increment(s)

Throws:

BaseException - If error happens.

createIdIndex

public void createIdIndex(BSONObject options)
                   throws BaseException

Create the id index.

Parameters:

options - can be empty or specify option. e.g. {SortBufferSize:64}

Throws:

BaseException - If error happens.

createIndex

public void createIndex(String indexName,
                        BSONObject indexKeys,
                        boolean isUnique,
                        boolean enforced)
                 throws BaseException

Create a index with indexName and indexKeys

Parameters:

indexName - The index indexName.

indexKeys - 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.

Throws:

BaseException - If error happens.

createIndex

public void createIndex(String indexName,
                        BSONObject indexKeys,
                        boolean isUnique,
                        boolean enforced,
                        int sortBufferSize)
                 throws BaseException

Create a index with indexName and indexKeys.

Parameters:

indexName - The index indexName.

indexKeys - 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.

Throws:

BaseException - If error happens.

createIndex

public void createIndex(String indexName,
                        BSONObject indexKeys,
                        BSONObject options)
                 throws BaseException

Create a index with name and key.

Parameters:

indexName - The index name.

indexKeys - The index keys in JSON format, like: { "a":1, "b":-1 }.

options - Optional configuration, type is BSONObject. Please reference here for more detail, like: { "Unique" : false , "Enforced" : false , "NotNull" : false , "SortBufferSize" : 64 }

Throws:

BaseException

createIndex

public void createIndex(String indexName,
                        String indexKeys,
                        boolean isUnique,
                        boolean enforced)
                 throws BaseException

Create a index with indexName and indexKeys.

Parameters:

indexName - The index indexName.

indexKeys - 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.

Throws:

BaseException - If error happens.

createIndex

public void createIndex(String indexName,
                        String indexKeys,
                        boolean isUnique,
                        boolean enforced,
                        int sortBufferSize)
                 throws BaseException

Create a index with indexName and indexKeys.

Parameters:

indexName - The index indexName.

indexKeys - 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.

Throws:

BaseException - If error happens.

createLob

public DBLob createLob()
                throws BaseException

Create a lob.

Returns:

DBLob object

Throws:

BaseException - If error happens..

createLob

public DBLob createLob(ObjectId id)
                throws BaseException

Create a lob with a given id.

Parameters:

id - the lob's id. if id is null, it will be generated in this function

Returns:

DBLob object

Throws:

BaseException - If error happens..

createLobID

public ObjectId createLobID()
                     throws BaseException

Just create a lobID from server.

Returns:

ObjectId object

Throws:

BaseException - If error happens..

createLobID

public ObjectId createLobID(Date d)
                     throws BaseException

Just create a lobID from server.

Parameters:

d - LobID's relative time. if d is NULL the relative time will be server's system time

Returns:

ObjectId object

Throws:

BaseException - If error happens..

deleteRecords

public DeleteResult deleteRecords(BSONObject matcher)
                           throws BaseException

Delete the matching records of current collection.

Parameters:

matcher - The matching condition, match all the documents if null.

Returns:

DeleteResult

Throws:

BaseException - If error happens.

Since:

3.4.5/5.0.3

deleteRecords

public DeleteResult deleteRecords(BSONObject matcher,
                                  DeleteOption option)
                           throws BaseException

Delete the matching records of current collection.

Parameters:

matcher - The matching condition, match all the documents if null.

option - DeleteOption

Returns:

DeleteResult

Throws:

BaseException - If error happens.

Since:

3.4.5/5.0.3

detachCollection

public void detachCollection(String subClFullName)
                      throws BaseException

Detach the specified collection.

Parameters:

subClFullName - The full name of the sub-collection

Throws:

BaseException - If error happens.

disableCompression

public void disableCompression()
                        throws BaseException

Alter the attributes of current collection to disable compression

Throws:

BaseException - If error happens.

disableSharding

public void disableSharding()
                     throws BaseException

Alter the attributes of current collection to disable sharding

Throws:

BaseException - If error happens.

dropAutoIncrement

public void dropAutoIncrement(List<String> fieldNames)

Drop one or more auto-increment of current collection.

Parameters:

fieldNames - The auto-increment field name(s)

Throws:

BaseException - If error happens.

dropAutoIncrement

public void dropAutoIncrement(String fieldName)

Drop auto-increment of current collection.

Parameters:

fieldName - The auto-increment field name

Throws:

BaseException - If error happens.

dropIdIndex

public void dropIdIndex()
                 throws BaseException

Drop the id index.

Throws:

BaseException - If error happens.

dropIndex

public void dropIndex(String indexName)
               throws BaseException

Remove the named index of current collection.

Parameters:

indexName - The index indexName.

Throws:

BaseException - If error happens.

enableCompression

public void enableCompression(BSONObject options)
                       throws BaseException

Alter the attributes of current collection to enable compression

Parameters:

options - The options for altering current collection are as below:

• CompressionType : The compression type of data, could be "snappy" or "lzw"

Throws:

BaseException - If error happens.

enableSharding

public void enableSharding(BSONObject options)
                    throws BaseException

Alter the attributes of current collection to enable sharding

Parameters:

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

Throws:

BaseException - If error happens.

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.

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.

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:

• DBQuery.FLG_QUERY_STRINGOUT
• DBQuery.FLG_QUERY_FORCE_HINT
• DBQuery.FLG_QUERY_PARALLED

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, default to be false. e.g. {Run: true}
• Detail: Whether return detail info, such as coord, data and context information, default to be false. e.g. {Detail: true}
• CMDLocation: Filter return info, need a BSONObject as value, only support "GroupID" and "GroupName" as the BSONObject key, if CMDLocation options is explicitly set, the Detail options will automatically set to be true, default to be null. e.g. {CMDLocation: {GroupName: "group1"}}

Returns:

a DBCursor instance of the result

Throws:

BaseException - If error happens.

getCollectionSpace

public CollectionSpace getCollectionSpace()

Get the CollectionSpace instance of current collection.

Returns:

CollectionSpace instance

getCount

public long getCount()
              throws BaseException

Get the amount of documents in current collection.

Returns:

the amount of matching documents

Throws:

BaseException - If error happens.

getCount

public long getCount(BSONObject matcher)
              throws BaseException

Get the amount of matching documents in current collection.

Parameters:

matcher - The matching rule, when condition is null, the return amount contains all the records.

Returns:

the amount of matching documents

Throws:

BaseException - If error happens.

getCount

public long getCount(BSONObject matcher,
                     BSONObject hint)
              throws BaseException

Get the count of matching BSONObject in current collection.

Parameters:

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.

Returns:

The count of matching BSONObjects

Throws:

BaseException - If error happens.

getCSName

public String getCSName()

Get the full name of specified collection in current collection space.

Returns:

The full name of specified collection.

getFullName

public String getFullName()

Get the full name of specified collection in current collection space.

Returns:

The full name of specified collection

getIndexes

public DBCursor getIndexes()
                    throws BaseException

Get all the indexes of current collection

Returns:

DBCursor of indexes

Throws:

BaseException - If error happens.

getIndexInfo

public BSONObject getIndexInfo(String name)
                        throws BaseException

Get the information of specified index in current collection.

Parameters:

name - The index name.

Returns:

The information of the specified index.

Throws:

BaseException - If error happens or the specified index does not exist.

getIndexStat

public BSONObject getIndexStat(String name)
                        throws BaseException

Get the statistics of the index.

Parameters:

name - The index name.

Returns:

The statistics of the specified index.

Throws:

BaseException - If error happens.

getIndexStat

public BSONObject getIndexStat(String name,
                               boolean detail)
                        throws BaseException

Get the statistics of the index.

Parameters:

name - The index name.

detail - Whether to get additional MCV (Most Common Values) statistics of index.

Returns:

The statistics of the specified index.

Throws:

BaseException - If error happens.

getName

public String getName()

Get the name of current collection.

Returns:

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.

Parameters:

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

Returns:

DBCursor of data

Throws:

BaseException - If error happens.

getSequoiadb

public Sequoiadb getSequoiadb()

Get the Sequoiadb instance of current collection.

Returns:

Sequoiadb instance

insertRecord

public InsertResult insertRecord(BSONObject record)
                          throws BaseException

Insert a document into current collection.

Parameters:

record - The bson object to be inserted, can't be null.

Returns:

InsertResult

Throws:

BaseException - If error happens.

Since:

3.4.5/5.0.3

insertRecord

public InsertResult insertRecord(BSONObject record,
                                 InsertOption option)
                          throws BaseException

Insert a document into current collection.

Parameters:

record - The bson object to be inserted, can't be null.

option - InsertOption

Returns:

InsertResult

Throws:

BaseException - If error happens.

Since:

3.4.5/5.0.3

isIndexExist

public boolean isIndexExist(String name)

Test the specified index exist or not.

Parameters:

name - The index name.

Returns:

True for exist while false for not exist..

listLobs

public DBCursor listLobs()
                  throws BaseException

Get all of the lobs in current collection.

Returns:

DBCursor of lobs

Throws:

BaseException - If error happens.

listLobs

public DBCursor listLobs(BSONObject matcher,
                         BSONObject selector,
                         BSONObject orderBy,
                         BSONObject hint,
                         long skipRows,
                         long returnRows)
                  throws BaseException

Get the lobs in current collection.

Parameters:

matcher - the matching rule, return all the lobs if null

selector - the selective rule, return the whole lobs if null

orderBy - the ordered rule, never sort if null

hint - Specified options. e.g. {"ListPieces": 1} means get the detail piece info of lobs;

skipRows - skip the first numToSkip lobs, never skip if this parameter is 0

returnRows - return the specified amount of lobs, when returnRows is 0, return nothing, when returnRows is -1, return all the lobs

Returns:

DBCursor of lobs

Throws:

BaseException - If error happens.

openLob

public DBLob openLob(ObjectId id)
              throws BaseException

Open an existing lob with id.

Parameters:

id - the lob's id.

Returns:

DBLob object

Throws:

BaseException - If error happens.

openLob

public DBLob openLob(ObjectId id,
                     int mode)
              throws BaseException

Open an existing lob with id.

Parameters:

id - the lob's id.

mode - open mode as follow:

• DBLob.SDB_LOB_READ
• DBLob.SDB_LOB_SHAREREAD
• DBLob.SDB_LOB_WRITE
• DBLob.SDB_LOB_SHAREREAD | DBLob.SDB_LOB_WRITE for both reading and writing

Returns:

DBLob object

Throws:

BaseException - If error happens..

pop

public void pop(BSONObject options)
         throws BaseException

Pop records from the collection.

Parameters:

options - the pop option for the operation, including a record LogicalID, and an optional Direction: 1 for forward pop and -1 for backward pop

Throws:

BaseException - If error happens.

query

public DBCursor query()
               throws BaseException

Get all documents of current collection.

Returns:

a DBCursor instance of the result

Throws:

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.

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.

Returns:

a DBCursor instance of the result or null if no any matched document

Throws:

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.

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.

flag - the query flag, default to be 0:

• DBQuery.FLG_QUERY_STRINGOUT
• DBQuery.FLG_QUERY_FORCE_HINT
• DBQuery.FLG_QUERY_PARALLED
• DBQuery.FLG_QUERY_FOR_UPDATE

Returns:

a DBCursor instance of the result or null if no any matched document

Throws:

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.

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.

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:

a DBCursor instance of the result or null if no any matched document

Throws:

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.

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.

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 flag, default to be 0:

• DBQuery.FLG_QUERY_STRINGOUT
• DBQuery.FLG_QUERY_FORCE_HINT
• DBQuery.FLG_QUERY_PARALLED
• DBQuery.FLG_QUERY_FOR_UPDATE

Returns:

a DBCursor instance of the result or null if no any matched document

Throws:

BaseException - If error happens.

query

public DBCursor query(DBQuery matcher)
               throws BaseException

Get the matching documents in current collection.

Parameters:

matcher - the matching rule, return all the documents if null

Returns:

a DBCursor instance of the result or null if no any matched document

Throws:

BaseException - If error happens.

See Also:

DBQuery

query

public DBCursor query(String matcher,
                      String selector,
                      String orderBy,
                      String hint)
               throws BaseException

Get the matching documents in current collection.

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.

Returns:

a DBCursor instance of the result or null if no any matched document

Throws:

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.

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.

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:

• DBQuery.FLG_QUERY_STRINGOUT
• DBQuery.FLG_QUERY_FORCE_HINT
• DBQuery.FLG_QUERY_PARALLED
• DBQuery.FLG_QUERY_FOR_UPDATE

Returns:

a DBCursor instance of the result or null if no any matched document

Throws:

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.

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

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 flag, default to be 0:

• DBQuery.FLG_QUERY_STRINGOUT
• DBQuery.FLG_QUERY_FORCE_HINT
• DBQuery.FLG_QUERY_PARALLED
• DBQuery.FLG_QUERY_KEEP_SHARDINGKEY_IN_UPDATE
• DBQuery.FLG_QUERY_FOR_UPDATE

returnNew - When true, returns the updated document rather than the original

Returns:

a DBCursor instance of the result or null if no any matched document

Throws:

BaseException - If error happens.

queryOne

public BSONObject queryOne()
                    throws BaseException

Get one document from current collection.

Returns:

the document or null if no any document in current collection

Throws:

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.

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.

flag - the query flag, default to be 0:

• DBQuery.FLG_QUERY_STRINGOUT
• DBQuery.FLG_QUERY_FORCE_HINT
• DBQuery.FLG_QUERY_PARALLED
• DBQuery.FLG_QUERY_FOR_UPDATE

Returns:

the matched document or null if no such document

Throws:

BaseException - If error happens.

removeLob

public void removeLob(ObjectId lobId)
               throws BaseException

Remove an existing lob.

Parameters:

lobId - the lob's id.

Throws:

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.

Parameters:

type - The List instance of insertor, can't be null or empty

Throws:

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

See Also:

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.

Parameters:

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.

Throws:

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

See Also:

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.

Parameters:

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:

• FLG_UPDATE_KEEP_SHARDINGKEY

Throws:

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

See Also:

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.

Parameters:

type - The object of insertor, can't be null

Throws:

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"

See Also:

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.

Parameters:

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.

Throws:

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"

See Also:

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.

Parameters:

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:

• FLG_UPDATE_KEEP_SHARDINGKEY

Throws:

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"

See Also:

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.

Parameters:

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}
• AutoIncrement : Assign attributes of an autoincrement field or batch autoincrement fields. e.g. {AutoIncrement:{Field:"a",MaxValue:2000}}, {AutoIncrement:[{Field:"a",MaxValue:2000},{Field:"a",MaxValue:4000}]}

Throws:

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.

Parameters:

keys - the main keys specified by user. the main key should exist in the object

Throws:

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.

Parameters:

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).

Throws:

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.

Parameters:

sourceGroupName - the source group name

destGroupName - the destination group name

percent - the split percent, Range:(0,100]

Throws:

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.

Parameters:

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).

Returns:

return the task id, we can use the return id to manage the sharding which is run background.

Throws:

BaseException - If error happens.

See Also:

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.

Parameters:

sourceGroupName - the source group name

destGroupName - the destination group name

percent - the split percent, Range:(0,100]

Returns:

return the task id, we can use the return id to manage the sharding which is run background.

Throws:

BaseException - If error happens.

truncate

public void truncate()
              throws BaseException

Truncate the collection.

Throws:

BaseException - If error happens.

truncateLob

public void truncateLob(ObjectId lobId,
                        long length)
                 throws BaseException

Truncate an existing lob.

Parameters:

lobId - the lob's id.

length - the truncate length

Throws:

BaseException - If error happens.

updateRecords

public UpdateResult updateRecords(BSONObject matcher,
                                  BSONObject modifier)
                           throws BaseException

Update the matching records of current collection. It won't work to update the ShardingKey field, but the other fields take effect.

Parameters:

matcher - The matching condition, match all the documents if null

modifier - The updating rule, can't be null

Returns:

UpdateResult

Throws:

BaseException - If error happens.

Since:

3.4.5/5.0.3

updateRecords

public UpdateResult updateRecords(BSONObject matcher,
                                  BSONObject modifier,
                                  UpdateOption option)
                           throws BaseException

Update the matching records of current collection. It won't work to update the ShardingKey field, but the other fields take effect.

Parameters:

matcher - The matching condition, match all the documents if null

modifier - The updating rule, can't be null

option - UpdateOption

Returns:

UpdateResult

Throws:

BaseException - If error happens.

Since:

3.4.5/5.0.3

upsertRecords

public UpdateResult upsertRecords(BSONObject matcher,
                                  BSONObject modifier)
                           throws BaseException

Update the matching records of current collection, insert if no matching. It won't work to update the ShardingKey field, but the other fields take effect.

Parameters:

matcher - The matching condition, match all the documents if null

modifier - The updating rule, can't be null

Returns:

UpdateResult

Throws:

BaseException - If error happens.

Since:

3.4.5/5.0.3

upsertRecords

public UpdateResult upsertRecords(BSONObject matcher,
                                  BSONObject modifier,
                                  UpsertOption option)
                           throws BaseException

Update the matching records of current collection, insert if no matching. It won't work to update the ShardingKey field, but the other fields take effect.

Parameters:

matcher - The matching condition, match all the documents if null

modifier - The updating rule, can't be null

option - UpsertOption

Returns:

UpdateResult

Throws:

BaseException - If error happens.

Since:

3.4.5/5.0.3