SequoiaDB
 All Classes Namespaces Functions Variables Enumerations Properties Pages
Public Member Functions | Properties | List of all members
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.
 

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

DBCollection SequoiaDB.CollectionSpace.CreateCollection ( string  collectionName)
inline

Create the named collection in current collection space.

Parameters
collectionNameThe 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
collectionNameThe collection name
optionsThe options
Returns
The DBCollection handle
Exceptions
SequoiaDB.BaseException
System.Exception
void SequoiaDB.CollectionSpace.DropCollection ( string  collectionName)
inline

Remove the named collection of current collection space.

Parameters
collectionNameThe collection name
Exceptions
SequoiaDB.BaseException
System.Exception
DBCollection SequoiaDB.CollectionSpace.GetCollection ( string  collectionName)
inline

Get the named collection.

Parameters
collectionNameThe 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
colNameThe collection name
Returns
True if collection existed or False if not existed
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: