Database operation interfaces of replica group. More...

#include <client.hpp>

Public Member Functions
	sdbReplicaGroup ()
	Default constructor.

	~sdbReplicaGroup ()
	Destructor.

INT32	getNodeNum (sdbNodeStatus status, INT32 *num)
	Get the count of node with given status in current replica group.

INT32	getDetail (bson::BSONObj &result)
	Get the detail of the replica group.

INT32	getMaster (sdbNode &node)
	Get the master node of the current replica group.

INT32	getSlave (sdbNode &node, const vector< INT32 > &positions=_sdbStaticVec)
	Get one of slave node of the current replica group, if no slave exists then get master.

INT32	getNode (const CHAR *pNodeName, sdbNode &node)
	Get specified node from current replica group.

INT32	getNode (const CHAR pHostName, const CHAR pServiceName, sdbNode &node)
	Get specified node from current replica group.

INT32	removeNode (const CHAR pHostName, const CHAR pServiceName, const bson::BSONObj &configure=_sdbStaticObject)
	remove node in a given replica group.

INT32	stop ()
	Stop current replica group.

INT32	start ()
	Start up current replica group.

const CHAR *	getName ()
	Get the name of current replica group.

BOOLEAN	isCatalog ()
	Test whether current replica group is catalog replica group.

INT32	attachNode (const CHAR pHostName, const CHAR pSvcName, const bson::BSONObj &options)
	Attach a node to the group.

INT32	detachNode (const CHAR pHostName, const CHAR pSvcName, const bson::BSONObj &options)
	Detach a node from the group.

INT32	reelect (const bson::BSONObj &options=_sdbStaticObject)
	Force the replica group to reelect primary node.

INT32	reelectLocation (const CHAR *pLocation, const bson::BSONObj &options=_sdbStaticObject)
	Force the replica group to reelect location primary node.

INT32	setActiveLocation (const CHAR *pActiveLocation)
	Alter replica group to set active location.

INT32	setAttributes (const bson::BSONObj &options)
	Alter replica group.

INT32	startCriticalMode (const bson::BSONObj &options)
	start critical mode in the current replica group.

INT32	stopCriticalMode ()
	Stop critical mode in current replica group.

INT32	startMaintenanceMode (const bson::BSONObj &options)
	start maintenance mode in the current replica group.

INT32	stopMaintenanceMode (const bson::BSONObj &options)
	Stop maintenance mode in current replica group.

Public Attributes
_sdbReplicaGroup *	pReplicaGroup
	A pointer of virtual base class _sdbReplicaGroup.

Detailed Description

Database operation interfaces of replica group.

Member Function Documentation

INT32 sdbclient::sdbReplicaGroup::attachNode	(	const CHAR *	pHostName,
		const CHAR *	pSvcName,
		const bson::BSONObj &	options
	)

inline

Attach a node to the group.

Parameters

[in]	pHostName	The host name of node.
[in]	pSvcName	The service name of node.
[in]	options	The options of attach. The options are as below: KeepData : Whether to keep the original data of the new node. This option has no default value. User should specify its value explicitly.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::detachNode	(	const CHAR *	pHostName,
		const CHAR *	pSvcName,
		const bson::BSONObj &	options
	)

inline

Detach a node from the group.

Parameters

[in] pHostName The host name of node.

[in] pSvcName The service name of node.

[in]

options

The options of detach. The options are as below:

KeepData: Whether to keep the original data of the detached node.
          This option has no default value. User should specify
          its value explicitly.
Enforced: Whether to detach the node forcibly, default to be false.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::getDetail ( bson::BSONObj & result )

inline

Get the detail of the replica group.

Parameters

[out] result Return the all the info of current replica group.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::getMaster ( sdbNode & node )

inline

Get the master node of the current replica group.

Parameters

[out] node The master node.If not exit,return null.

Return values

SDB_OK	Operation Success
Others	Operation Fail

const CHAR * sdbclient::sdbReplicaGroup::getName ( )

inline

Get the name of current replica group.

Return values

The	name of current replica group or null if fail

INT32 sdbclient::sdbReplicaGroup::getNode	(	const CHAR *	pNodeName,
		sdbNode &	node
	)

inline

Get specified node from current replica group.

Parameters

[in]	pNodeName	The name of the node, with the format of "hostname:port".
[out]	node	The specified node.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::getNode	(	const CHAR *	pHostName,
		const CHAR *	pServiceName,
		sdbNode &	node
	)

