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