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