def pysequoiadb.domain.domain.__init__ |
( |
|
self, |
|
|
|
domain_name |
|
) |
| |
constructor of domain
Exceptions:
pysequoiadb.error.SDBBaseError
def pysequoiadb.domain.domain.__del__ |
( |
|
self | ) |
|
release domain
Exceptions:
pysequoiadb.error.SDBBaseError
def pysequoiadb.domain.domain.add_groups |
( |
|
self, |
|
|
|
options |
|
) |
| |
Alter properties of this domain to add groups
Parameters:
Name Type Info
options dict The options for the domain. The options are as below:
Groups: the list of the replica groups' names which the domain is going to add.
eg: { "Groups": [ "group1", "group2", "group3" ] }
Exceptions:
pysequoiadb.error.SDBBaseError
def pysequoiadb.domain.domain.alter |
( |
|
self, |
|
|
|
options |
|
) |
| |
Alter properties of this domain
Parameters:
Name Type Info
options dict The options for the domain. The options are as below:
Groups: the list of the replica groups' names which the domain is going to contain.
eg: { "Groups": [ "group1", "group2", "group3" ] }
If this argument is not included, the domain will contain all replica groups in the cluster.
AutoSplit: 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:
pysequoiadb.error.SDBBaseError
def pysequoiadb.domain.domain.list_collection_spaces |
( |
|
self | ) |
|
List all collection spaces in this domain.
Return values:
The cursor object of collection spaces.
Exceptions:
pysequoiadb.error.SDBBaseError
def pysequoiadb.domain.domain.list_collections |
( |
|
self | ) |
|
List all collections in this domain.
Return values:
The cursor object of collections.
Exceptions:
pysequoiadb.error.SDBBaseError
def pysequoiadb.domain.domain.name |
( |
|
self | ) |
|
Get the domain name.
Return values:
The domain name.
def pysequoiadb.domain.domain.remove_groups |
( |
|
self, |
|
|
|
options |
|
) |
| |
Alter properties of this domain to remove groups
Parameters:
Name Type Info
options dict The options for the domain. The options are as below:
Groups: the list of the replica groups' names which the domain is going to remove.
eg: { "Groups": [ "group1", "group2", "group3" ] }
Exceptions:
pysequoiadb.error.SDBBaseError
def pysequoiadb.domain.domain.set_attributes |
( |
|
self, |
|
|
|
options |
|
) |
| |
Alter properties of this domain
Parameters:
Name Type Info
options dict The options for the domain. The options are as below:
Groups: the list of the replica groups' names which the domain is going to contain.
eg: { "Groups": [ "group1", "group2", "group3" ] }
If this argument is not included, the domain will contain all replica groups in the cluster.
AutoSplit: 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:
pysequoiadb.error.SDBBaseError
def pysequoiadb.domain.domain.set_groups |
( |
|
self, |
|
|
|
options |
|
) |
| |
Alter properties of this domain to set groups
Parameters:
Name Type Info
options dict The options for the domain. The options are as below:
Groups: the list of the replica groups' names which the domain is going to contain.
eg: { "Groups": [ "group1", "group2", "group3" ] }
Exceptions:
pysequoiadb.error.SDBBaseError
The documentation for this class was generated from the following file: