SequoiaDB
 All Classes Namespaces Files Functions Variables Enumerations Properties Pages
Public Member Functions | Properties | List of all members
SequoiaDB.Domain Class Reference

Database operation interfaces of domain. More...

Public Member Functions

void Alter (BsonDocument options)
 Alter current domain.
 
void SetAttributes (BsonDocument options)
 Alter current domain to set attributes.
 
void AddGroups (BsonDocument options)
 Alter current domain to add groups.
 
void SetGroups (BsonDocument options)
 Alter current domain to set groups.
 
void RemoveGroups (BsonDocument options)
 
DBCursor ListCS ()
 List all the collection spaces in current domain.
 
DBCursor ListCL ()
 List all the collections in current domain.
 

Properties

string Name [get]
 Return the name of current domain.
 
Sequoiadb SequoiaDB [get]
 Return the Sequoiadb handle of current domain.
 

Detailed Description

Database operation interfaces of domain.

Member Function Documentation

void SequoiaDB.Domain.AddGroups ( BsonDocument  options)
inline

Alter current domain to add groups.

Parameters
[in]optionsThe options user wants to alter
Groups:    The list of replica groups' names which the domain is going to add.
Exceptions
SequoiaDB.BaseException
System.Exception
void SequoiaDB.Domain.Alter ( BsonDocument  options)
inline

Alter current domain.

Parameters
[in]optionsThe options user wants to alter
Groups:    The list of replica groups' names which the domain is going to contain.
           eg: { "Groups": [ "group1", "group2", "group3" ] }, it means that domain
           changes to contain "group1", "group2" and "group3".
           We can add or remove groups in current domain. However, if a group has data
           in it, remove it out of domain will be failing.
AutoSplit: Alter current domain to have the ability of automatically split or not. 
           If this option is set to be true, while creating collection(ShardingType is "hash") in this domain,
           the data of this collection will be split(hash split) into all the groups in this domain automatically.
           However, it won't automatically split data into those groups which were add into this domain later.
           eg: { "Groups": [ "group1", "group2", "group3" ], "AutoSplit: true" }
Exceptions
SequoiaDB.BaseException
System.Exception
DBCursor SequoiaDB.Domain.ListCL ( )
inline

List all the collections in current domain.

Returns
The DBCursor of result
Exceptions
SequoiaDB.BaseException
System.Exception
DBCursor SequoiaDB.Domain.ListCS ( )
inline

List all the collection spaces in current domain.

Returns
The DBCursor of result
Exceptions
SequoiaDB.BaseException
System.Exception
void SequoiaDB.Domain.RemoveGroups ( BsonDocument  options)
inline
void SequoiaDB.Domain.SetAttributes ( BsonDocument  options)
inline

Alter current domain to set attributes.

Parameters
[in]optionsThe options user wants to alter
Groups:    The list of replica groups' names which the domain is going to contain.
           eg: { "Groups": [ "group1", "group2", "group3" ] }, it means that domain
           changes to contain "group1", "group2" and "group3".
           We can add or remove groups in current domain. However, if a group has data
           in it, remove it out of domain will be failing.
AutoSplit: Alter current domain to have the ability of automatically split or not. 
           If this option is set to be true, while creating collection(ShardingType is "hash") in this domain,
           the data of this collection will be split(hash split) into all the groups in this domain automatically.
           However, it won't automatically split data into those groups which were add into this domain later.
           eg: { "Groups": [ "group1", "group2", "group3" ], "AutoSplit: true" }
Exceptions
SequoiaDB.BaseException
System.Exception
void SequoiaDB.Domain.SetGroups ( BsonDocument  options)
inline

Alter current domain to set groups.

Parameters
[in]optionsThe options user wants to alter
Groups:    The list of replica groups' names which the domain is going to contain.
           We can add or remove groups in current domain. However, if a group has data
           in it, remove it out of domain will be failing.
Exceptions
SequoiaDB.BaseException
System.Exception

Property Documentation

SequoiaDB.Domain.Name
get

Return the name of current domain.

Returns
The domain name
SequoiaDB.Domain.SequoiaDB
get

Return the Sequoiadb handle of current domain.

Returns
Sequoiadb object

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