开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 数值算法/人工智能 > 生物技术 > 查看源码
interfaces.hpp
资源名称：ncbi_cxx_win--Jul_08_2004.zip　[点击查看]
上传用户：yhdzpy8989
上传日期：2007-06-13
资源大小：13604k
文件大小：18k
源码类别：

生物技术

开发平台：

C/C++

interfaces.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: interfaces.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/04/21 14:47:31  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.7
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef DBAPI_DRIVER_ODBC___INTERFACES__HPP
  11. #define DBAPI_DRIVER_ODBC___INTERFACES__HPP
  13. /* $Id: interfaces.hpp,v 1000.1 2004/04/21 14:47:31 gouriano Exp $
  14.  * ===========================================================================
  15.  *
  16.  *                            PUBLIC DOMAIN NOTICE
  17.  *               National Center for Biotechnology Information
  18.  *
  19.  *  This software/database is a "United States Government Work" under the
  20.  *  terms of the United States Copyright Act.  It was written as part of
  21.  *  the author's official duties as a United States Government employee and
  22.  *  thus cannot be copyrighted.  This software/database is freely available
  23.  *  to the public for use. The National Library of Medicine and the U.S.
  24.  *  Government have not placed any restriction on its use or reproduction.
  25.  *
  26.  *  Although all reasonable efforts have been taken to ensure the accuracy
  27.  *  and reliability of the software and data, the NLM and the U.S.
  28.  *  Government do not and cannot warrant the performance or results that
  29.  *  may be obtained by using this software or data. The NLM and the U.S.
  30.  *  Government disclaim all warranties, express or implied, including
  31.  *  warranties of performance, merchantability or fitness for any particular
  32.  *  purpose.
  33.  *
  34.  *  Please cite the author in any work or product based on this material.
  35.  *
  36.  * ===========================================================================
  37.  *
  38.  * Author:  Vladimir Soussov
  39.  *
  40.  * File Description:  Driver for MS-SQL server (odbc version)
  41.  *
  42.  */
  44. #include <dbapi/driver/public.hpp>
  45. #include <dbapi/driver/util/parameters.hpp>
  46. #ifdef NCBI_OS_MSWIN
  47. #include <windows.h>
  48. #endif
  49. #include <sql.h>
  50. #include <sqlext.h>
  51. #include <sqltypes.h>
  54. BEGIN_NCBI_SCOPE
  56. class CODBCContext;
  57. class CODBC_Connection;
  58. class CODBC_LangCmd;
  59. class CODBC_RPCCmd;
  60. class CODBC_CursorCmd;
  61. class CODBC_BCPInCmd;
  62. class CODBC_SendDataCmd;
  63. class CODBC_RowResult;
  64. class CODBC_ParamResult;
  65. class CODBC_ComputeResult;
  66. class CODBC_StatusResult;
  69. /////////////////////////////////////////////////////////////////////////////
  70. //
  71. //  CODBC_Reporter::
  72. //
  73. class NCBI_DBAPIDRIVER_ODBC_EXPORT CODBC_Reporter
  74. {
  75. public:
  76.     CODBC_Reporter(CDBHandlerStack* hs, SQLSMALLINT ht, SQLHANDLE h) :
  77.         m_HStack(hs), m_HType(ht), m_Handle(h) {}
  78.     void ReportErrors();
  79.     void SetHandlerStack(CDBHandlerStack* hs) {
  80.         m_HStack= hs;
  81.     }
  82.     void SetHandle(SQLHANDLE h) {
  83.         m_Handle= h;
  84.     }
  85. void SetHandleType(SQLSMALLINT ht) {
  86. m_HType= ht;
  87. }
  88. private:
  89.     CODBC_Reporter();
  90.     CDBHandlerStack* m_HStack;
  91.     SQLHANDLE m_Handle;
  92.     SQLSMALLINT m_HType;
  93. };
  96. /////////////////////////////////////////////////////////////////////////////
  97. //
  98. //  CODBCContext::
  99. //
  101. class NCBI_DBAPIDRIVER_ODBC_EXPORT CODBCContext : public I_DriverContext
  102. {
  103.     friend class CDB_Connection;
  105. public:
  106.     CODBCContext(SQLINTEGER version = SQL_OV_ODBC3, bool use_dsn= false);
  108.     //
  109.     // GENERIC functionality (see in <dbapi/driver/interfaces.hpp>)
  110.     //
  112.     virtual bool SetLoginTimeout (unsigned int nof_secs = 0);
  113.     virtual bool SetTimeout      (unsigned int nof_secs = 0);
  114.     virtual bool SetMaxTextImageSize(size_t nof_bytes);
  116.     virtual CDB_Connection* Connect(const string&   srv_name,
  117.                                     const string&   user_name,
  118.                                     const string&   passwd,
  119.                                     TConnectionMode mode,
  120.                                     bool            reusable  = false,
  121.                                     const string&   pool_name = kEmptyStr);
  123.     virtual bool IsAbleTo(ECapability cpb) const {return false;}
  125.     virtual ~CODBCContext();
  128.     //
  129.     // ODBC specific functionality
  130.     //
  132.     // the following methods are optional (driver will use the default values
  133.     // if not called), the values will affect the new connections only
  135.     virtual void ODBC_SetPacketSize(SQLUINTEGER packet_size);
  137.     virtual SQLHENV ODBC_GetContext() const;
  140. private:
  141.     SQLHENV     m_Context;
  142.     SQLUINTEGER m_PacketSize;
  143.     SQLUINTEGER m_LoginTimeout;
  144.     SQLUINTEGER m_Timeout;
  145.     SQLUINTEGER m_TextImageSize;
  146.     CODBC_Reporter m_Reporter;
  147.     bool m_UseDSN;
  149.     SQLHDBC x_ConnectToServer(const string&   srv_name,
  150.        const string&   usr_name,
  151.        const string&   passwd,
  152.        TConnectionMode mode);
  153.     void xReportConError(SQLHDBC con);
  154. };
  158. /////////////////////////////////////////////////////////////////////////////
  159. //
  160. //  CODBC_Connection::
  161. //
  163. class NCBI_DBAPIDRIVER_ODBC_EXPORT CODBC_Connection : public I_Connection
  164. {
  165.     friend class CODBCContext;
  166.     friend class CDB_Connection;
  167.     friend class CODBC_LangCmd;
  168.     friend class CODBC_RPCCmd;
  169.     friend class CODBC_CursorCmd;
  170.     friend class CODBC_BCPInCmd;
  171.     friend class CODBC_SendDataCmd;
  173. protected:
  174.     CODBC_Connection(CODBCContext* cntx, SQLHDBC con,
  175.      bool reusable, const string& pool_name);
  177.     virtual bool IsAlive();
  179.     virtual CDB_LangCmd*     LangCmd     (const string&   lang_query,
  180.                                           unsigned int    nof_params = 0);
  181.     virtual CDB_RPCCmd*      RPC         (const string&   rpc_name,
  182.                                           unsigned int    nof_args);
  183.     virtual CDB_BCPInCmd*    BCPIn       (const string&   table_name,
  184.                                           unsigned int    nof_columns);
  185.     virtual CDB_CursorCmd*   Cursor      (const string&   cursor_name,
  186.                                           const string&   query,
  187.                                           unsigned int    nof_params,
  188.                                           unsigned int    batch_size = 1);
  189.     virtual CDB_SendDataCmd* SendDataCmd (I_ITDescriptor& desc,
  190.                                           size_t          data_size,
  191.                                           bool            log_it = true);
  193.     virtual bool SendData(I_ITDescriptor& desc, CDB_Image& img,
  194.                           bool log_it = true);
  195.     virtual bool SendData(I_ITDescriptor& desc, CDB_Text&  txt,
  196.                           bool log_it = true);
  197.     virtual bool Refresh();
  198.     virtual const string& ServerName() const;
  199.     virtual const string& UserName()   const;
  200.     virtual const string& Password()   const;
  201.     virtual I_DriverContext::TConnectionMode ConnectMode() const;
  202.     virtual bool IsReusable() const;
  203.     virtual const string& PoolName() const;
  204.     virtual I_DriverContext* Context() const;
  205.     virtual void PushMsgHandler(CDB_UserHandler* h);
  206.     virtual void PopMsgHandler (CDB_UserHandler* h);
  207.     virtual CDB_ResultProcessor* SetResultProcessor(CDB_ResultProcessor* rp);
  208.     virtual void Release();
  210.     virtual ~CODBC_Connection();
  212.     void ODBC_SetTimeout(SQLUINTEGER nof_secs);
  213.     void ODBC_SetTextImageSize(SQLUINTEGER nof_bytes);
  215.     void DropCmd(CDB_BaseEnt& cmd);
  217.     CODBC_LangCmd* xLangCmd(const string&   lang_query,
  218.                             unsigned int    nof_params = 0);
  220. private:
  221.     bool x_SendData(SQLHSTMT cmd, CDB_Stream& stream, CODBC_Reporter& rep);
  223.     SQLHDBC         m_Link;
  224.     
  225.     CODBCContext*   m_Context;
  226.     CPointerPot     m_CMDs;
  227.     CDBHandlerStack m_MsgHandlers;
  228.     string          m_Server;
  229.     string          m_User;
  230.     string          m_Passwd;
  231.     string          m_Pool;
  232.     CODBC_Reporter  m_Reporter;
  233.     bool            m_Reusable;
  234.     bool            m_BCPable;
  235.     bool            m_SecureLogin;
  236.     CDB_ResultProcessor* m_ResProc;
  237. };
  241. /////////////////////////////////////////////////////////////////////////////
  242. //
  243. //  CODBC_LangCmd::
  244. //
  246. class NCBI_DBAPIDRIVER_ODBC_EXPORT CODBC_LangCmd : public I_LangCmd
  247. {
  248.     friend class CODBC_Connection;
  249.     friend class CODBC_CursorCmd;
  250. friend class CODBC_CursorResult;
  251. protected:
  252.     CODBC_LangCmd(CODBC_Connection* conn, SQLHSTMT cmd,
  253.   const string& lang_query, unsigned int nof_params);
  255.     virtual bool More(const string& query_text);
  256.     virtual bool BindParam(const string& param_name, CDB_Object* param_ptr);
  257.     virtual bool SetParam(const string& param_name, CDB_Object* param_ptr);
  258.     virtual bool Send();
  259.     virtual bool WasSent() const;
  260.     virtual bool Cancel();
  261.     virtual bool WasCanceled() const;
  262.     virtual CDB_Result* Result();
  263.     virtual bool HasMoreResults() const;
  264.     virtual bool HasFailed() const;
  265.     virtual int  RowCount() const;
  266.     virtual void DumpResults();
  267.     virtual void Release();
  269.     virtual ~CODBC_LangCmd();
  271. private:
  272.     bool x_AssignParams(string& cmd, CMemPot& bind_guard, SQLINTEGER* indicator);
  273.     bool xCheck4MoreResults();
  275.     CODBC_Connection* m_Connect;
  276.     SQLHSTMT          m_Cmd;
  277.     string            m_Query;
  278.     CDB_Params        m_Params;
  279.     CODBC_RowResult*  m_Res;
  280.     CODBC_Reporter    m_Reporter;
  281.     int               m_RowCount;
  282.     bool              m_hasResults;
  283.     bool              m_WasSent;
  284.     bool              m_HasFailed;
  285. };
  288. /////////////////////////////////////////////////////////////////////////////
  289. //
  290. //  CODBC_RPCCmd::
  291. //
  293. class NCBI_DBAPIDRIVER_ODBC_EXPORT CODBC_RPCCmd : public I_RPCCmd
  294. {
  295.     friend class CODBC_Connection;
  296. protected:
  297.     CODBC_RPCCmd(CODBC_Connection* con, SQLHSTMT cmd,
  298.                const string& proc_name, unsigned int nof_params);
  300.     virtual bool BindParam(const string& param_name, CDB_Object* param_ptr,
  301.                            bool out_param = false);
  302.     virtual bool SetParam(const string& param_name, CDB_Object* param_ptr,
  303.                           bool out_param = false);
  304.     virtual bool Send();
  305.     virtual bool WasSent() const;
  306.     virtual bool Cancel();
  307.     virtual bool WasCanceled() const;
  308.     virtual CDB_Result* Result();
  309.     virtual bool HasMoreResults() const;
  310.     virtual bool HasFailed() const;
  311.     virtual int  RowCount() const;
  312.     virtual void DumpResults();
  313.     virtual void SetRecompile(bool recompile = true);
  314.     virtual void Release();
  316.     virtual ~CODBC_RPCCmd();
  318. private:
  319.     bool x_AssignParams(string& cmd, string& q_exec, string& q_select,
  320. CMemPot& bind_guard, SQLINTEGER* indicator);
  321.     bool xCheck4MoreResults();
  323.     CODBC_Connection* m_Connect;
  324.     SQLHSTMT          m_Cmd;
  325.     string            m_Query;
  326.     CDB_Params        m_Params;
  327.     CODBC_Reporter    m_Reporter;
  328.     bool              m_WasSent;
  329.     bool              m_HasFailed;
  330.     bool              m_Recompile;
  331.     bool              m_HasStatus;
  332. bool              m_hasResults;
  333.     I_Result*         m_Res;
  334.     int               m_RowCount;
  335. };
  338. /////////////////////////////////////////////////////////////////////////////
  339. //
  340. //  CODBC_CursorCmd::
  341. //
  343. class NCBI_DBAPIDRIVER_ODBC_EXPORT CODBC_CursorCmd : public I_CursorCmd
  344. {
  345.     friend class CODBC_Connection;
  346. protected:
  347.     CODBC_CursorCmd(CODBC_Connection* conn, SQLHSTMT cmd,
  348.                   const string& cursor_name, const string& query,
  349.                   unsigned int nof_params);
  351.     virtual bool BindParam(const string& param_name, CDB_Object* param_ptr);
  352.     virtual CDB_Result* Open();
  353.     virtual bool Update(const string& table_name, const string& upd_query);
  354.     virtual bool UpdateTextImage(unsigned int item_num, CDB_Stream& data, 
  355.  bool log_it = true);
  356.     virtual CDB_SendDataCmd* SendDataCmd(unsigned int item_num, size_t size, 
  357.  bool log_it = true);
  358.     virtual bool Delete(const string& table_name);
  359.     virtual int  RowCount() const;
  360.     virtual bool Close();
  361.     virtual void Release();
  363.     virtual ~CODBC_CursorCmd();
  365. private:
  366.     bool x_AssignParams(bool just_declare = false);
  367.     CDB_ITDescriptor* x_GetITDescriptor(unsigned int item_num);
  369.     CODBC_LangCmd m_CursCmd;
  370.     CODBC_LangCmd* m_LCmd;
  372.     CODBC_Connection* m_Connect;
  373.     string          m_Name;
  374.     unsigned int    m_FetchSize;
  375.     bool            m_IsOpen;
  376.     bool            m_IsDeclared;
  377.     bool            m_HasFailed;
  378.     I_Result*       m_Res;
  379.     int             m_RowCount;
  380. };
  385. /////////////////////////////////////////////////////////////////////////////
  386. //
  387. //  CODBC_BCPInCmd::
  388. //
  390. class NCBI_DBAPIDRIVER_ODBC_EXPORT CODBC_BCPInCmd : public I_BCPInCmd
  391. {
  392.     friend class CODBC_Connection;
  393. protected:
  394.     CODBC_BCPInCmd(CODBC_Connection* con, SQLHDBC cmd,
  395.                  const string& table_name, unsigned int nof_columns);
  397.     virtual bool Bind(unsigned int column_num, CDB_Object* param_ptr);
  398.     virtual bool SendRow();
  399.     virtual bool CompleteBatch();
  400.     virtual bool Cancel();
  401.     virtual bool CompleteBCP();
  402.     virtual void Release();
  404.     virtual ~CODBC_BCPInCmd();
  406. private:
  407.     bool x_AssignParams(void* p);
  409.     CODBC_Connection* m_Connect;
  410.     SQLHDBC     m_Cmd;
  411.     string          m_Query;
  412.     CDB_Params      m_Params;
  413.     bool            m_WasSent;
  414.     bool            m_HasFailed;
  415. bool            m_WasBound;
  416. bool            m_HasTextImage;
  418.     CODBC_Reporter  m_Reporter;
  419. };
  422. /////////////////////////////////////////////////////////////////////////////
  423. //
  424. //  CODBC_SendDataCmd::
  425. //
  427. class NCBI_DBAPIDRIVER_ODBC_EXPORT CODBC_SendDataCmd : public I_SendDataCmd
  428. {
  429.     friend class CODBC_Connection;
  430. protected:
  431.     CODBC_SendDataCmd(CODBC_Connection* con, SQLHSTMT cmd, CDB_ITDescriptor& descr, 
  432.                       size_t nof_bytes, bool logit);
  434.     virtual size_t SendChunk(const void* chunk_ptr, size_t nof_bytes);
  435.     virtual void   Release();
  437.     virtual ~CODBC_SendDataCmd();
  439. private:
  440.     void xCancel();
  441.     CODBC_Connection* m_Connect;
  442.     SQLHSTMT          m_Cmd;
  443.     CODBC_Reporter    m_Reporter;
  444.     size_t            m_Bytes2go;
  445. };
  448. /////////////////////////////////////////////////////////////////////////////
  449. //
  450. //  CODBC_RowResult::
  451. //
  453. class NCBI_DBAPIDRIVER_ODBC_EXPORT CODBC_RowResult : public I_Result
  454. {
  455.     friend class CODBC_LangCmd;
  456.     friend class CODBC_RPCCmd;
  457.     friend class CODBC_CursorCmd;
  458.     friend class CODBC_Connection;
  459. protected:
  460.     CODBC_RowResult(SQLSMALLINT nof_cols, SQLHSTMT cmd, CODBC_Reporter& r);
  462.     virtual EDB_ResType     ResultType() const;
  463.     virtual unsigned int    NofItems() const;
  464.     virtual const char*     ItemName    (unsigned int item_num) const;
  465.     virtual size_t          ItemMaxSize (unsigned int item_num) const;
  466.     virtual EDB_Type        ItemDataType(unsigned int item_num) const;
  467.     virtual bool            Fetch();
  468.     virtual int             CurrentItemNo() const;
  469.     virtual CDB_Object*     GetItem(CDB_Object* item_buf = 0);
  470.     virtual size_t          ReadItem(void* buffer, size_t buffer_size,
  471.                                      bool* is_null = 0);
  472.     virtual I_ITDescriptor* GetImageOrTextDescriptor();
  473.     CDB_ITDescriptor* GetImageOrTextDescriptor(int item_no, 
  474.                                                const string& cond);
  475.     virtual bool            SkipItem();
  477.     virtual ~CODBC_RowResult();
  479. int xGetData(SQLSMALLINT target_type, SQLPOINTER buffer, 
  480. SQLINTEGER buffer_size);
  481.     CDB_Object* xLoadItem(CDB_Object* item_buf);
  482.     CDB_Object* xMakeItem();
  483.     // data
  484.     SQLHSTMT          m_Cmd;
  485.     // CODBC_Connection* m_Connect;
  486.     int               m_CurrItem;
  487.     bool              m_EOR;
  488.     unsigned int      m_NofCols;
  489.     unsigned int      m_CmdNum;
  490. #define ODBC_COLUMN_NAME_SIZE 80
  491.     typedef struct t_SODBC_ColDescr {
  492.         SQLCHAR     ColumnName[ODBC_COLUMN_NAME_SIZE];
  493.         SQLUINTEGER ColumnSize;
  494.         SQLSMALLINT DataType;
  495.         SQLSMALLINT DecimalDigits;
  496.     } SODBC_ColDescr;
  497.     
  498.     SODBC_ColDescr* m_ColFmt;
  499.     CODBC_Reporter& m_Reporter;
  500. };
  504. /////////////////////////////////////////////////////////////////////////////
  505. //
  506. //  CODBC_ParamResult::
  507. //  CODBC_ComputeResult::
  508. //  CODBC_StatusResult::
  509. //  CODBC_CursorResult::
  510. //
  512. class NCBI_DBAPIDRIVER_ODBC_EXPORT CODBC_StatusResult :  public CODBC_RowResult
  513. {
  514.     friend class CODBC_RPCCmd;
  515.     friend class CODBC_Connection;
  516. protected:
  517.     CODBC_StatusResult(SQLHSTMT cmd, CODBC_Reporter& r) :
  518.         CODBC_RowResult(1, cmd, r){}
  519.     virtual EDB_ResType ResultType() const;
  520.     virtual ~CODBC_StatusResult();
  521. };
  523. class NCBI_DBAPIDRIVER_ODBC_EXPORT CODBC_ParamResult :  public CODBC_RowResult
  524. {
  525.     friend class CODBC_RPCCmd;
  526.     friend class CODBC_Connection;
  527. protected:
  528.     CODBC_ParamResult(SQLSMALLINT nof_cols, SQLHSTMT cmd, CODBC_Reporter& r) :
  529.         CODBC_RowResult(nof_cols, cmd, r){}
  530.     virtual EDB_ResType ResultType() const;
  531.     virtual ~CODBC_ParamResult();
  532. };
  534. class NCBI_DBAPIDRIVER_ODBC_EXPORT CODBC_CursorResult : public I_Result
  535. {
  536.     friend class CODBC_CursorCmd;
  537. protected:
  538.     CODBC_CursorResult(CODBC_LangCmd* cmd);
  539.     virtual EDB_ResType     ResultType() const;
  540.     virtual unsigned int    NofItems() const;
  541.     virtual const char*     ItemName    (unsigned int item_num) const;
  542.     virtual size_t          ItemMaxSize (unsigned int item_num) const;
  543.     virtual EDB_Type        ItemDataType(unsigned int item_num) const;
  544.     virtual bool            Fetch();
  545.     virtual int             CurrentItemNo() const;
  546.     virtual CDB_Object*     GetItem(CDB_Object* item_buff = 0);
  547.     virtual size_t          ReadItem(void* buffer, size_t buffer_size,
  548.                                      bool* is_null = 0);
  549.     virtual I_ITDescriptor* GetImageOrTextDescriptor();
  550.     virtual bool            SkipItem();
  552.     virtual ~CODBC_CursorResult();
  554.     // data
  555.     CODBC_LangCmd* m_Cmd;
  556.     CDB_Result*  m_Res;
  557. bool m_EOR;
  558. };
  561. END_NCBI_SCOPE
  564. #endif  /* DBAPI_DRIVER_ODBC___INTERFACES__HPP */
  568. /*
  569.  * ===========================================================================
  570.  * $Log: interfaces.hpp,v $
  571.  * Revision 1000.1  2004/04/21 14:47:31  gouriano
  572.  * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.7
  573.  *
  574.  * Revision 1.7  2003/07/17 20:43:17  soussov
  575.  * connections pool improvements
  576.  *
  577.  * Revision 1.6  2003/06/06 18:43:15  soussov
  578.  * Removes SetPacketSize()
  579.  *
  580.  * Revision 1.5  2003/06/05 15:57:02  soussov
  581.  * adds DumpResults method for LangCmd and RPC, SetResultProcessor method for Connection interface
  582.  *
  583.  * Revision 1.4  2003/05/05 20:45:51  ucko
  584.  * Lowercase header names for compatibility with Unix.
  585.  *
  586.  * Revision 1.3  2003/02/13 15:43:44  ivanov
  587.  * Added export specifier NCBI_DBAPIDRIVER_ODBC_EXPORT for class definitions
  588.  *
  589.  * Revision 1.2  2002/07/03 21:48:08  soussov
  590.  * adds DSN support if needed
  591.  *
  592.  * Revision 1.1  2002/06/18 22:00:53  soussov
  593.  * initial commit
  594.  *
  595.  * ===========================================================================
  596.  */