NCBI C++ ToolKit
Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
CODBC_RPCCmd Class Reference

Search Toolkit Book for CODBC_RPCCmd

#include <dbapi/driver/odbc/interfaces.hpp>

+ Inheritance diagram for CODBC_RPCCmd:
+ Collaboration diagram for CODBC_RPCCmd:

Protected Member Functions

 CODBC_RPCCmd (CODBC_Connection &conn, const string &proc_name)
 
virtual ~CODBC_RPCCmd (void)
 
virtual CDBParamsGetBindParams (void)
 Binding. More...
 
virtual bool Send (void)
 Send command to the server. More...
 
virtual bool Cancel (void)
 Cancel the command execution. More...
 
virtual CDB_ResultResult (void)
 Get result set. More...
 
virtual bool HasMoreResults (void) const
 
virtual int RowCount (void) const
 Get the number of rows affected by the command Special case: negative on error or if there is no way that this command could ever affect any rows (like PRINT). More...
 
- Protected Member Functions inherited from CStatementBase
string Type2String (const CDB_Object &param) const
 
bool x_BindParam_ODBC (const CDB_Object &param, CMemPot &bind_guard, SQLLEN *indicator_base, unsigned int pos) const
 
SQLSMALLINT x_GetCType (const CDB_Object &param) const
 
SQLSMALLINT x_GetSQLType (const CDB_Object &param) const
 
SQLULEN x_GetMaxDataSize (const CDB_Object &param) const
 
SQLLEN x_GetCurDataSize (const CDB_Object &param) const
 
SQLLEN x_GetIndicator (const CDB_Object &param) const
 
SQLPOINTER x_GetData (const CDB_Object &param, CMemPot &bind_guard) const
 
- Protected Member Functions inherited from impl::CBaseCmd
void DetachInterface (void)
 
void SetRecompile (bool recompile=true)
 Set the "recompile before execute" flag for the stored proc. More...
 
bool NeedToRecompile (void) const
 
virtual void SetHasFailed (bool flag=true)
 
const CDB_ParamsGetBindParamsImpl (void) const
 
CDB_ParamsGetBindParamsImpl (void)
 
const CDB_ParamsGetDefineParamsImpl (void) const
 
CDB_ParamsGetDefineParamsImpl (void)
 
virtual CDB_ResultOpenCursor (void)
 Open the cursor. More...
 
virtual bool Update (const string &table_name, const string &upd_query)
 Update the last fetched row. More...
 
virtual bool UpdateBlob (unsigned int item_num, CDB_Stream &data, bool log_it=true)
 
virtual CDB_SendDataCmdSendDataCmd (unsigned int item_num, size_t size, bool log_it=true, bool dump_results=true)
 
virtual bool Delete (const string &table_name)
 Delete the last fetched row. More...
 
virtual bool CloseCursor (void)
 Close the cursor. More...
 
bool CursorIsOpen (void) const
 
void SetCursorOpen (bool flag=true)
 
bool CursorIsDeclared (void) const
 
void SetCursorDeclared (bool flag=true)
 
- Protected Member Functions inherited from impl::CCmdBase
void SetWasSent (bool flag=true)
 
impl::CConnectionGetConnImpl (void) const
 

Private Member Functions

bool x_AssignParams (string &cmd, string &q_exec, string &q_select, CMemPot &bind_guard, SQLLEN *indicator)
 
bool xCheck4MoreResults (void)
 

Private Attributes

bool m_HasStatus
 
bool m_HasMoreResults
 
impl::CResultm_Res
 
unique_ptr< CDBParamsm_InParams
 

Friends

class CODBC_Connection
 

Additional Inherited Members

- Public Member Functions inherited from CStatementBase
 CStatementBase (CODBC_Connection &conn, const string &query)
 
 CStatementBase (CODBC_Connection &conn, const string &cursor_name, const string &query)
 
 ~CStatementBase (void)
 
SQLHSTMT GetHandle (void) const
 
CODBC_ConnectionGetConnection (void)
 
const CODBC_ConnectionGetConnection (void) const
 
void SetDbgInfo (const string &msg)
 
const CODBC_Connection::TDbgInfoGetDbgInfo (void) const
 
void ReportErrors (void) const
 
void ReportError (CDB_Exception &ex) const
 
const CDBParamsGetBindParams (void) const
 
bool CheckRC (int rc) const
 
int CheckSIE (int rc, const char *msg, unsigned int msg_num) const
 
int CheckSIENd (int rc, const char *msg, unsigned int msg_num) const
 
bool Close (void) const
 
bool Unbind (void) const
 
bool ResetParams (void) const
 
bool IsMultibyteClientEncoding (void) const
 
EEncoding GetClientEncoding (void) const
 
- Public Member Functions inherited from impl::CBaseCmd
 CBaseCmd (impl::CConnection &conn, const string &query)
 
 CBaseCmd (impl::CConnection &conn, const string &cursor_name, const string &query)
 
virtual ~CBaseCmd (void)
 
bool WasCanceled (void) const
 
virtual bool HasFailed (void) const
 
void DumpResults (void)
 Dump the results of the command if result processor is installed for this connection, it will be called for each result set. More...
 
virtual CDBParamsGetDefineParams (void)
 Get meta-information about defined parameters. More...
 
const CDBParamsGetLastParams (void) const
 
bool More (const string &query_text)
 Add more text to the language command. More...
 
const stringGetQuery (void) const
 
string GetCmdName (void) const
 
virtual void SetHints (CTempString hints)
 Set hints by one call. More...
 
virtual void AddHint (CDB_BCPInCmd::EBCP_Hints hint, unsigned int value)
 Add hint with value. More...
 
virtual void AddOrderHint (CTempString columns)
 Add "ORDER" hint. More...
 
virtual bool CommitBCPTrans (void)
 Complete batch – to store all rows transferred by far in this batch into the table. More...
 
virtual bool EndBCP (void)
 Complete the BCP and store all rows transferred in last batch into the table. More...
 
unsigned int GetRowsInCurrentBatch (void) const
 
- Public Member Functions inherited from impl::CCmdBase
 CCmdBase (impl::CConnection &conn)
 
virtual ~CCmdBase ()
 
bool WasSent (void) const
 
- Public Member Functions inherited from impl::CCommand
virtual ~CCommand (void)
 
void Release (void)
 
- Static Public Member Functions inherited from impl::CCommand
static CDB_ResultCreate_Result (CResult &result)
 
- Protected Attributes inherited from CStatementBase
SQLLEN m_RowCount
 

Detailed Description

Definition at line 515 of file interfaces.hpp.

Constructor & Destructor Documentation

◆ CODBC_RPCCmd()

CODBC_RPCCmd::CODBC_RPCCmd ( CODBC_Connection conn,
const string proc_name 
)
protected

Definition at line 65 of file rpc.cpp.

References CStatementBase::SetDbgInfo().

◆ ~CODBC_RPCCmd()

CODBC_RPCCmd::~CODBC_RPCCmd ( void  )
protectedvirtual

Member Function Documentation

◆ Cancel()

bool CODBC_RPCCmd::Cancel ( void  )
protectedvirtual

Cancel the command execution.

Reimplemented from impl::CBaseCmd.

Definition at line 190 of file rpc.cpp.

References CStatementBase::Close(), m_Res, CStatementBase::ResetParams(), impl::CCmdBase::SetWasSent(), and impl::CCmdBase::WasSent().

Referenced by Send(), and ~CODBC_RPCCmd().

◆ GetBindParams()

CDBParams & CODBC_RPCCmd::GetBindParams ( void  )
protectedvirtual

Binding.

Get meta-information about binded parameters.

Reimplemented from CStatementBase.

Definition at line 78 of file rpc.cpp.

References impl::CBaseCmd::GetBindParamsImpl(), impl::CCmdBase::GetConnImpl(), impl::CBaseCmd::GetQuery(), m_InParams, and NULL.

◆ HasMoreResults()

bool CODBC_RPCCmd::HasMoreResults ( void  ) const
protectedvirtual

Reimplemented from impl::CBaseCmd.

Definition at line 285 of file rpc.cpp.

References m_HasMoreResults.

◆ Result()

CDB_Result * CODBC_RPCCmd::Result ( void  )
protectedvirtual

◆ RowCount()

int CODBC_RPCCmd::RowCount ( void  ) const
protectedvirtual

Get the number of rows affected by the command Special case: negative on error or if there is no way that this command could ever affect any rows (like PRINT).

Reimplemented from CStatementBase.

Definition at line 291 of file rpc.cpp.

References CStatementBase::m_RowCount.

◆ Send()

bool CODBC_RPCCmd::Send ( void  )
protectedvirtual

◆ x_AssignParams()

bool CODBC_RPCCmd::x_AssignParams ( string cmd,
string q_exec,
string q_select,
CMemPot bind_guard,
SQLLEN indicator 
)
private

◆ xCheck4MoreResults()

bool CODBC_RPCCmd::xCheck4MoreResults ( void  )
private

Friends And Related Function Documentation

◆ CODBC_Connection

friend class CODBC_Connection
friend

Definition at line 518 of file interfaces.hpp.

Member Data Documentation

◆ m_HasMoreResults

bool CODBC_RPCCmd::m_HasMoreResults
private

Definition at line 540 of file interfaces.hpp.

Referenced by HasMoreResults(), Result(), and Send().

◆ m_HasStatus

bool CODBC_RPCCmd::m_HasStatus
private

Definition at line 539 of file interfaces.hpp.

Referenced by Result(), and Send().

◆ m_InParams

unique_ptr<CDBParams> CODBC_RPCCmd::m_InParams
private

Definition at line 543 of file interfaces.hpp.

Referenced by GetBindParams().

◆ m_Res

impl::CResult* CODBC_RPCCmd::m_Res
private

Definition at line 541 of file interfaces.hpp.

Referenced by Cancel(), and Result().


The documentation for this class was generated from the following files:
Modified on Sat May 25 14:17:14 2024 by modify_doxy.py rev. 669887