include/wx/dbtable.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        dbtable.h
   3 // Purpose:     Declaration of the wxDbTable class.
   4 // Author:      Doug Card
   5 // Modified by: George Tasker
   6 //              Bart Jourquin
   7 //              Mark Johnson
   8 // Created:     9.96
   9 // RCS-ID:      $Id$
  10 // Copyright:   (c) 1996 Remstar International, Inc.
  11 // Licence:     wxWindows licence, plus:
  12 // Notice:      This class library and its intellectual design are free of charge for use,
  13 //              modification, enhancement, debugging under the following conditions:
  14 //              1) These classes may only be used as part of the implementation of a
  15 //                 wxWindows-based application
  16 //              2) All enhancements and bug fixes are to be submitted back to the wxWindows
  17 //                 user groups free of all charges for use with the wxWindows library.
  18 //              3) These classes may not be distributed as part of any other class library,
  19 //                 DLL, text (written or electronic), other than a complete distribution of
  20 //                 the wxWindows GUI development toolkit.
  21 ///////////////////////////////////////////////////////////////////////////////
  22
  23 /*
  24 // SYNOPSIS START
  25 // SYNOPSIS STOP
  26 */
  27
  28 #ifndef DBTABLE_DOT_H
  29 #define DBTABLE_DOT_H
  30
  31 // Use this line for wxWindows v1.x
  32 //#include "wx_ver.h"
  33 // Use this line for wxWindows v2.x
  34 #include "wx/version.h"
  35
  36 #if wxMAJOR_VERSION == 2
  37     #ifdef __GNUG__
  38         #pragma interface "dbtable.h"
  39     #endif
  40 #endif
  41
  42 #if wxMAJOR_VERSION == 2
  43     #include "wx/db.h"
  44 #else
  45     #include "db.h"
  46 #endif
  47
  48 const int   wxDB_ROWID_LEN       = 24;  // 18 is the max, 24 is in case it gets larger
  49 const int   wxDB_DEFAULT_CURSOR  = 0;
  50 const bool  wxDB_QUERY_ONLY      = TRUE;
  51 const bool  wxDB_DISABLE_VIEW    = TRUE;
  52
  53 // Used to indicate end of a variable length list of
  54 // column numbers passed to member functions
  55 const int   wxDB_NO_MORE_COLUMN_NUMBERS = -1;
  56
  57 // The following class is used to define a column of a table.
  58 // The wxDbTable constructor will dynamically allocate as many of
  59 // these as there are columns in the table.  The class derived
  60 // from wxDbTable must initialize these column definitions in it's
  61 // constructor.  These column definitions provide inf. to the
  62 // wxDbTable class which allows it to create a table in the data
  63 // source, exchange data between the data source and the C++
  64 // object, and so on.
  65 class WXDLLEXPORT wxDbColDef
  66 {
  67 public:
  68     wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];  // Column Name
  69     int     DbDataType;                         // Logical Data Type; e.g. DB_DATA_TYPE_INTEGER
  70     int     SqlCtype;                           // C data type; e.g. SQL_C_LONG
  71     void   *PtrDataObj;                         // Address of the data object
  72     int     SzDataObj;                          // Size, in bytes, of the data object
  73     bool    KeyField;                           // TRUE if this column is part of the PRIMARY KEY to the table; Date fields should NOT be KeyFields.
  74     bool    Updateable;                         // Specifies whether this column is updateable
  75     bool    InsertAllowed;                      // Specifies whether this column should be included in an INSERT statement
  76     bool    DerivedCol;                         // Specifies whether this column is a derived value
  77     SDWORD  CbValue;                            // Internal use only!!!
  78     bool    Null;                               // NOT FULLY IMPLEMENTED - Allows NULL values in Inserts and Updates
  79 };  // wxDbColDef
  80
  81
  82 class WXDLLEXPORT wxDbColDataPtr
  83 {
  84 public:
  85     void    *PtrDataObj;
  86     int      SzDataObj;
  87     int      SqlCtype;
  88 };  // wxDbColDataPtr
  89
  90
  91 // This structure is used when creating secondary indexes.
  92 class WXDLLEXPORT wxDbIdxDef
  93 {
  94 public:
  95     wxChar  ColName[DB_MAX_COLUMN_NAME_LEN+1];
  96     bool    Ascending;
  97 };  // wxDbIdxDef
  98
  99
 100 class WXDLLEXPORT wxDbTable
 101 {
 102 private:
 103     ULONG       tableID;  // Used for debugging.  This can help to match up mismatched constructors/destructors
 104
 105     // Private member variables
 106     UDWORD      cursorType;
 107     bool        insertable;
 108
 109     // Private member functions
 110     bool        initialize(wxDb *pwxDb, const wxString &tblName, const int nCols,
 111                        const wxString &qryTblName, bool qryOnly, const wxString &tblPath);
 112     void        cleanup();
 113
 114     bool        bindParams(bool forUpdate);  // called by the other 'bind' functions
 115     bool        bindInsertParams(void);
 116     bool        bindUpdateParams(void);
 117
 118     bool        bindCols(HSTMT cursor);
 119     bool        getRec(UWORD fetchType);
 120     bool        execDelete(const wxString &pSqlStmt);
 121     bool        execUpdate(const wxString &pSqlStmt);
 122     bool        query(int queryType, bool forUpdate, bool distinct, const wxString &pSqlStmt=wxT(""));
 123
 124 #if !wxODBC_BACKWARD_COMPATABILITY
 125 // these were public
 126     // Where, Order By and From clauses
 127     wxString    where;               // Standard SQL where clause, minus the word WHERE
 128     wxString    orderBy;             // Standard SQL order by clause, minus the ORDER BY
 129     wxString    from;                // Allows for joins in a wxDbTable::Query().  Format: ",tbl,tbl..."
 130
 131     // ODBC Handles
 132     HENV        henv;           // ODBC Environment handle
 133     HDBC        hdbc;           // ODBC DB Connection handle
 134     HSTMT       hstmt;          // ODBC Statement handle
 135     HSTMT      *hstmtDefault;   // Default cursor
 136     HSTMT       hstmtInsert;    // ODBC Statement handle used specifically for inserts
 137     HSTMT       hstmtDelete;    // ODBC Statement handle used specifically for deletes
 138     HSTMT       hstmtUpdate;    // ODBC Statement handle used specifically for updates
 139     HSTMT       hstmtInternal;  // ODBC Statement handle used internally only
 140     HSTMT      *hstmtCount;     // ODBC Statement handle used by Count() function (No binding of columns)
 141
 142     // Flags
 143     bool        selectForUpdate;
 144
 145     // Pointer to the database object this table belongs to
 146     wxDb       *pDb;
 147
 148     // Table Inf.
 149     wxString    tablePath;                                 // needed for dBase tables
 150     wxString    tableName;                                 // Table name
 151     wxString    queryTableName;                            // Query Table Name
 152     int         noCols;                                    // # of columns in the table
 153     bool        queryOnly;                                 // Query Only, no inserts, updates or deletes
 154
 155     // Column Definitions
 156     wxDbColDef *colDefs;         // Array of wxDbColDef structures
 157 #endif
 158 public:
 159 #if wxODBC_BACKWARD_COMPATABILITY
 160     // Where, Order By and From clauses
 161     char       *where;          // Standard SQL where clause, minus the word WHERE
 162     char       *orderBy;        // Standard SQL order by clause, minus the ORDER BY
 163     char       *from;           // Allows for joins in a wxDbTable::Query().  Format: ",tbl,tbl..."
 164
 165     // ODBC Handles
 166     HENV        henv;           // ODBC Environment handle
 167     HDBC        hdbc;           // ODBC DB Connection handle
 168     HSTMT       hstmt;          // ODBC Statement handle
 169     HSTMT      *hstmtDefault;   // Default cursor
 170     HSTMT       hstmtInsert;    // ODBC Statement handle used specifically for inserts
 171     HSTMT       hstmtDelete;    // ODBC Statement handle used specifically for deletes
 172     HSTMT       hstmtUpdate;    // ODBC Statement handle used specifically for updates
 173     HSTMT       hstmtInternal;  // ODBC Statement handle used internally only
 174     HSTMT      *hstmtCount;     // ODBC Statement handle used by Count() function (No binding of columns)
 175
 176     // Flags
 177     bool        selectForUpdate;
 178
 179     // Pointer to the database object this table belongs to
 180     wxDb       *pDb;
 181
 182     // Table Inf.
 183     char        tablePath[wxDB_PATH_MAX];                  // needed for dBase tables
 184     char        tableName[DB_MAX_TABLE_NAME_LEN+1];        // Table name
 185     char        queryTableName[DB_MAX_TABLE_NAME_LEN+1];   // Query Table Name
 186     int         noCols;                                    // # of columns in the table
 187     bool        queryOnly;                                 // Query Only, no inserts, updates or deletes
 188
 189     // Column Definitions
 190     wxDbColDef *colDefs;         // Array of wxDbColDef structures
 191 #endif
 192     // Public member functions
 193     wxDbTable(wxDb *pwxDb, const wxString &tblName, const int nCols,
 194               const wxString &qryTblName="", bool qryOnly = !wxDB_QUERY_ONLY,
 195               const wxString &tblPath="");
 196
 197     // DEPRECATED
 198     wxDbTable(wxDb *pwxDb, const wxString &tblName, const int nCols,
 199               const wxChar *qryTblName="", bool qryOnly = !wxDB_QUERY_ONLY,
 200               const wxString &tblPath="");
 201
 202     virtual ~wxDbTable();
 203
 204     bool            Open(bool checkPrivileges=FALSE);
 205     bool            CreateTable(bool attemptDrop=TRUE);
 206     bool            DropTable(void);
 207     bool            CreateIndex(const wxString &idxName, bool unique, int noIdxCols,
 208                                 wxDbIdxDef *pIdxDefs, bool attemptDrop=TRUE);
 209     bool            DropIndex(const wxString &idxName);
 210
 211     // Accessors
 212
 213     // The member variables returned by these accessors are all
 214     // set when the wxDbTable instance is createand cannot be
 215     // changed, hence there is no corresponding SetXxxx function
 216     wxDb           *GetDb()              { return pDb; }
 217     const wxString &GetTableName()       { return tableName; }
 218     const wxString &GetQueryTableName()  { return queryTableName; }
 219     const wxString &GetTablePath()       { return tablePath; }
 220
 221     int             GetNumberOfColumns() { return noCols; }  // number of "defined" columns for this wxDbTable instance
 222
 223
 224     const wxString &GetFromClause()      { return from; }
 225     const wxString &GetOrderByClause()   { return orderBy; }
 226     const wxString &GetWhereClause()     { return where; }
 227
 228     bool            IsQueryOnly()        { return queryOnly; }
 229 #if wxODBC_BACKWARD_COMPATABILITY
 230     void            SetFromClause(const char *From) { from = (char *)From; }
 231     void            SetOrderByClause(const char *OrderBy) { orderBy = (char *)OrderBy; }
 232     void            SetWhereClause(const char *Where) { where = (char *)Where; }
 233 #else
 234     void            SetFromClause(const wxString &From) { from = From; }
 235     void            SetOrderByClause(const wxString &OrderBy) { orderBy = OrderBy; }
 236     bool            SetOrderByColNums(int first, ...);
 237     void            SetWhereClause(const wxString &Where) { where = Where; }
 238     void            From(const wxString &From) { from = From; }
 239     void            OrderBy(const wxString &OrderBy) { orderBy = OrderBy; }
 240     void            Where(const wxString &Where) { where = Where; }
 241     const wxString &Where()   { return where; }
 242     const wxString &OrderBy() { return orderBy; }
 243     const wxString &From()    { return from; }
 244 #endif
 245     int             Insert(void);
 246     bool            Update(void);
 247     bool            Update(const wxString &pSqlStmt);
 248     bool            UpdateWhere(const wxString &pWhereClause);
 249     bool            Delete(void);
 250     bool            DeleteWhere(const wxString &pWhereClause);
 251     bool            DeleteMatching(void);
 252     virtual bool    Query(bool forUpdate = FALSE, bool distinct = FALSE);
 253     bool            QueryBySqlStmt(const wxString &pSqlStmt);
 254     bool            QueryMatching(bool forUpdate = FALSE, bool distinct = FALSE);
 255     bool            QueryOnKeyFields(bool forUpdate = FALSE, bool distinct = FALSE);
 256     bool            Refresh(void);
 257     bool            GetNext(void)   { return(getRec(SQL_FETCH_NEXT));  }
 258     bool            operator++(int) { return(getRec(SQL_FETCH_NEXT));  }
 259
 260     /***** These four functions only work with wxDb instances that are defined  *****
 261      ***** as not being FwdOnlyCursors                                          *****/
 262     bool            GetPrev(void);
 263     bool            operator--(int);
 264     bool            GetFirst(void);
 265     bool            GetLast(void);
 266
 267     bool            IsCursorClosedOnCommit(void);
 268     UWORD           GetRowNum(void);
 269
 270     void            BuildSelectStmt(wxString &pSqlStmt, int typeOfSelect, bool distinct);
 271     void            BuildSelectStmt(wxChar *pSqlStmt, int typeOfSelect, bool distinct);
 272
 273     void            BuildDeleteStmt(wxString &pSqlStmt, int typeOfDel, const wxString &pWhereClause="");
 274     void            BuildDeleteStmt(wxChar *pSqlStmt, int typeOfDel, const wxString &pWhereClause="");
 275
 276     void            BuildUpdateStmt(wxString &pSqlStmt, int typeOfUpd, const wxString &pWhereClause="");
 277     void            BuildUpdateStmt(wxChar *pSqlStmt, int typeOfUpd, const wxString &pWhereClause="");
 278
 279     void            BuildWhereClause(wxString &pWhereClause, int typeOfWhere, const wxString &qualTableName="", bool useLikeComparison=FALSE);
 280     void            BuildWhereClause(wxChar *pWhereClause, int typeOfWhere, const wxString &qualTableName="", bool useLikeComparison=FALSE);
 281
 282 #if wxODBC_BACKWARD_COMPATABILITY
 283 // The following member functions are deprecated.  You should use the BuildXxxxxStmt functions (above)
 284     void            GetSelectStmt(char *pSqlStmt, int typeOfSelect, bool distinct)
 285                            { BuildSelectStmt(pSqlStmt,typeOfSelect,distinct); }
 286     void            GetDeleteStmt(char *pSqlStmt, int typeOfDel, const char *pWhereClause = NULL)
 287                            { BuildDeleteStmt(pSqlStmt,typeOfDel,pWhereClause); }
 288     void            GetUpdateStmt(char *pSqlStmt, int typeOfUpd, const char *pWhereClause = NULL)
 289                            { BuildUpdateStmt(pSqlStmt,typeOfUpd,pWhereClause); }
 290     void            GetWhereClause(char *pWhereClause, int typeOfWhere,
 291                                    const char *qualTableName = NULL, bool useLikeComparison=FALSE)
 292                            { BuildWhereClause(pWhereClause,typeOfWhere,qualTableName,useLikeComparison); }
 293 #endif
 294     bool            CanSelectForUpdate(void);
 295     bool            CanUpdByROWID(void);
 296     void            ClearMemberVar(int colNo, bool setToNull=FALSE);
 297     void            ClearMemberVars(bool setToNull=FALSE);
 298     bool            SetQueryTimeout(UDWORD nSeconds);
 299
 300     wxDbColDef     *GetColDefs() { return colDefs; }
 301     void            SetColDefs(int index, const wxString &fieldName, int dataType,
 302                                void *pData, int cType,
 303                                int size, bool keyField = FALSE, bool upd = TRUE,
 304                                bool insAllow = TRUE, bool derivedCol = FALSE);
 305     wxDbColDataPtr *SetColDefs(wxDbColInf *colInfs, ULONG numCols);
 306
 307     bool            CloseCursor(HSTMT cursor);
 308     bool            DeleteCursor(HSTMT *hstmtDel);
 309     void            SetCursor(HSTMT *hstmtActivate = (void **) wxDB_DEFAULT_CURSOR);
 310     HSTMT           GetCursor(void) { return(hstmt); }
 311     HSTMT          *GetNewCursor(bool setCursor = FALSE, bool bindColumns = TRUE);
 312 #if wxODBC_BACKWARD_COMPATABILITY
 313 // The following member function is deprecated.  You should use the GetNewCursor
 314     HSTMT          *NewCursor(bool setCursor = FALSE, bool bindColumns = TRUE) {  return GetNewCursor(setCursor,bindColumns); }
 315 #endif
 316
 317     ULONG           Count(const wxString &args="*");
 318     int             DB_STATUS(void) { return(pDb->DB_STATUS); }
 319
 320     bool            IsColNull(int colNo);
 321     bool            SetColNull(int colNo, bool set=TRUE);
 322     bool            SetColNull(const wxString &colName, bool set=TRUE);
 323 #if wxODBC_BACKWARD_COMPATABILITY
 324 // The following member functions are deprecated.  You should use the SetColNull()
 325     bool            SetNull(int colNo, bool set=TRUE) { return (SetNull(colNo,set)); }
 326     bool            SetNull(const char *colName, bool set=TRUE) { return (SetNull(colName,set)); }
 327 #endif
 328 #ifdef __WXDEBUG__
 329     ULONG           GetTableID() { return tableID; }
 330 #endif
 331
 332 };  // wxDbTable
 333
 334
 335 // Change this to 0 to remove use of all deprecated functions
 336 #if wxODBC_BACKWARD_COMPATABILITY
 337 //#################################################################################
 338 //############### DEPRECATED functions for backward compatability #################
 339 //#################################################################################
 340
 341 // Backward compability.  These will eventually go away
 342 typedef wxDbTable       wxTable;
 343 typedef wxDbIdxDef      wxIdxDef;
 344 typedef wxDbIdxDef      CidxDef;
 345 typedef wxDbColDef      wxColDef;
 346 typedef wxDbColDef      CcolDef;
 347 typedef wxDbColDataPtr  wxColDataPtr;
 348 typedef wxDbColDataPtr  CcolDataPtr;
 349
 350 const int   ROWID           = wxDB_ROWID_LEN;
 351 const int   DEFAULT_CURSOR  = wxDB_DEFAULT_CURSOR;
 352 const bool  QUERY_ONLY      = wxDB_QUERY_ONLY;
 353 const bool  DISABLE_VIEW    = wxDB_DISABLE_VIEW;
 354 #endif
 355
 356 #endif