include/wx/dbtable.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        dbtable.h
   3 // Purpose:     Declaration of the wxTable class.
   4 // Author:      Doug Card
   5 // Modified by: George Tasker
   6 // Created:     9.96
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1996 Remstar International, Inc.
   9 // Licence:     wxWindows licence, plus:
  10 // Notice:              This class library and its intellectual design are free of charge for use,
  11 //              modification, enhancement, debugging under the following conditions:
  12 //              1) These classes may only be used as part of the implementation of a
  13 //                 wxWindows-based application
  14 //              2) All enhancements and bug fixes are to be submitted back to the wxWindows
  15 //                 user groups free of all charges for use with the wxWindows library.
  16 //              3) These classes may not be distributed as part of any other class library,
  17 //                 DLL, text (written or electronic), other than a complete distribution of
  18 //                 the wxWindows GUI development toolkit.
  19 ///////////////////////////////////////////////////////////////////////////////
  20
  21 /*
  22 // SYNOPSIS START
  23 // SYNOPSIS STOP
  24 */
  25
  26 #ifndef DBTABLE_DOT_H
  27 #define DBTABLE_DOT_H
  28
  29 // Use this line for wxWindows v1.x
  30 //#include "wx_ver.h"
  31 // Use this line for wxWindows v2.x
  32 #include "wx/version.h"
  33
  34 #if wxMAJOR_VERSION == 2
  35         #ifdef __GNUG__
  36         #pragma interface "dbtable.h"
  37         #endif
  38 #endif
  39
  40 #if wxMAJOR_VERSION == 2
  41         #include "wx/db.h"
  42 #else
  43         #include "db.h"
  44 #endif
  45
  46 const int       ROWID_LEN                       = 24;  // 18 is the max, 24 is in case it gets larger
  47 const int       DEFAULT_CURSOR          = 0;
  48 const bool      QUERY_ONLY                      = TRUE;
  49 const bool  DISABLE_VIEW                = TRUE;
  50
  51 // The following class is used to define a column of a table.
  52 // The wxTable constructor will dynamically allocate as many of
  53 // these as there are columns in the table.  The class derived
  54 // from wxTable must initialize these column definitions in it's
  55 // constructor.  These column definitions provide inf. to the
  56 // wxTable class which allows it to create a table in the data
  57 // source, exchange data between the data source and the C++
  58 // object, and so on.
  59 class WXDLLEXPORT wxColDef
  60 {
  61 public:
  62         char    ColName[DB_MAX_COLUMN_NAME_LEN+1];      // Column Name
  63         int     DbDataType;                                                                     // Logical Data Type; e.g. DB_DATA_TYPE_INTEGER
  64         int     SqlCtype;                                                                               // C data type; e.g. SQL_C_LONG
  65         void   *PtrDataObj;                                                                     // Address of the data object
  66         int       SzDataObj;                                                                    // Size, in bytes, of the data object
  67         bool      KeyField;                                                                             // TRUE if this column is part of the PRIMARY KEY to the table; Date fields should NOT be KeyFields.
  68         bool      Updateable;                                                                   // Specifies whether this column is updateable
  69         bool    InsertAllowed;                                                          // Specifies whether this column should be included in an INSERT statement
  70         bool    DerivedCol;                                                                     // Specifies whether this column is a derived value
  71         SDWORD  CbValue;                                                                                // Internal use only!!!
  72         bool      Null;                                                                                 // NOT FULLY IMPLEMENTED - Allows NULL values in Inserts and Updates
  73 };  // wxColDef
  74
  75 class WXDLLEXPORT wxColDataPtr
  76 {
  77 public:
  78         void    *PtrDataObj;
  79         int      SzDataObj;
  80         int      SqlCtype;
  81 };  // wxColDataPtr
  82
  83
  84 // Backward compability for Remstar classes.  These
  85 // will eventually go away, so the wxColXxxx classes
  86 // should be used
  87 typedef wxColDef                CcolDef;
  88 typedef wxColDataPtr CcolDataPtr;
  89
  90
  91 // This structure is used when creating secondary indexes.
  92 class WXDLLEXPORT CidxDef
  93 {
  94 public:
  95         char ColName[DB_MAX_COLUMN_NAME_LEN+1];
  96         bool Ascending;
  97 };  // CidxDef
  98
  99 class WXDLLEXPORT wxTable
 100 {
 101 private:
 102
 103         ULONG   tableID;  // Used for debugging.  This can help to match up mismatched constructors/destructors
 104
 105         // Private member variables
 106         UDWORD cursorType;
 107
 108         // Private member functions
 109         bool bindInsertParams(void);
 110         bool bindUpdateParams(void);
 111         bool bindCols(HSTMT cursor);
 112         bool getRec(UWORD fetchType);
 113         bool execDelete(const char *pSqlStmt);
 114         bool execUpdate(const char *pSqlStmt);
 115         bool query(int queryType, bool forUpdate, bool distinct, char *pSqlStmt = 0);
 116
 117 public:
 118
 119         // Pointer to the database object this table belongs to
 120         wxDB *pDb;
 121
 122         // ODBC Handles
 123         HENV  henv;                                                     // ODBC Environment handle
 124         HDBC  hdbc;                                                     // ODBC DB Connection handle
 125         HSTMT hstmt;                                            // ODBC Statement handle
 126         HSTMT *hstmtDefault;                            // Default cursor
 127         HSTMT hstmtInsert;                              // ODBC Statement handle used specifically for inserts
 128         HSTMT hstmtDelete;                              // ODBC Statement handle used specifically for deletes
 129         HSTMT hstmtUpdate;                              // ODBC Statement handle used specifically for updates
 130         HSTMT hstmtInternal;                            // ODBC Statement handle used internally only
 131         HSTMT *hstmtCount;                              // ODBC Statement handle used by Count() function (No binding of columns)
 132
 133         // Table Inf.
 134         char tableName[DB_MAX_TABLE_NAME_LEN+1];                        // Table name
 135         char queryTableName[DB_MAX_TABLE_NAME_LEN+1];   // Query Table Name
 136         int  noCols;                                                                                            // # of columns in the table
 137         bool queryOnly;                                                                                 // Query Only, no inserts, updates or deletes
 138
 139         char tablePath[DB_PATH_MAX];  // needed for dBase tables
 140
 141         // Column Definitions
 142         wxColDef *colDefs;      // Array of wxColDef structures
 143
 144         // Where, Order By and From clauses
 145         char *where;                    // Standard SQL where clause, minus the word WHERE
 146         char *orderBy;                  // Standard SQL order by clause, minus the ORDER BY
 147         char *from;                             // Allows for joins in a wxTable::Query().  Format: ",tbl,tbl..."
 148
 149         // Flags
 150         bool selectForUpdate;
 151
 152         // Public member functions
 153         wxTable(wxDB *pwxDB, const char *tblName, const int nCols,
 154                 const char *qryTblName = 0, bool qryOnly = !QUERY_ONLY, const char *tblPath=NULL);
 155         virtual ~wxTable();
 156         bool    Open(void);
 157         bool    CreateTable(bool attemptDrop=TRUE);
 158         bool    DropTable(void);
 159         bool    CreateIndex(const char * idxName, bool unique, int noIdxCols, CidxDef *pIdxDefs, bool attemptDrop=TRUE);
 160         bool    DropIndex(const char * idxName);
 161         bool    CloseCursor(HSTMT cursor);
 162         int   Insert(void);
 163         bool    Update(void);
 164         bool    Update(const char *pSqlStmt);
 165         bool    UpdateWhere(const char *pWhereClause);
 166         bool    Delete(void);
 167         bool    DeleteWhere(const char *pWhereClause);
 168         bool    DeleteMatching(void);
 169         virtual bool Query(bool forUpdate = FALSE, bool distinct = FALSE);
 170         bool    QueryBySqlStmt(char *pSqlStmt);
 171         bool    QueryMatching(bool forUpdate = FALSE, bool distinct = FALSE);
 172         bool    QueryOnKeyFields(bool forUpdate = FALSE, bool distinct = FALSE);
 173         bool    GetNext(void)   { return(getRec(SQL_FETCH_NEXT));  }
 174         bool    operator++(int) { return(getRec(SQL_FETCH_NEXT));  }
 175
 176         /***** These four functions only work with wxDB instances that are defined  *****
 177          ***** as not being FwdOnlyCursors                                          *****/
 178         bool    GetPrev(void);
 179         bool    operator--(int);
 180         bool    GetFirst(void);
 181         bool    GetLast(void);
 182
 183         bool    IsCursorClosedOnCommit(void);
 184         bool    IsColNull(int colNo);
 185         UWORD GetRowNum(void);
 186         void  GetSelectStmt(char *pSqlStmt, int typeOfSelect, bool distinct);
 187         void  GetDeleteStmt(char *pSqlStmt, int typeOfDel, const char *pWhereClause = 0);
 188         void  GetUpdateStmt(char *pSqlStmt, int typeOfUpd, const char *pWhereClause = 0);
 189         void  GetWhereClause(char *pWhereClause, int typeOfWhere, const char *qualTableName = 0);
 190         bool    CanSelectForUpdate(void);
 191         bool    CanUpdByROWID(void);
 192         void  ClearMemberVars(void);
 193         bool    SetQueryTimeout(UDWORD nSeconds);
 194         void  SetColDefs (int index, const char *fieldName, int dataType, void *pData, int cType,
 195                                                         int size, bool keyField = FALSE, bool upd = TRUE,
 196                                                         bool insAllow = TRUE, bool derivedCol = FALSE);
 197         // BJO20000121 : new prototype
 198         //      bool    SetColDefs (wxColInf *colInfs, ULONG numCols, wxColDataPtr *pColDataPtrs);
 199         wxColDataPtr*   SetColDefs (wxColInf *colInfs, ULONG numCols);
 200
 201         HSTMT *NewCursor(bool setCursor = FALSE, bool bindColumns = TRUE);
 202         bool    DeleteCursor(HSTMT *hstmtDel);
 203         void    SetCursor(HSTMT *hstmtActivate = (void **) DEFAULT_CURSOR);
 204         HSTMT GetCursor(void) { return(hstmt); }
 205         ULONG Count(const char *args="*");
 206         int   DB_STATUS(void) { return(pDb->DB_STATUS); }
 207         bool    Refresh(void);
 208         bool    SetNull(int colNo);
 209         bool    SetNull(const char *colName);
 210
 211 #ifdef __WXDEBUG__
 212         ULONG   GetTableID() { return tableID; };
 213 #endif
 214
 215 };  // wxTable
 216
 217 #endif