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