]> git.saurik.com Git - wxWidgets.git/blame - include/wx/db.h
Use bool instead of int. Replace TRUE/FALSE with true/false.
[wxWidgets.git] / include / wx / db.h
CommitLineData
108106cf 1///////////////////////////////////////////////////////////////////////////////
2b5f62a0 2// Name: wx/db.h
f6bcfd97
BP
3// Purpose: Header file wxDb class. The wxDb class represents a connection
4// to an ODBC data source. The wxDb class allows operations on the data
108106cf
JS
5// source such as opening and closing the data source.
6// Author: Doug Card
30a6d2d2 7// Modified by: George Tasker
3ca6a5f0 8// Bart Jourquin
a9f4558f 9// Mark Johnson, wxWindows@mj10777.de
ad2522ad 10// Mods: Dec, 1998:
a2115c88 11// -Added support for SQL statement logging and database cataloging
95ca6a20
GT
12// April, 1999
13// -Added QUERY_ONLY mode support to reduce default number of cursors
14// -Added additional SQL logging code
a2115c88 15// -Added DEBUG-ONLY tracking of Ctable objects to detect orphaned DB connections
95ca6a20
GT
16// -Set ODBC option to only read committed writes to the DB so all
17// databases operate the same in that respect
a2115c88 18//
108106cf
JS
19// Created: 9.96
20// RCS-ID: $Id$
21// Copyright: (c) 1996 Remstar International, Inc.
65571936 22// Licence: wxWindows licence, plus:
95ca6a20 23// Notice: This class library and its intellectual design are free of charge for use,
108106cf
JS
24// modification, enhancement, debugging under the following conditions:
25// 1) These classes may only be used as part of the implementation of a
77ffb593
JS
26// wxWidgets-based application
27// 2) All enhancements and bug fixes are to be submitted back to the wxWidgets
28// user groups free of all charges for use with the wxWidgets library.
108106cf
JS
29// 3) These classes may not be distributed as part of any other class library,
30// DLL, text (written or electronic), other than a complete distribution of
77ffb593 31// the wxWidgets GUI development toolkit.
1fc5dd6f 32//
108106cf
JS
33///////////////////////////////////////////////////////////////////////////////
34
2b5f62a0
VZ
35#ifndef _WX_DB_H_
36#define _WX_DB_H_
a2115c88 37
f6bcfd97
BP
38
39// BJO 20000503: introduce new GetColumns members which are more database independant and
40// return columns in the order they were created
41#define OLD_GETCOLUMNS 1
e2f4e132 42#define EXPERIMENTAL_WXDB_FUNCTIONS 1
f6bcfd97 43
a2115c88
GT
44#include "wx/version.h"
45
12028905 46#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
20987580 47 #pragma interface "db.h"
108106cf
JS
48#endif
49
16b52fa1
RR
50#include "wx/setup.h"
51
d4af841d
GT
52#include "wx/defs.h"
53#include "wx/string.h"
54
190869b2 55#if defined(__VISUALC__)
2b5f62a0
VZ
56 // we need to include standard Windows headers but we can't include
57 // <windows.h> directly when using MFC because it includes it itself in a
58 // different manner
59 #if wxUSE_MFC
60 #include <afxwin.h>
61 #else // !wxUSE_MFC
62 #ifndef STRICT
63 #define STRICT 1
64 #endif
65
66 #include <windows.h>
67 #include "wx/msw/winundef.h"
68 #endif // wxUSE_MFC/!wxUSE_MFC
69
70 // If you use the wxDbCreateDataSource() function with MSW/VC6,
71 // you cannot use the iODBC headers, you must use the VC headers,
72 // plus the odbcinst.h header - gt Nov 2 2000
73 //
77ffb593 74 // Must add "odbccp32.lib" in \wx2\wxWidgets\src\makevc.env to the WINLIBS= line
2b5f62a0 75 //
e2f4e132
GT
76 #include "sql.h"
77 #include "sqlext.h"
78 #include "odbcinst.h"
f7556ff0 79#else
bfe5de86 80 #if defined(__WINDOWS__) && ( defined(HAVE_W32API_H) || defined(__BORLANDC__) )
190869b2
VS
81 #include <windows.h>
82 #include "wx/msw/winundef.h"
83 #endif
2b5f62a0 84 extern "C" {
0bdb08e7
VS
85 #if defined(wxUSE_BUILTIN_IODBC) && wxUSE_BUILTIN_IODBC
86 // Use the ones from the library
87 #include "wx/isql.h"
88 #include "wx/isqlext.h"
89 #else
f7556ff0
JS
90 #include <sql.h>
91 #include <sqlext.h>
0bdb08e7 92 #endif
2b5f62a0 93 }
aecca2c8
MB
94#endif
95
30a6d2d2 96
595b5c4e
MJ
97typedef float SFLOAT;
98typedef double SDOUBLE;
95ca6a20
GT
99typedef unsigned int UINT;
100#define ULONG UDWORD
30a6d2d2 101
c27be5db
JS
102// Not available in iODBC
103#ifndef __WXMSW__
104typedef UCHAR SQLTCHAR;
105#endif
106
30a6d2d2
GT
107#ifndef wxODBC_FWD_ONLY_CURSORS
108#define wxODBC_FWD_ONLY_CURSORS 1
109#endif
110
95ca6a20 111enum enumDummy {enumDum1};
7e616b10 112
b742792c 113#ifndef SQL_C_BOOLEAN
f3df29e3 114 #define SQL_C_BOOLEAN(datatype) (sizeof(datatype) == 1 ? SQL_C_UTINYINT : (sizeof(datatype) == 2 ? SQL_C_USHORT : SQL_C_ULONG))
b742792c 115#endif
20987580 116
b742792c 117#ifndef SQL_C_ENUM
f3df29e3 118 #define SQL_C_ENUM (sizeof(enumDummy) == 2 ? SQL_C_USHORT : SQL_C_ULONG)
b742792c 119#endif
20987580 120
f3df29e3
GT
121// NOTE: If SQL_C_BLOB is defined, and it is not SQL_C_BINARY, iODBC 2.x
122// may not function correctly. Likely best to use SQL_C_BINARY direct
b742792c 123#ifndef SQL_C_BLOB
f3df29e3
GT
124 #ifdef SQL_C_BINARY
125 #define SQL_C_BLOB SQL_C_BINARY
b742792c
GT
126 #endif
127#endif
7e616b10 128
f6bcfd97 129const int wxDB_PATH_MAX = 254;
95ca6a20 130
bb41dcbe
VS
131WXDLLIMPEXP_DATA_ODBC(extern wxChar const *) SQL_LOG_FILENAME;
132WXDLLIMPEXP_DATA_ODBC(extern wxChar const *) SQL_CATALOG_FILENAME;
108106cf 133
108106cf 134// Database Globals
95ca6a20 135const int DB_TYPE_NAME_LEN = 40;
eb3b9dda
GT
136const int DB_MAX_STATEMENT_LEN = 4096;
137const int DB_MAX_WHERE_CLAUSE_LEN = 2048;
95ca6a20
GT
138const int DB_MAX_ERROR_MSG_LEN = 512;
139const int DB_MAX_ERROR_HISTORY = 5;
140const int DB_MAX_TABLE_NAME_LEN = 128;
141const int DB_MAX_COLUMN_NAME_LEN = 128;
142
143const int DB_DATA_TYPE_VARCHAR = 1;
144const int DB_DATA_TYPE_INTEGER = 2;
145const int DB_DATA_TYPE_FLOAT = 3;
146const int DB_DATA_TYPE_DATE = 4;
b742792c 147const int DB_DATA_TYPE_BLOB = 5;
95ca6a20
GT
148
149const int DB_SELECT_KEYFIELDS = 1;
150const int DB_SELECT_WHERE = 2;
151const int DB_SELECT_MATCHING = 3;
152const int DB_SELECT_STATEMENT = 4;
153
154const int DB_UPD_KEYFIELDS = 1;
155const int DB_UPD_WHERE = 2;
156
157const int DB_DEL_KEYFIELDS = 1;
158const int DB_DEL_WHERE = 2;
159const int DB_DEL_MATCHING = 3;
160
161const int DB_WHERE_KEYFIELDS = 1;
162const int DB_WHERE_MATCHING = 2;
163
164const int DB_GRANT_SELECT = 1;
165const int DB_GRANT_INSERT = 2;
166const int DB_GRANT_UPDATE = 4;
167const int DB_GRANT_DELETE = 8;
168const int DB_GRANT_ALL = DB_GRANT_SELECT | DB_GRANT_INSERT | DB_GRANT_UPDATE | DB_GRANT_DELETE;
108106cf
JS
169
170// ODBC Error codes (derived from ODBC SqlState codes)
fdc03678 171enum wxODBC_ERRORS
108106cf 172{
95ca6a20
GT
173 DB_FAILURE = 0,
174 DB_SUCCESS = 1,
175 DB_ERR_NOT_IN_USE,
176 DB_ERR_GENERAL_WARNING, // SqlState = '01000'
177 DB_ERR_DISCONNECT_ERROR, // SqlState = '01002'
178 DB_ERR_DATA_TRUNCATED, // SqlState = '01004'
179 DB_ERR_PRIV_NOT_REVOKED, // SqlState = '01006'
180 DB_ERR_INVALID_CONN_STR_ATTR, // SqlState = '01S00'
181 DB_ERR_ERROR_IN_ROW, // SqlState = '01S01'
182 DB_ERR_OPTION_VALUE_CHANGED, // SqlState = '01S02'
183 DB_ERR_NO_ROWS_UPD_OR_DEL, // SqlState = '01S03'
184 DB_ERR_MULTI_ROWS_UPD_OR_DEL, // SqlState = '01S04'
185 DB_ERR_WRONG_NO_OF_PARAMS, // SqlState = '07001'
186 DB_ERR_DATA_TYPE_ATTR_VIOL, // SqlState = '07006'
187 DB_ERR_UNABLE_TO_CONNECT, // SqlState = '08001'
188 DB_ERR_CONNECTION_IN_USE, // SqlState = '08002'
189 DB_ERR_CONNECTION_NOT_OPEN, // SqlState = '08003'
190 DB_ERR_REJECTED_CONNECTION, // SqlState = '08004'
191 DB_ERR_CONN_FAIL_IN_TRANS, // SqlState = '08007'
192 DB_ERR_COMM_LINK_FAILURE, // SqlState = '08S01'
193 DB_ERR_INSERT_VALUE_LIST_MISMATCH, // SqlState = '21S01'
194 DB_ERR_DERIVED_TABLE_MISMATCH, // SqlState = '21S02'
195 DB_ERR_STRING_RIGHT_TRUNC, // SqlState = '22001'
196 DB_ERR_NUMERIC_VALUE_OUT_OF_RNG, // SqlState = '22003'
197 DB_ERR_ERROR_IN_ASSIGNMENT, // SqlState = '22005'
198 DB_ERR_DATETIME_FLD_OVERFLOW, // SqlState = '22008'
199 DB_ERR_DIVIDE_BY_ZERO, // SqlState = '22012'
200 DB_ERR_STR_DATA_LENGTH_MISMATCH, // SqlState = '22026'
201 DB_ERR_INTEGRITY_CONSTRAINT_VIOL, // SqlState = '23000'
202 DB_ERR_INVALID_CURSOR_STATE, // SqlState = '24000'
203 DB_ERR_INVALID_TRANS_STATE, // SqlState = '25000'
204 DB_ERR_INVALID_AUTH_SPEC, // SqlState = '28000'
205 DB_ERR_INVALID_CURSOR_NAME, // SqlState = '34000'
206 DB_ERR_SYNTAX_ERROR_OR_ACCESS_VIOL, // SqlState = '37000'
207 DB_ERR_DUPLICATE_CURSOR_NAME, // SqlState = '3C000'
208 DB_ERR_SERIALIZATION_FAILURE, // SqlState = '40001'
209 DB_ERR_SYNTAX_ERROR_OR_ACCESS_VIOL2, // SqlState = '42000'
210 DB_ERR_OPERATION_ABORTED, // SqlState = '70100'
211 DB_ERR_UNSUPPORTED_FUNCTION, // SqlState = 'IM001'
212 DB_ERR_NO_DATA_SOURCE, // SqlState = 'IM002'
213 DB_ERR_DRIVER_LOAD_ERROR, // SqlState = 'IM003'
214 DB_ERR_SQLALLOCENV_FAILED, // SqlState = 'IM004'
215 DB_ERR_SQLALLOCCONNECT_FAILED, // SqlState = 'IM005'
216 DB_ERR_SQLSETCONNECTOPTION_FAILED, // SqlState = 'IM006'
217 DB_ERR_NO_DATA_SOURCE_DLG_PROHIB, // SqlState = 'IM007'
218 DB_ERR_DIALOG_FAILED, // SqlState = 'IM008'
219 DB_ERR_UNABLE_TO_LOAD_TRANSLATION_DLL, // SqlState = 'IM009'
220 DB_ERR_DATA_SOURCE_NAME_TOO_LONG, // SqlState = 'IM010'
221 DB_ERR_DRIVER_NAME_TOO_LONG, // SqlState = 'IM011'
222 DB_ERR_DRIVER_KEYWORD_SYNTAX_ERROR, // SqlState = 'IM012'
223 DB_ERR_TRACE_FILE_ERROR, // SqlState = 'IM013'
224 DB_ERR_TABLE_OR_VIEW_ALREADY_EXISTS, // SqlState = 'S0001'
225 DB_ERR_TABLE_NOT_FOUND, // SqlState = 'S0002'
226 DB_ERR_INDEX_ALREADY_EXISTS, // SqlState = 'S0011'
227 DB_ERR_INDEX_NOT_FOUND, // SqlState = 'S0012'
228 DB_ERR_COLUMN_ALREADY_EXISTS, // SqlState = 'S0021'
229 DB_ERR_COLUMN_NOT_FOUND, // SqlState = 'S0022'
230 DB_ERR_NO_DEFAULT_FOR_COLUMN, // SqlState = 'S0023'
231 DB_ERR_GENERAL_ERROR, // SqlState = 'S1000'
232 DB_ERR_MEMORY_ALLOCATION_FAILURE, // SqlState = 'S1001'
233 DB_ERR_INVALID_COLUMN_NUMBER, // SqlState = 'S1002'
234 DB_ERR_PROGRAM_TYPE_OUT_OF_RANGE, // SqlState = 'S1003'
235 DB_ERR_SQL_DATA_TYPE_OUT_OF_RANGE, // SqlState = 'S1004'
236 DB_ERR_OPERATION_CANCELLED, // SqlState = 'S1008'
237 DB_ERR_INVALID_ARGUMENT_VALUE, // SqlState = 'S1009'
238 DB_ERR_FUNCTION_SEQUENCE_ERROR, // SqlState = 'S1010'
239 DB_ERR_OPERATION_INVALID_AT_THIS_TIME, // SqlState = 'S1011'
240 DB_ERR_INVALID_TRANS_OPERATION_CODE, // SqlState = 'S1012'
241 DB_ERR_NO_CURSOR_NAME_AVAIL, // SqlState = 'S1015'
242 DB_ERR_INVALID_STR_OR_BUF_LEN, // SqlState = 'S1090'
243 DB_ERR_DESCRIPTOR_TYPE_OUT_OF_RANGE, // SqlState = 'S1091'
244 DB_ERR_OPTION_TYPE_OUT_OF_RANGE, // SqlState = 'S1092'
245 DB_ERR_INVALID_PARAM_NO, // SqlState = 'S1093'
246 DB_ERR_INVALID_SCALE_VALUE, // SqlState = 'S1094'
247 DB_ERR_FUNCTION_TYPE_OUT_OF_RANGE, // SqlState = 'S1095'
248 DB_ERR_INF_TYPE_OUT_OF_RANGE, // SqlState = 'S1096'
249 DB_ERR_COLUMN_TYPE_OUT_OF_RANGE, // SqlState = 'S1097'
250 DB_ERR_SCOPE_TYPE_OUT_OF_RANGE, // SqlState = 'S1098'
251 DB_ERR_NULLABLE_TYPE_OUT_OF_RANGE, // SqlState = 'S1099'
252 DB_ERR_UNIQUENESS_OPTION_TYPE_OUT_OF_RANGE, // SqlState = 'S1100'
253 DB_ERR_ACCURACY_OPTION_TYPE_OUT_OF_RANGE, // SqlState = 'S1101'
254 DB_ERR_DIRECTION_OPTION_OUT_OF_RANGE, // SqlState = 'S1103'
255 DB_ERR_INVALID_PRECISION_VALUE, // SqlState = 'S1104'
256 DB_ERR_INVALID_PARAM_TYPE, // SqlState = 'S1105'
257 DB_ERR_FETCH_TYPE_OUT_OF_RANGE, // SqlState = 'S1106'
258 DB_ERR_ROW_VALUE_OUT_OF_RANGE, // SqlState = 'S1107'
259 DB_ERR_CONCURRENCY_OPTION_OUT_OF_RANGE, // SqlState = 'S1108'
260 DB_ERR_INVALID_CURSOR_POSITION, // SqlState = 'S1109'
261 DB_ERR_INVALID_DRIVER_COMPLETION, // SqlState = 'S1110'
262 DB_ERR_INVALID_BOOKMARK_VALUE, // SqlState = 'S1111'
263 DB_ERR_DRIVER_NOT_CAPABLE, // SqlState = 'S1C00'
264 DB_ERR_TIMEOUT_EXPIRED // SqlState = 'S1T00'
108106cf
JS
265};
266
5cf34cf0 267#ifndef MAXNAME
f3df29e3 268 #define MAXNAME 31
5cf34cf0
GT
269#endif
270
271#ifndef SQL_MAX_AUTHSTR_LEN
f3df29e3
GT
272 // There does not seem to be a standard for this, so I am
273 // defaulting to the value that MS uses
274 #define SQL_MAX_AUTHSTR_LEN MAXNAME
5cf34cf0 275#endif
95ca6a20 276
0907ea9c
GT
277#ifndef SQL_MAX_CONNECTSTR_LEN
278 // There does not seem to be a standard for this, so I am
279 // defaulting to the value that MS recommends
280 #define SQL_MAX_CONNECTSTR_LEN 1024
281#endif
282
283
bb41dcbe 284class WXDLLIMPEXP_ODBC wxDbConnectInf
108106cf 285{
5cf34cf0
GT
286 private:
287 bool freeHenvOnDestroy;
0907ea9c 288 bool useConnectionStr;
a2115c88 289
5cf34cf0 290 public:
2f971924
GT
291 HENV Henv;
292 wxChar Dsn[SQL_MAX_DSN_LENGTH+1]; // Data Source Name
293 wxChar Uid[SQL_MAX_USER_NAME_LEN+1]; // User ID
294 wxChar AuthStr[SQL_MAX_AUTHSTR_LEN+1]; // Authorization string (password)
0907ea9c 295 wxChar ConnectionStr[SQL_MAX_CONNECTSTR_LEN+1]; // Connection string (password)
5cf34cf0
GT
296
297 wxString Description; // Not sure what the max length is
298 wxString FileType; // Not sure what the max length is
299
300 // Optionals needed for some databases like dBase
301 wxString DefaultDir; // Directory that db file resides in
302
303 public:
304
305 wxDbConnectInf();
da99271d
GT
306 wxDbConnectInf(HENV henv, const wxString &dsn, const wxString &userID=wxEmptyString,
307 const wxString &password=wxEmptyString, const wxString &defaultDir=wxEmptyString,
308 const wxString &description=wxEmptyString, const wxString &fileType=wxEmptyString);
5cf34cf0
GT
309
310 ~wxDbConnectInf();
311
312 bool Initialize();
313
314 bool AllocHenv();
315 void FreeHenv();
316
317 // Accessors
6a71ee86 318 const HENV &GetHenv() { return Henv; };
5cf34cf0
GT
319
320 const wxChar *GetDsn() { return Dsn; };
321
322 const wxChar *GetUid() { return Uid; };
323 const wxChar *GetUserID() { return Uid; };
324
325 const wxChar *GetAuthStr() { return AuthStr; };
326 const wxChar *GetPassword() { return AuthStr; };
327
0907ea9c
GT
328 const wxChar *GetConnectionStr() { return ConnectionStr; };
329 bool UseConnectionStr() { return useConnectionStr; };
330
5cf34cf0
GT
331 const wxChar *GetDescription() { return Description; };
332 const wxChar *GetFileType() { return FileType; };
333 const wxChar *GetDefaultDir() { return DefaultDir; };
334
335 void SetHenv(const HENV henv) { Henv = henv; };
336
337 void SetDsn(const wxString &dsn);
338
339 void SetUserID(const wxString &userID);
340 void SetUid(const wxString &uid) { SetUserID(uid); };
341
342 void SetPassword(const wxString &password);
343 void SetAuthStr(const wxString &authstr) { SetPassword(authstr); };
344
0907ea9c
GT
345 void SetConnectionStr(const wxString &connectStr);
346
5cf34cf0
GT
347 void SetDescription(const wxString &desc) { Description = desc; };
348 void SetFileType(const wxString &fileType) { FileType = fileType; };
349 void SetDefaultDir(const wxString &defDir) { DefaultDir = defDir; };
350}; // class wxDbConnectInf
a2115c88 351
108106cf 352
bb41dcbe 353struct WXDLLIMPEXP_ODBC wxDbSqlTypeInfo
108106cf 354{
4fdae997 355 wxString TypeName;
02cf6fdd 356 SWORD FsqlType;
4fdae997
GT
357 long Precision;
358 short CaseSensitive;
4fdae997 359 short MaximumScale;
fdc03678 360};
108106cf 361
95ca6a20 362
bb41dcbe 363class WXDLLIMPEXP_ODBC wxDbColFor
30a6d2d2 364{
95ca6a20 365public:
5cf34cf0
GT
366 wxString s_Field; // Formated String for Output
367 wxString s_Format[7]; // Formated Objects - TIMESTAMP has the biggest (7)
3ca6a5f0
BP
368 wxString s_Amount[7]; // Formated Objects - amount of things that can be formatted
369 int i_Amount[7]; // Formated Objects - TT MM YYYY HH MM SS m
5cf34cf0
GT
370 int i_Nation; // 0 = timestamp , 1=EU, 2=UK, 3=International, 4=US
371 int i_dbDataType; // conversion of the 'sqlDataType' to the generic data type used by these classes
95ca6a20
GT
372 SWORD i_sqlDataType;
373
f6bcfd97
BP
374 wxDbColFor();
375 ~wxDbColFor();
595b5c4e 376
6a71ee86 377 void Initialize();
95ca6a20 378 int Format(int Nation, int dbDataType, SWORD sqlDataType, short columnSize, short decimalDigits);
30a6d2d2
GT
379};
380
95ca6a20 381
bb41dcbe 382class WXDLLIMPEXP_ODBC wxDbColInf
108106cf
JS
383{
384public:
4fdae997
GT
385 wxChar catalog[128+1];
386 wxChar schema[128+1];
387 wxChar tableName[DB_MAX_TABLE_NAME_LEN+1];
388 wxChar colName[DB_MAX_COLUMN_NAME_LEN+1];
95ca6a20 389 SWORD sqlDataType;
4fdae997 390 wxChar typeName[128+1];
95ca6a20
GT
391 SWORD columnSize;
392 SWORD bufferLength;
393 short decimalDigits;
394 short numPrecRadix;
395 short nullable;
4fdae997 396 wxChar remarks[254+1];
95ca6a20 397 int dbDataType; // conversion of the 'sqlDataType' to the generic data type used by these classes
30a6d2d2
GT
398 // mj10777.19991224 : new
399 int PkCol; // Primary key column 0=No; 1= First Key, 2 = Second Key etc.
4fdae997 400 wxChar PkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Tables that use this PKey as a FKey
30a6d2d2 401 int FkCol; // Foreign key column 0=No; 1= First Key, 2 = Second Key etc.
4fdae997 402 wxChar FkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Foreign key table name
f6bcfd97 403 wxDbColFor *pColFor; // How should this columns be formatted
3ca6a5f0
BP
404
405 wxDbColInf();
406 ~wxDbColInf();
da99271d
GT
407
408 bool Initialize();
30a6d2d2
GT
409};
410
95ca6a20 411
bb41dcbe 412class WXDLLIMPEXP_ODBC wxDbTableInf // Description of a Table
95ca6a20 413{
30a6d2d2 414public:
4fdae997
GT
415 wxChar tableName[DB_MAX_TABLE_NAME_LEN+1];
416 wxChar tableType[254+1]; // "TABLE" or "SYSTEM TABLE" etc.
417 wxChar tableRemarks[254+1];
02cf6fdd 418 UWORD numCols; // How many Columns does this Table have: GetColumnCount(..);
f6bcfd97 419 wxDbColInf *pColInf; // pColInf = NULL ; User can later call GetColumns(..);
da99271d 420
3ca6a5f0
BP
421 wxDbTableInf();
422 ~wxDbTableInf();
da99271d
GT
423
424 bool Initialize();
30a6d2d2
GT
425};
426
95ca6a20 427
bb41dcbe 428class WXDLLIMPEXP_ODBC wxDbInf // Description of a Database
95ca6a20 429{
30a6d2d2 430public:
4fdae997
GT
431 wxChar catalog[128+1];
432 wxChar schema[128+1];
f6bcfd97
BP
433 int numTables; // How many tables does this database have
434 wxDbTableInf *pTableInf; // pTableInf = new wxDbTableInf[numTables];
3ca6a5f0
BP
435
436 wxDbInf();
437 ~wxDbInf();
6a71ee86 438
da99271d 439 bool Initialize();
108106cf
JS
440};
441
95ca6a20 442
f6bcfd97 443enum wxDbSqlLogState
1fc5dd6f 444{
95ca6a20
GT
445 sqlLogOFF,
446 sqlLogON
1fc5dd6f
JS
447};
448
95ca6a20 449// These are the databases currently tested and working with these classes
f6bcfd97 450// See the comments in wxDb::Dbms() for exceptions/issues with
95ca6a20 451// each of these database engines
fdc03678 452enum wxDBMS
a2115c88 453{
95ca6a20
GT
454 dbmsUNIDENTIFIED,
455 dbmsORACLE,
456 dbmsSYBASE_ASA, // Adaptive Server Anywhere
457 dbmsSYBASE_ASE, // Adaptive Server Enterprise
458 dbmsMS_SQL_SERVER,
459 dbmsMY_SQL,
460 dbmsPOSTGRES,
461 dbmsACCESS,
462 dbmsDBASE,
f6bcfd97 463 dbmsINFORMIX,
e2f4e132 464 dbmsVIRTUOSO,
d8a0a1c9 465 dbmsDB2,
1b12ab16 466 dbmsINTERBASE,
9f4de2dc
JS
467 dbmsPERVASIVE_SQL,
468 dbmsXBASE_SEQUITER
a2115c88
GT
469};
470
95ca6a20 471
f6bcfd97 472// The wxDb::errorList is copied to this variable when the wxDb object
a2115c88 473// is closed. This way, the error list is still available after the
595b5c4e 474// database object is closed. This is necessary if the database
a2115c88 475// connection fails so the calling application can show the operator
f6bcfd97
BP
476// why the connection failed. Note: as each wxDb object is closed, it
477// will overwrite the errors of the previously destroyed wxDb object in
a2115c88 478// this variable.
8a77c0d7 479
8b1c2cf0 480WXDLLIMPEXP_DATA_ODBC(extern wxChar)
886dd7d2 481 DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
a2115c88 482
95ca6a20 483
bb41dcbe 484class WXDLLIMPEXP_ODBC wxDb
108106cf
JS
485{
486private:
95ca6a20 487 bool dbIsOpen;
20987580 488 bool dbIsCached; // Was connection created by caching functions
0907ea9c 489 bool dbOpenedWithConnectionString; // Was the database connection opened with a connection string
4fdae997
GT
490 wxString dsn; // Data source name
491 wxString uid; // User ID
492 wxString authStr; // Authorization string (password)
0907ea9c
GT
493 wxString inConnectionStr; // Connection string used to connect to the database
494 wxString outConnectionStr;// Connection string returned by the database when a connection is successfully opened
95ca6a20 495 FILE *fpSqlLog; // Sql Log file pointer
f6bcfd97 496 wxDbSqlLogState sqlLogState; // On or Off
95ca6a20 497 bool fwdOnlyCursors;
e2f4e132 498 wxDBMS dbmsType; // Type of datasource - i.e. Oracle, dBase, SQLServer, etc
95ca6a20
GT
499
500 // Private member functions
0907ea9c 501 bool getDbInfo(bool failOnDataTypeUnsupported=TRUE);
f6bcfd97 502 bool getDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo);
95ca6a20 503 bool setConnectionOptions(void);
4fdae997 504 void logError(const wxString &errMsg, const wxString &SQLState);
4fdae997 505 const wxChar *convertUserID(const wxChar *userID, wxString &UserID);
da99271d 506 void initialize();
0907ea9c 507 bool open(bool failOnDataTypeUnsupported=TRUE);
4fdae997 508
f6bcfd97
BP
509#if !wxODBC_BACKWARD_COMPATABILITY
510 // ODBC handles
511 HENV henv; // ODBC Environment handle
512 HDBC hdbc; // ODBC DB Connection handle
513 HSTMT hstmt; // ODBC Statement handle
514
515 //Error reporting mode
516 bool silent;
517
518 // Number of Ctable objects connected to this db object. FOR INTERNAL USE ONLY!!!
519 unsigned int nTables;
520
521 // Information about logical data types VARCHAR, INTEGER, FLOAT and DATE.
3ca6a5f0 522 //
f6bcfd97
BP
523 // This information is obtained from the ODBC driver by use of the
524 // SQLGetTypeInfo() function. The key piece of information is the
525 // type name the data source uses for each logical data type.
526 // e.g. VARCHAR; Oracle calls it VARCHAR2.
527 wxDbSqlTypeInfo typeInfVarchar;
528 wxDbSqlTypeInfo typeInfInteger;
529 wxDbSqlTypeInfo typeInfFloat;
530 wxDbSqlTypeInfo typeInfDate;
b742792c 531 wxDbSqlTypeInfo typeInfBlob;
f6bcfd97 532#endif
a3439c7d 533
108106cf 534public:
b742792c 535
20987580
GT
536 void setCached(bool cached) { dbIsCached = cached; }; // This function must only be called by wxDbGetConnection() and wxDbCloseConnections!!!
537 bool IsCached() { return dbIsCached; };
538
b742792c
GT
539 bool GetDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo)
540 { return getDataTypeInfo(fSqlType, structSQLTypeInfo); }
541
f6bcfd97
BP
542#if wxODBC_BACKWARD_COMPATABILITY
543 // ODBC handles
544 HENV henv; // ODBC Environment handle
545 HDBC hdbc; // ODBC DB Connection handle
546 HSTMT hstmt; // ODBC Statement handle
547
548 //Error reporting mode
549 bool silent;
550
551 // Number of Ctable objects connected to this db object. FOR INTERNAL USE ONLY!!!
552 unsigned int nTables;
553#endif
554
95ca6a20
GT
555 // The following structure contains database information gathered from the
556 // datasource when the datasource is first opened.
557 struct
558 {
4fdae997
GT
559 wxChar dbmsName[40]; // Name of the dbms product
560 wxChar dbmsVer[64]; // Version # of the dbms product
561 wxChar driverName[40]; // Driver name
562 wxChar odbcVer[60]; // ODBC version of the driver
563 wxChar drvMgrOdbcVer[60]; // ODBC version of the driver manager
564 wxChar driverVer[60]; // Driver version
565 wxChar serverName[80]; // Server Name, typically a connect string
566 wxChar databaseName[128]; // Database filename
567 wxChar outerJoins[2]; // Indicates whether the data source supports outer joins
568 wxChar procedureSupport[2]; // Indicates whether the data source supports stored procedures
569 wxChar accessibleTables[2]; // Indicates whether the data source only reports accessible tables in SQLTables.
95ca6a20
GT
570 UWORD maxConnections; // Maximum # of connections the data source supports
571 UWORD maxStmts; // Maximum # of HSTMTs per HDBC
572 UWORD apiConfLvl; // ODBC API conformance level
573 UWORD cliConfLvl; // Indicates whether the data source is SAG compliant
574 UWORD sqlConfLvl; // SQL conformance level
575 UWORD cursorCommitBehavior; // Indicates how cursors are affected by a db commit
576 UWORD cursorRollbackBehavior; // Indicates how cursors are affected by a db rollback
577 UWORD supportNotNullClause; // Indicates if data source supports NOT NULL clause
4fdae997 578 wxChar supportIEF[2]; // Integrity Enhancement Facility (Referential Integrity)
95ca6a20
GT
579 UDWORD txnIsolation; // Default transaction isolation level supported by the driver
580 UDWORD txnIsolationOptions; // Transaction isolation level options available
581 UDWORD fetchDirections; // Fetch directions supported
582 UDWORD lockTypes; // Lock types supported in SQLSetPos
583 UDWORD posOperations; // Position operations supported in SQLSetPos
584 UDWORD posStmts; // Position statements supported
585 UDWORD scrollConcurrency; // Concurrency control options supported for scrollable cursors
586 UDWORD scrollOptions; // Scroll Options supported for scrollable cursors
587 UDWORD staticSensitivity; // Indicates if additions, deletions and updates can be detected
588 UWORD txnCapable; // Indicates if the data source supports transactions
589 UDWORD loginTimeout; // Number seconds to wait for a login request
590 } dbInf;
591
95ca6a20 592 // ODBC Error Inf.
95ca6a20 593 SWORD cbErrorMsg;
95ca6a20 594 int DB_STATUS;
f6bcfd97
BP
595 wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
596 wxChar errorMsg[SQL_MAX_MESSAGE_LENGTH];
597 SDWORD nativeError;
598 wxChar sqlState[20];
95ca6a20 599
f6bcfd97
BP
600#if wxODBC_BACKWARD_COMPATABILITY
601 // Information about logical data types VARCHAR, INTEGER, FLOAT and DATE.
3ca6a5f0 602 //
f6bcfd97
BP
603 // This information is obtained from the ODBC driver by use of the
604 // SQLGetTypeInfo() function. The key piece of information is the
95ca6a20
GT
605 // type name the data source uses for each logical data type.
606 // e.g. VARCHAR; Oracle calls it VARCHAR2.
f6bcfd97
BP
607 wxDbSqlTypeInfo typeInfVarchar;
608 wxDbSqlTypeInfo typeInfInteger;
609 wxDbSqlTypeInfo typeInfFloat;
610 wxDbSqlTypeInfo typeInfDate;
b742792c 611 wxDbSqlTypeInfo typeInfBlob;
f6bcfd97 612#endif
595b5c4e 613
95ca6a20 614 // Public member functions
6a71ee86 615 wxDb(const HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
20987580 616 ~wxDb();
5cf34cf0 617
e25cdb86 618 // Data Source Name, User ID, Password and whether open should fail on data type not supported
0907ea9c 619 bool Open(const wxString& inConnectStr, bool failOnDataTypeUnsupported=TRUE);
e25cdb86 620 bool Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr, bool failOnDataTypeUnsupported=TRUE);
f3df29e3 621 bool Open(wxDbConnectInf *dbConnectInf, bool failOnDataTypeUnsupported=TRUE);
e2f4e132 622 bool Open(wxDb *copyDb); // pointer to a wxDb whose connection info should be copied rather than re-queried
95ca6a20
GT
623 void Close(void);
624 bool CommitTrans(void);
625 bool RollbackTrans(void);
626 bool DispAllErrors(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
627 bool GetNextError(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
628 void DispNextError(void);
a144affe 629 bool CreateView(const wxString &viewName, const wxString &colList, const wxString &pSqlStmt, bool attemptDrop=TRUE);
4fdae997
GT
630 bool DropView(const wxString &viewName);
631 bool ExecSql(const wxString &pSqlStmt);
95ca6a20
GT
632 bool GetNext(void);
633 bool GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SDWORD FAR *cbReturned);
4fdae997
GT
634 bool Grant(int privileges, const wxString &tableName, const wxString &userList = wxT("PUBLIC"));
635 int TranslateSqlState(const wxString &SQLState);
636 wxDbInf *GetCatalog(const wxChar *userID=NULL);
637 bool Catalog(const wxChar *userID=NULL, const wxString &fileName=SQL_CATALOG_FILENAME);
02cf6fdd 638 int GetKeyFields(const wxString &tableName, wxDbColInf* colInf, UWORD noCols);
4fdae997
GT
639
640 wxDbColInf *GetColumns(wxChar *tableName[], const wxChar *userID=NULL);
02cf6fdd 641 wxDbColInf *GetColumns(const wxString &tableName, UWORD *numCols, const wxChar *userID=NULL);
4fdae997 642
dba2120c 643 int GetColumnCount(const wxString &tableName, const wxChar *userID=NULL);
b742792c 644 const wxChar *GetDatabaseName(void) {return dbInf.dbmsName;}
4fdae997
GT
645 const wxString &GetDataSource(void) {return dsn;}
646 const wxString &GetDatasourceName(void){return dsn;}
647 const wxString &GetUsername(void) {return uid;}
648 const wxString &GetPassword(void) {return authStr;}
0907ea9c
GT
649 const wxString &GetConnectionInStr(void) {return inConnectionStr;}
650 const wxString &GetConnectionOutStr(void) {return outConnectionStr;}
b742792c 651 bool IsOpen(void) {return dbIsOpen;}
0907ea9c 652 bool OpenedWithConnectionString(void) {return dbOpenedWithConnectionString;}
b742792c
GT
653 HENV GetHENV(void) {return henv;}
654 HDBC GetHDBC(void) {return hdbc;}
655 HSTMT GetHSTMT(void) {return hstmt;}
656 int GetTableCount() {return nTables;} // number of tables using this connection
657 wxDbSqlTypeInfo GetTypeInfVarchar() {return typeInfVarchar;}
658 wxDbSqlTypeInfo GetTypeInfInteger() {return typeInfInteger;}
659 wxDbSqlTypeInfo GetTypeInfFloat() {return typeInfFloat;}
660 wxDbSqlTypeInfo GetTypeInfDate() {return typeInfDate;}
661 wxDbSqlTypeInfo GetTypeInfBlob() {return typeInfBlob;}
662
663 // tableName can refer to a table, view, alias or synonym
664 bool TableExists(const wxString &tableName, const wxChar *userID=NULL,
665 const wxString &tablePath=wxEmptyString);
666 bool TablePrivileges(const wxString &tableName, const wxString &priv,
667 const wxChar *userID=NULL, const wxChar *schema=NULL,
668 const wxString &path=wxEmptyString);
669
243d4b36
GT
670 // These two functions return the table name or column name in a form ready
671 // for use in SQL statements. For example, if the datasource allows spaces
672 // in the table name or column name, the returned string will have the
673 // correct enclosing marks around the name to allow it to be properly
674 // included in a SQL statement
5bdad317
GT
675 const wxString SQLTableName(const wxChar *tableName);
676 const wxString SQLColumnName(const wxChar *colName);
243d4b36 677
b742792c
GT
678 void LogError(const wxString &errMsg, const wxString &SQLState = wxEmptyString)
679 { logError(errMsg, SQLState); }
f6bcfd97 680 void SetDebugErrorMessages(bool state) { silent = !state; }
b742792c 681 bool SetSqlLogging(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME,
a144affe 682 bool append = FALSE);
4fdae997 683 bool WriteSqlLog(const wxString &logMsg);
b742792c 684
fdc03678 685 wxDBMS Dbms(void);
4fdae997
GT
686 bool ModifyColumn(const wxString &tableName, const wxString &columnName,
687 int dataType, ULONG columnLength=0,
da99271d 688 const wxString &optionalParam=wxEmptyString);
4fdae997 689
f6bcfd97
BP
690 bool FwdOnlyCursors(void) {return fwdOnlyCursors;}
691
692 // These two functions are provided strictly for use by wxDbTable.
693 // DO NOT USE THESE FUNCTIONS, OR MEMORY LEAKS MAY OCCUR
694 void incrementTableCount() { nTables++; return; }
695 void decrementTableCount() { nTables--; return; }
696
697}; // wxDb
108106cf 698
fdc03678 699
108106cf
JS
700// This structure forms a node in a linked list. The linked list of "DbList" objects
701// keeps track of allocated database connections. This allows the application to
702// open more than one database connection through ODBC for multiple transaction support
703// or for multiple database support.
fdc03678 704struct wxDbList
108106cf 705{
4fdae997
GT
706 wxDbList *PtrPrev; // Pointer to previous item in the list
707 wxString Dsn; // Data Source Name
708 wxString Uid; // User ID
709 wxString AuthStr; // Authorization string (password)
0907ea9c 710 wxString ConnectionStr; // Connection string used instead of DSN
4fdae997
GT
711 wxDb *PtrDb; // Pointer to the wxDb object
712 bool Free; // Is item free or in use?
713 wxDbList *PtrNext; // Pointer to next item in the list
108106cf
JS
714};
715
5cf34cf0 716
154f22b3 717#ifdef __WXDEBUG__
e115e771 718#include "wx/object.h"
fdc03678 719class wxTablesInUse : public wxObject
a2115c88 720{
95ca6a20 721 public:
4fdae997 722 const wxChar *tableName;
95ca6a20 723 ULONG tableID;
f6bcfd97 724 class wxDb *pDb;
fdc03678 725}; // wxTablesInUse
a2115c88
GT
726#endif
727
fdc03678 728
108106cf
JS
729// The following routines allow a user to get new database connections, free them
730// for other code segments to use, or close all of them when the application has
731// completed.
bb41dcbe
VS
732wxDb WXDLLIMPEXP_ODBC *wxDbGetConnection(wxDbConnectInf *pDbConfig, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
733bool WXDLLIMPEXP_ODBC wxDbFreeConnection(wxDb *pDb);
734void WXDLLIMPEXP_ODBC wxDbCloseConnections(void);
735int WXDLLIMPEXP_ODBC wxDbConnectionsInUse(void);
95ca6a20 736
108106cf 737
20987580
GT
738// Writes a message to the wxLog window (stdout usually) when an internal error
739// situation occurs. This function only works in DEBUG builds
f157ad08 740const wxChar WXDLLIMPEXP_ODBC *
886dd7d2
VZ
741wxDbLogExtendedErrorMsg(const wxChar *userText,
742 wxDb *pDb,
743 const wxChar *ErrFile,
744 int ErrLine);
5bdad317 745
20987580 746
f6bcfd97 747// This function sets the sql log state for all open wxDb objects
bb41dcbe 748bool WXDLLIMPEXP_ODBC
886dd7d2 749wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);
fdc03678 750
95ca6a20 751
fdc03678
GT
752#if 0
753// MSW/VC6 ONLY!!! Experimental
da99271d 754int WXDLLEXPORT wxDbCreateDataSource(const wxString &driverName, const wxString &dsn, const wxString &description=wxEmptyString,
a144affe 755 bool sysDSN=FALSE, const wxString &defDir=wxEmptyString, wxWindow *parent=NULL);
fdc03678 756#endif
a2115c88 757
108106cf
JS
758// This routine allows you to query a driver manager
759// for a list of available datasources. Call this routine
760// the first time using SQL_FETCH_FIRST. Continue to call it
761// using SQL_FETCH_NEXT until you've exhausted the list.
bb41dcbe 762bool WXDLLIMPEXP_ODBC
886dd7d2
VZ
763wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMax, wxChar *DsDesc,
764 SWORD DsDescMax, UWORD direction = SQL_FETCH_NEXT);
fdc03678
GT
765
766
767// Change this to 0 to remove use of all deprecated functions
f6bcfd97 768#if wxODBC_BACKWARD_COMPATABILITY
fdc03678
GT
769//#################################################################################
770//############### DEPRECATED functions for backward compatability #################
771//#################################################################################
772
773// Backward compability structures/classes. This will eventually go away
f6bcfd97
BP
774const int DB_PATH_MAX = wxDB_PATH_MAX;
775
776typedef wxDb wxDB;
777typedef wxDbTableInf wxTableInf;
778typedef wxDbColInf wxColInf;
779typedef wxDbColInf CcolInf;
780typedef wxDbColFor wxColFor;
781typedef wxDbSqlTypeInfo SqlTypeInfo;
782typedef wxDbSqlTypeInfo wxSqlTypeInfo;
783typedef enum wxDbSqlLogState sqlLog;
784typedef enum wxDbSqlLogState wxSqlLogState;
785typedef enum wxDBMS dbms;
786typedef enum wxDBMS DBMS;
787typedef wxODBC_ERRORS ODBC_ERRORS;
788typedef wxDbConnectInf DbStuff;
789typedef wxDbList DbList;
27508856 790#ifdef __WXDEBUG__
f6bcfd97 791typedef wxTablesInUse CstructTablesInUse;
27508856 792#endif
fdc03678
GT
793
794// Deprecated function names that are replaced by the function names listed above
bb41dcbe 795wxDB WXDLLIMPEXP_ODBC
886dd7d2 796*GetDbConnection(DbStuff *pDbStuff, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
bb41dcbe
VS
797bool WXDLLIMPEXP_ODBC FreeDbConnection(wxDB *pDb);
798void WXDLLIMPEXP_ODBC CloseDbConnections(void);
799int WXDLLIMPEXP_ODBC NumberDbConnectionsInUse(void);
fdc03678 800
2b5f62a0 801bool SqlLog(sqlLog state, const wxChar *filename = SQL_LOG_FILENAME);
fdc03678 802
bb41dcbe 803bool WXDLLIMPEXP_ODBC
886dd7d2
VZ
804GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
805 UWORD direction = SQL_FETCH_NEXT);
806
fdc03678 807#endif // Deprecated structures/classes/functions
108106cf 808
2b5f62a0
VZ
809#endif // _WX_DB_H_
810