com.sequoiadb.base

类 CollectionSpace

java.lang.Object

com.sequoiadb.base.CollectionSpace

public class CollectionSpace
extends Object

Collection space of SequoiaDB.

方法概要

限定符和类型	方法和说明
void	alterCollectionSpace(BSONObject options) Alter the current collection space.
DBCollection	createCollection(String collectionName) Create the named collection in current collection space.
DBCollection	createCollection(String collectionName, BSONObject options) Create collection by options.
void	disableCapped() Alter the current collection space to disable capped
void	dropCollection(String collectionName) Remove the named collection of current collection space.
void	enableCapped() Alter the current collection space to enable capped
DBCollection	getCollection(String collectionName) Get the named collection.
List<String>	getCollectionNames() Get all the collection names of current collection space.
String	getName() Return the name of current collection space.
Sequoiadb	getSequoiadb() Get the Sequoiadb instance of current collection space belongs to.
boolean	isCollectionExist(String collectionName) Verify the existence of collection in current collection space.
void	removeDomain() Alter the current collection space to remove domain
void	renameCollection(String oldName, String newName)
void	setAttributes(BSONObject options) Alter the current collection space to set attributes.
void	setDomain(BSONObject options) Alter the current collection space to set domain

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

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

方法详细资料

alterCollectionSpace

public void alterCollectionSpace(BSONObject options)
                          throws BaseException

Alter the current collection space.

参数:

options - The options of the collection space:

• Domain : the domain of collection space.
• PageSize : page size of collection space.
• LobPageSize : LOB page size of collection space.

抛出:

BaseException - If error happens.

createCollection

public DBCollection createCollection(String collectionName)
                              throws BaseException

Create the named collection in current collection space.

参数:

collectionName - The collection name

返回:

the newly created object of collection

抛出:

BaseException - If error happens.

createCollection

public DBCollection createCollection(String collectionName,
                                     BSONObject options)

Create collection by options.

参数:

collectionName - The collection name

options - The options for creating collection, including "ShardingKey", "ReplSize", "IsMainCL" and "Compressed" informations, no options, if null

返回:

the newly created object of collection

抛出:

BaseException - Tf error happens.

disableCapped

public void disableCapped()
                   throws BaseException

Alter the current collection space to disable capped

抛出:

BaseException - If error happens.

dropCollection

public void dropCollection(String collectionName)
                    throws BaseException

Remove the named collection of current collection space.

参数:

collectionName - The collection name

抛出:

BaseException - If error happens.

enableCapped

public void enableCapped()
                  throws BaseException

Alter the current collection space to enable capped

抛出:

BaseException - If error happens.

getCollection

public DBCollection getCollection(String collectionName)
                           throws BaseException

Get the named collection.

参数:

collectionName - The collection name

返回:

the object of the specified collection, or an exception when the collection does not exist.

抛出:

BaseException - If error happens.

getCollectionNames

public List<String> getCollectionNames()
                                throws BaseException

Get all the collection names of current collection space.

返回:

A list of collection names

抛出:

BaseException - If error happens.

getName

public String getName()

Return the name of current collection space.

返回:

The collection space name

getSequoiadb

public Sequoiadb getSequoiadb()

Get the Sequoiadb instance of current collection space belongs to.

返回:

Sequoiadb object

isCollectionExist

public boolean isCollectionExist(String collectionName)
                          throws BaseException

Verify the existence of collection in current collection space.

参数:

collectionName - The collection name

返回:

True if collection existed or False if not existed

抛出:

BaseException - If error happens.

removeDomain

public void removeDomain()
                  throws BaseException

Alter the current collection space to remove domain

抛出:

BaseException - If error happens.

renameCollection

public void renameCollection(String oldName,
                             String newName)
                      throws BaseException

参数:

oldName - The old collection name

newName - The new collection name

抛出:

BaseException - If error happens.

setAttributes

public void setAttributes(BSONObject options)
                   throws BaseException

Alter the current collection space to set attributes.

参数:

options - The options of the collection space:

• Domain : the domain of collection space.
• PageSize : page size of collection space.
• LobPageSize : LOB page size of collection space.

抛出:

BaseException - If error happens.

setDomain

public void setDomain(BSONObject options)
               throws BaseException

Alter the current collection space to set domain

参数:

options - The options of the collection space:

• Domain : the domain of collection space.

抛出:

BaseException - If error happens.