SequoiaDB
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
sdbclient::sdbDataSource Class Reference

Database operation interfaces of data source. More...

#include <client.hpp>

Public Member Functions

INT32 alterDataSource (const bson::BSONObj &options)
 Modify the attributes of the current data source.
 
const CHAR * getName ()
 Get the name of current data source.
 

Detailed Description

Database operation interfaces of data source.

Member Function Documentation

INT32 sdbclient::sdbDataSource::alterDataSource ( const bson::BSONObj &  options)
inline

Modify the attributes of the current data source.

Parameters
[in]optionsThe options for setting data source attributes:
Name              : New name of current data source.
Address           : The list of coord addresses for the target sequoiadb cluster,
                    spearated by ','. eg: "sdbserver1:11810,sdbserver2:11820"
User              : User name of data source.
Password          : Data source password corresponding to User.
AccessMode        : Configure access permissions for the data source, default is "ALL".
                    The values are as below:
                      "READ"                : Allow read-only operation.
                      "WRITE"               : Allow write-only operation.
                      "ALL" or "READ|WRITE" : Allow all operations.
                      "NONE"                : Neither read nor write operation is allowed.
ErrorFilterMask   : Configure error filtering for data operations on data sources,
                    default is "NONE". The values are as below:
                      "READ"                : Filter data read errors.
                      "WRITE"               : Filter data write errors.
                      "ALL" or "READ|WRITE" : Filter both data read and write errors.
                      "NONE"                : Do not filter any errors.
ErrorControlLevel : Configure the error control level when performing unsupported data
                    operations (such as DDL) on the mapping collection or collection space,
                    default is "low". The values are as below:
                      "high" : Report an error and output an error message.
                      "low"  : Ignore unsupported data operations and do not execute on data source.
TransPropagateMode: Configure the transaction propagation mode on data source, default is
                    "never". The values are as below:
                      "never"      : Transaction operation is forbidden. Report an error and
                                     output an error message.
                      "notsupport" : Transaction operation is not supported on data source.
                                     The operation will be converted to non-transactional
                                     and sent to data source.
InheritSessionAttr: Configure whether the session between the coordination node and the data source
                    inherits properties of the local session, default is true. The supported attributes
                    include PreferedInstance, PreferedInstanceMode, PreferedStrict, PreferedPeriod and Timeout.
Return values
SDB_OKOperation Success.
OthersOperation Fail.
const CHAR * sdbclient::sdbDataSource::getName ( )
inline

Get the name of current data source.

Return values
Thename of current data source

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