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

Database operation interfaces of node. More...

Public Member Functions

bool Stop ()
 Stop the current node.
 
bool Start ()
 Start the current node.
 
SDBConst.NodeStatus GetStatus ()
 Get the status of current node.
 
Sequoiadb Connect ()
 Connect to remote Sequoiadb database node.
 
Sequoiadb Connect (string username, string password)
 Connect to remote Sequoiadb database node Sequoiadb connection user name Sequoiadb connection password.
 

Properties

ReplicaGroup ReplicaGroup [get]
 Return the replica group instance of current node.
 
string NodeName [get]
 Return the name of current node.
 
string HostName [get]
 Return the host name of current node.
 
int Port [get]
 Return the port of current node.
 
int NodeID [get]
 Return the node ID of current node.
 

Detailed Description

Database operation interfaces of node.

Member Function Documentation

Sequoiadb SequoiaDB.Node.Connect ( )
inline

Connect to remote Sequoiadb database node.

Returns
The Sequoiadb handle
Exceptions
SequoiaDB.BaseException
System.Exception
Sequoiadb SequoiaDB.Node.Connect ( string  username,
string  password 
)
inline

Connect to remote Sequoiadb database node Sequoiadb connection user name Sequoiadb connection password.

Returns
The Sequoiadb handle
Exceptions
SequoiaDB.BaseException
System.Exception
SDBConst NodeStatus SequoiaDB.Node.GetStatus ( )
inline

Get the status of current node.

Returns
The status of current node
Exceptions
SequoiaDB.BaseException
System.Exception
Deprecated:
Since v2.8, the status of node are invalid, nerver use this api again.
bool SequoiaDB.Node.Start ( )
inline

Start the current node.

Returns
True if succeed or False if fail
Exceptions
SequoiaDB.BaseException
System.Exception
bool SequoiaDB.Node.Stop ( )
inline

Stop the current node.

Returns
True if succeed or False if fail
Exceptions
SequoiaDB.BaseException
System.Exception

Property Documentation

SequoiaDB.Node.HostName
get

Return the host name of current node.

Returns
The host name
SequoiaDB.Node.NodeID
get

Return the node ID of current node.

Returns
The node ID
SequoiaDB.Node.NodeName
get

Return the name of current node.

Returns
The node name
SequoiaDB.Node.Port
get

Return the port of current node.

Returns
The port
SequoiaDB.Node.ReplicaGroup
get

Return the replica group instance of current node.

Returns
The ReplicaGroup object

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