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