SequoiaDB.CollectionSpace Class Reference

Database operation interfaces of collection space. More...

Public Member Functions
DBCollection	GetCollection (string collectionName)
	Get the named collection.
bool	IsCollectionExist (string colName)
	Verify the existence of collection in current colleciont space.
DBCollection	CreateCollection (string collectionName)
	Create the named collection in current collection space.
DBCollection	CreateCollection (string collectionName, BsonDocument options)
	Create the named collection in current collection space.
void	DropCollection (string collectionName)
	Remove the named collection of current collection space.
void	Alter (BsonDocument options)
	Alter collection space.
void	SetDomain (BsonDocument options)
	Alter collection space to set domain.
void	RemoveDomain ()
	Alter collection space to remove domain Exceptions SequoiaDB.BaseException System.Exception.
void	EnableCapped ()
	Alter collection space to enable capped Exceptions SequoiaDB.BaseException System.Exception.
void	DisableCapped ()
	Alter collection space to disable capped Exceptions SequoiaDB.BaseException System.Exception.
void	SetAttributes (BsonDocument options)
	Alter collection space.
void	RenameCollection (String oldName, String newName)
	Rename the collection.

Properties
string	Name [get]
	Return the name of current collection space.
Sequoiadb	SequoiaDB [get]
	Return the Sequoiadb handle of current collection space.

Detailed Description

Database operation interfaces of collection space.

Member Function Documentation

void SequoiaDB.CollectionSpace.Alter ( BsonDocument  options )

inline

Alter collection space.

Parameters

[in]

options

The options of collection space to be changed, e.g. { "PageSize": 4096, "Domain": "mydomain" }. PageSize : The page size of the collection space LobPageSize : The page size of LOB objects in the collection space Domain : The domain which the collection space belongs to

Exceptions

SequoiaDB.BaseException
System.Exception

DBCollection SequoiaDB.CollectionSpace.CreateCollection ( string  collectionName )

inline

Create the named collection in current collection space.

Parameters

collectionName

The collection name

Returns

The DBCollection handle

Exceptions

SequoiaDB.BaseException
System.Exception

DBCollection SequoiaDB.CollectionSpace.CreateCollection ( string  collectionName, BsonDocument  options  )

inline

Create the named collection in current collection space.

Parameters

collectionName	The collection name
options	The options for creating collection. Please reference here for more detail.

Returns

The DBCollection handle

Exceptions

SequoiaDB.BaseException
System.Exception

void SequoiaDB.CollectionSpace.DisableCapped ( )

inline

Alter collection space to disable capped

Exceptions

SequoiaDB.BaseException
System.Exception.

void SequoiaDB.CollectionSpace.DropCollection ( string  collectionName )

inline

Remove the named collection of current collection space.

Parameters

collectionName

The collection name

Exceptions

SequoiaDB.BaseException
System.Exception

void SequoiaDB.CollectionSpace.EnableCapped ( )

inline

Alter collection space to enable capped

Exceptions

SequoiaDB.BaseException
System.Exception.

DBCollection SequoiaDB.CollectionSpace.GetCollection ( string  collectionName )

inline

Get the named collection.

Parameters

collectionName

The collection name

Returns

The DBCollection handle

Exceptions

SequoiaDB.BaseException
System.Exception

bool SequoiaDB.CollectionSpace.IsCollectionExist ( string  colName )

inline

Verify the existence of collection in current colleciont space.

Parameters

colName

The collection name

Returns

True if collection existed or False if not existed

Exceptions

SequoiaDB.BaseException
System.Exception

void SequoiaDB.CollectionSpace.RemoveDomain ( )

inline

Alter collection space to remove domain

Exceptions

SequoiaDB.BaseException
System.Exception.

void SequoiaDB.CollectionSpace.RenameCollection ( String  oldName, String  newName  )

inline

Rename the collection.

Parameters

oldName	The original name of current collection.
newName	The new name of current collection.

Returns

void

Exceptions

SequoiaDB.BaseException
System.Exception

void SequoiaDB.CollectionSpace.SetAttributes ( BsonDocument  options )

inline

Alter collection space.

Parameters

[in]

options

The options of collection space to be changed, e.g. { "PageSize": 4096, "Domain": "mydomain" }. PageSize : The page size of the collection space LobPageSize : The page size of LOB objects in the collection space Domain : The domain which the collection space belongs to

Exceptions

SequoiaDB.BaseException
System.Exception

void SequoiaDB.CollectionSpace.SetDomain ( BsonDocument  options )

inline

Alter collection space to set domain.

Parameters

[in]

options

The options of collection space to be changed. Domain : The domain which the collection space belongs to

Exceptions

SequoiaDB.BaseException
System.Exception

Property Documentation

SequoiaDB.CollectionSpace.Name

get

Return the name of current collection space.

Returns

The collection space name

SequoiaDB.CollectionSpace.SequoiaDB

get

Return the Sequoiadb handle of current collection space.

Returns

Sequoiadb object

---

The documentation for this class was generated from the following file:

• CollectionSpace.cs