inline

Get specified node from current replica group.

Parameters

[in]	pHostName	The host name of the node.
[in]	pServiceName	The service name of the node.
[out]	node	The specified node.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::getNodeNum	(	sdbNodeStatus	status,
		INT32 *	num
	)

inline

Get the count of node with given status in current replica group.

Parameters

[in]	status	The specified status as below SDB_NODE_ALL SDB_NODE_ACTIVE SDB_NODE_INACTIVE SDB_NODE_UNKNOWN
[out]	num	The count of node.

Return values

SDB_OK	Operation Success
Others	Operation Fail

Deprecated:: Since v2.6, the status of node are invalid, never use this api again.

INT32 sdbclient::sdbReplicaGroup::getSlave	(	sdbNode &	node,
		const vector< INT32 > &	positions = `_sdbStaticVec`
	)

inline

Get one of slave node of the current replica group, if no slave exists then get master.

Parameters

[in]	positions	The positions of nodes
[out]	node	The slave node

Return values

SDB_OK	Operation Success
Others	Operation Fail

BOOLEAN sdbclient::sdbReplicaGroup::isCatalog ( )

inline

Test whether current replica group is catalog replica group.

Return values

TRUE	The replica group is catalog
FALSE	The replica group is not catalog

INT32 sdbclient::sdbReplicaGroup::reelect ( const bson::BSONObj & options = _sdbStaticObject )

inline

Force the replica group to reelect primary node.

Parameters

[in] options The options of reelection. Please reference here for more detail.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::reelectLocation	(	const CHAR *	pLocation,
		const bson::BSONObj &	options = `_sdbStaticObject`
	)

inline

Force the replica group to reelect location primary node.

Parameters

[in]	pLocation	The location of reelection operation.
[in]	options	The options of reelection operation.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::removeNode	(	const CHAR *	pHostName,
		const CHAR *	pServiceName,
		const bson::BSONObj &	configure = `_sdbStaticObject`
	)

inline

remove node in a given replica group.

Parameters

[in]	pHostName	The hostname for the node
[in]	pServiceName	The servicename for the node
[in]	configure	The configurations for the node

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::setActiveLocation ( const CHAR * pActiveLocation )

inline

Alter replica group to set active location.

Parameters

[in]

pActiveLocation

The active location of replica group to be changed.

ActiveLocation     : The active location of replica group, if the parameter is "",
                     it means to remove the replica group's active location

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::setAttributes ( const bson::BSONObj & options )

inline

Alter replica group.

Parameters

[in] options The options of replica group to be changed e.g. { "ActiveLocation": "A" }.

ActiveLocation : The active location of replica group

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 INT32 sdbclient::sdbReplicaGroup::start ( )

inline

Start up current replica group.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::startCriticalMode ( const bson::BSONObj & options )

inline

start critical mode in the current replica group.

Parameters

[in]

options

The options of critical mode:

 NodeName: The critical node to be set in replica group
 Location: The critical location to be set in replica group
 Enforced: Whether to force to start critical mode in replica group
 MinKeepTime: The minimum keep time of critical mode
 MaxKeepTime: The maximum keep time of critical mode

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::startMaintenanceMode ( const bson::BSONObj & options )

inline

start maintenance mode in the current replica group.

Parameters

[in]

options

The options of maintenance mode:

 NodeName: The maintenance node to be added in replica group
 Location: The maintenance location to be added in replica group
 MinKeepTime: The minimum keep time of maintenance mode
 MaxKeepTime: The maximum keep time of maintenance mode

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::stop ( )

inline

Stop current replica group.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::stopCriticalMode ( )

inline

Stop critical mode in current replica group.

Return values

SDB_OK	Operation Success
Others	Operation Fail

INT32 sdbclient::sdbReplicaGroup::stopMaintenanceMode ( const bson::BSONObj & options )

inline

Stop maintenance mode in current replica group.

Parameters

[in]

options

The options of maintenance mode:

 NodeName: The maintenance node to be stoped in replica group
 Location: The maintenance location to be stoped in replica group

Return values

SDB_OK	Operation Success
Others	Operation Fail

Member Data Documentation

sdbclient::sdbReplicaGroup::pReplicaGroup

A pointer of virtual base class _sdbReplicaGroup.

Class sdbReplicaGroup is a shell for _sdbReplicaGroup. We use pCursor to call the methods in class _sdbReplicaGroup.

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

client.hpp

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation