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

Search Toolkit Book for CTL_LangCmd

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

+ Inheritance diagram for CTL_LangCmd:
+ Collaboration diagram for CTL_LangCmd:

Protected Member Functions

 CTL_LangCmd (CTL_Connection &conn, const string &lang_query)
 
virtual ~CTL_LangCmd (void)
 
void Close (void)
 
virtual bool Send (void)
 Send command to the server. 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 CTL_LRCmd
CS_RETCODE CheckSFB (CS_RETCODE rc, const char *msg, unsigned int msg_num)
 
bool SendInternal (void)
 
bool x_Cancel (ECancelType cancel_type) override
 
- Protected Member Functions inherited from CTL_Cmd
CS_COMMANDx_GetSybaseCmd (void) const
 
void SetSybaseCmd (CS_COMMAND *cmd)
 
bool AssignCmdParam (CDB_Object &param, const string &param_name, CS_DATAFMT &param_fmt, bool declare_only=false)
 
void GetRowCount (int *cnt)
 
CTL_RowResultGetResult (void)
 
void DeleteResult (void)
 
void DeleteResultInternal (void)
 
void MarkEndOfReply (void)
 
bool HaveResult (void) const
 
void SetResult (CTL_RowResult *result)
 
CTL_RowResultMakeCursorResult (void)
 
CTL_RowResultMakeRowResult (void)
 
CTL_RowResultMakeParamResult (void)
 
CTL_RowResultMakeComputeResult (void)
 
CTL_RowResultMakeStatusResult (void)
 
bool ProcessResultInternal (CDB_Result &res)
 
bool ProcessResultInternal (CS_INT res_type)
 
CS_RETCODE CheckSFB_Internal (CS_RETCODE rc, const char *msg, unsigned int msg_num)
 
void DropSybaseCmd (void)
 
- Protected Member Functions inherited from CTL_CmdBase
CS_RETCODE Check (CS_RETCODE rc)
 
CTL_ConnectionGetConnection (void)
 
const CTL_ConnectionGetConnection (void) const
 
void DropCmd (impl::CCommand &cmd)
 
bool x_SendData (I_BlobDescriptor &desc, CDB_Stream &img, bool log_it=true)
 
CDB_SendDataCmdConnSendDataCmd (I_BlobDescriptor &desc, size_t data_size, bool log_it=true, bool dump_results=true)
 
bool IsMultibyteClientEncoding (void) const
 
EEncoding GetClientEncoding (void) const
 
void SetExecCntxInfo (const string &info)
 
const stringGetExecCntxInfo (void) const
 
bool IsDead (void) const
 
void SetDead (bool flag=true)
 
void CheckIsDead (void)
 
virtual void SetHasFailed (bool flag=true)
 
const TDbgInfoGetDbgInfo (void) const
 
bool GetTimedOut (void) const
 
void SetTimedOut (bool val)
 
ERetriable GetRetriable (void) const
 
void SetRetriable (ERetriable val)
 
void EnsureActiveStatus (void)
 
- 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
 
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 (void)
 
CTempString x_GetDynamicID (void)
 

Private Attributes

string m_DynamicID
 

Friends

class CTL_Connection
 
class CTL_CursorCmdExpl
 
class CTL_CursorResultExpl
 
struct default_delete< CTL_LangCmd >
 

Additional Inherited Members

- Public Member Functions inherited from CTL_LRCmd
 CTL_LRCmd (CTL_Connection &conn, const string &query)
 
virtual ~CTL_LRCmd (void)
 
CTL_RowResultMakeResultInternal (void)
 
CDB_ResultMakeResult (void)
 
bool Cancel (void) override
 Cancel the command execution. More...
 
- Public Member Functions inherited from CTL_Cmd
 CTL_Cmd (CTL_Connection &conn, const string &query)
 
 CTL_Cmd (CTL_Connection &conn, const string &cursor_name, const string &query)
 
virtual ~CTL_Cmd (void)
 
- Public Member Functions inherited from CTL_CmdBase
 CTL_CmdBase (CTL_Connection &conn, const string &query)
 
 CTL_CmdBase (CTL_Connection &conn, const string &cursor_name, const string &query)
 
virtual ~CTL_CmdBase (void)
 
- 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 CDBParamsGetBindParams (void)
 Binding. 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 Types inherited from CTL_CmdBase
enum  ECancelType { eAsyncCancel = CS_CANCEL_ATTN , eSyncCancel = CS_CANCEL_ALL }
 
typedef CTL_Connection::TDbgInfo TDbgInfo
 
- Protected Attributes inherited from CTL_CmdBase
int m_RowCount
 
CRef< TDbgInfom_DbgInfo
 

Detailed Description

Definition at line 847 of file interfaces.hpp.

Constructor & Destructor Documentation

◆ CTL_LangCmd()

CTL_LangCmd::CTL_LangCmd ( CTL_Connection conn,
const string lang_query 
)
protected

Definition at line 986 of file lang_cmd.cpp.

References CTL_CmdBase::SetExecCntxInfo().

◆ ~CTL_LangCmd()

CTL_LangCmd::~CTL_LangCmd ( void  )
protectedvirtual

Member Function Documentation

◆ Close()

void CTL_LangCmd::Close ( void  )
protected

◆ HasMoreResults()

bool CTL_LangCmd::HasMoreResults ( void  ) const
protectedvirtual

Reimplemented from impl::CBaseCmd.

Definition at line 1033 of file lang_cmd.cpp.

References impl::CCmdBase::WasSent().

Referenced by CTL_CursorResultExpl::Fetch(), x_GetDynamicID(), and ~CTL_LangCmd().

◆ Result()

CDB_Result * CTL_LangCmd::Result ( void  )
protectedvirtual

Get result set.

Reimplemented from impl::CBaseCmd.

Definition at line 1028 of file lang_cmd.cpp.

References CTL_LRCmd::MakeResult().

Referenced by CTL_CursorResultExpl::Fetch(), x_GetDynamicID(), and ~CTL_LangCmd().

◆ RowCount()

int CTL_LangCmd::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).

Implements impl::CBaseCmd.

Definition at line 1039 of file lang_cmd.cpp.

References CTL_CmdBase::m_RowCount.

◆ Send()

bool CTL_LangCmd::Send ( void  )
protectedvirtual

◆ x_AssignParams()

bool CTL_LangCmd::x_AssignParams ( void  )
private

◆ x_GetDynamicID()

CTempString CTL_LangCmd::x_GetDynamicID ( void  )
private

Friends And Related Function Documentation

◆ CTL_Connection

friend class CTL_Connection
friend

Definition at line 849 of file interfaces.hpp.

◆ CTL_CursorCmdExpl

friend class CTL_CursorCmdExpl
friend

Definition at line 850 of file interfaces.hpp.

◆ CTL_CursorResultExpl

friend class CTL_CursorResultExpl
friend

Definition at line 851 of file interfaces.hpp.

◆ default_delete< CTL_LangCmd >

friend struct default_delete< CTL_LangCmd >
friend

Definition at line 851 of file interfaces.hpp.

Member Data Documentation

◆ m_DynamicID

string CTL_LangCmd::m_DynamicID
private

Definition at line 871 of file interfaces.hpp.

Referenced by x_GetDynamicID(), and ~CTL_LangCmd().


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