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