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