NCBI C++ ToolKit
Public Member Functions | Private Member Functions | Private Attributes | List of all members
CDBEnvConnParams Class Reference

Search Toolkit Book for CDBEnvConnParams

#include <dbapi/driver/dbapi_driver_conn_params.hpp>

+ Inheritance diagram for CDBEnvConnParams:
+ Collaboration diagram for CDBEnvConnParams:

Public Member Functions

 CDBEnvConnParams (const CDBConnParams &other, const string &server_name_env="DBAPI_SERVER", const string &database_name_env="DBAPI_DATABASE", const string &user_name_env="DBAPI_USER", const string &passwd_env="DBAPI_PASSWORD")
 
virtual ~CDBEnvConnParams (void)
 
void SetServerNameEnv (const string &name)
 
void SetDatabaseNameEnv (const string &name)
 
void SetUserNameEnv (const string &name)
 
void SetPasswordEnv (const string &pwd)
 
virtual string GetServerName (void) const
 
virtual string GetDatabaseName (void) const
 
virtual string GetUserName (void) const
 
virtual string GetPassword (void) const
 
- Public Member Functions inherited from CDBConnParamsDelegate
 CDBConnParamsDelegate (const CDBConnParams &other)
 
virtual ~CDBConnParamsDelegate (void)
 
virtual string GetDriverName (void) const
 
virtual Uint4 GetProtocolVersion (void) const
 
virtual EEncoding GetEncoding (void) const
 
virtual EServerType GetServerType (void) const
 
virtual Uint4 GetHost (void) const
 
virtual Uint2 GetPort (void) const
 
virtual CRef< IConnValidatorGetConnValidator (void) const
 
virtual const impl::CDBHandlerStackGetOpeningMsgHandlers (void) const
 
virtual string GetParam (const string &key) const
 Parameters, which are not listed above explicitly, should be retrieved via SetParam() method. More...
 
- Public Member Functions inherited from CDBConnParams
 CDBConnParams (void)
 
virtual ~CDBConnParams (void)
 

Private Member Functions

 CDBEnvConnParams (const CDBEnvConnParams &other)
 
CDBEnvConnParamsoperator= (const CDBEnvConnParams &other)
 

Private Attributes

const CNcbiEnvironment m_Env
 
string m_ServerNameEnv
 
string m_DatabaseNameEnv
 
string m_UserNameEnv
 
string m_PasswordEnv
 

Additional Inherited Members

- Public Types inherited from CDBConnParams
enum  EServerType {
  eUnknown , eMySQL , eSybaseOpenServer , eSybaseSQLServer ,
  eMSSqlServer
}
 
- Protected Member Functions inherited from CDBConnParams
void SetChildObj (const CDBConnParams &child_obj) const
 
void ReleaseChildObj (void) const
 
const CDBConnParamsGetThis (void) const
 

Detailed Description

Definition at line 364 of file dbapi_driver_conn_params.hpp.

Constructor & Destructor Documentation

◆ CDBEnvConnParams() [1/2]

CDBEnvConnParams::CDBEnvConnParams ( const CDBConnParams other,
const string server_name_env = "DBAPI_SERVER",
const string database_name_env = "DBAPI_DATABASE",
const string user_name_env = "DBAPI_USER",
const string passwd_env = "DBAPI_PASSWORD" 
)

Definition at line 469 of file dbapi_driver_conn_params.cpp.

◆ ~CDBEnvConnParams()

CDBEnvConnParams::~CDBEnvConnParams ( void  )
virtual

Definition at line 484 of file dbapi_driver_conn_params.cpp.

◆ CDBEnvConnParams() [2/2]

CDBEnvConnParams::CDBEnvConnParams ( const CDBEnvConnParams other)
private

Member Function Documentation

◆ GetDatabaseName()

string CDBEnvConnParams::GetDatabaseName ( void  ) const
virtual

◆ GetPassword()

string CDBEnvConnParams::GetPassword ( void  ) const
virtual

◆ GetServerName()

string CDBEnvConnParams::GetServerName ( void  ) const
virtual

◆ GetUserName()

string CDBEnvConnParams::GetUserName ( void  ) const
virtual

◆ operator=()

CDBEnvConnParams& CDBEnvConnParams::operator= ( const CDBEnvConnParams other)
private

◆ SetDatabaseNameEnv()

void CDBEnvConnParams::SetDatabaseNameEnv ( const string name)
inline

Definition at line 381 of file dbapi_driver_conn_params.hpp.

References m_DatabaseNameEnv.

◆ SetPasswordEnv()

void CDBEnvConnParams::SetPasswordEnv ( const string pwd)
inline

Definition at line 389 of file dbapi_driver_conn_params.hpp.

References m_PasswordEnv.

◆ SetServerNameEnv()

void CDBEnvConnParams::SetServerNameEnv ( const string name)
inline

Definition at line 377 of file dbapi_driver_conn_params.hpp.

References m_ServerNameEnv.

◆ SetUserNameEnv()

void CDBEnvConnParams::SetUserNameEnv ( const string name)
inline

Definition at line 385 of file dbapi_driver_conn_params.hpp.

References m_UserNameEnv.

Member Data Documentation

◆ m_DatabaseNameEnv

string CDBEnvConnParams::m_DatabaseNameEnv
private

Definition at line 408 of file dbapi_driver_conn_params.hpp.

Referenced by GetDatabaseName(), and SetDatabaseNameEnv().

◆ m_Env

const CNcbiEnvironment CDBEnvConnParams::m_Env
private

◆ m_PasswordEnv

string CDBEnvConnParams::m_PasswordEnv
private

Definition at line 410 of file dbapi_driver_conn_params.hpp.

Referenced by GetPassword(), and SetPasswordEnv().

◆ m_ServerNameEnv

string CDBEnvConnParams::m_ServerNameEnv
private

Definition at line 407 of file dbapi_driver_conn_params.hpp.

Referenced by GetServerName(), and SetServerNameEnv().

◆ m_UserNameEnv

string CDBEnvConnParams::m_UserNameEnv
private

Definition at line 409 of file dbapi_driver_conn_params.hpp.

Referenced by GetUserName(), and SetUserNameEnv().


The documentation for this class was generated from the following files:
Modified on Thu Jun 13 17:27:19 2024 by modify_doxy.py rev. 669887