projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Use defs.h (and automatically setup.h and chkconf.h) before first wxUSE_* check ...
[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
23 ///////////////////////////////////////////////////////////////////////////////
24
25 #ifndef _WX_DB_H_
26 #define _WX_DB_H_
27
28
29 // BJO 20000503: introduce new GetColumns members which are more database independant and
30 // return columns in the order they were created
31 #define OLD_GETCOLUMNS 1
32 #define EXPERIMENTAL_WXDB_FUNCTIONS 1
33
34 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
35 #pragma interface "db.h"
36 #endif
37
38 #include "wx/defs.h"
39 #include "wx/string.h"
40
41 #if defined(__VISUALC__)
42 // we need to include standard Windows headers but we can't include
43 // <windows.h> directly when using MFC because it includes it itself in a
44 // different manner
45 #if wxUSE_MFC
46 #include <afxwin.h>
47 #else // !wxUSE_MFC
48 #ifndef STRICT
49 #define STRICT 1
50 #endif
51
52 #include <windows.h>
53 #include "wx/msw/winundef.h"
54 #endif // wxUSE_MFC/!wxUSE_MFC
55
56 // If you use the wxDbCreateDataSource() function with MSW/VC6,
57 // you cannot use the iODBC headers, you must use the VC headers,
58 // plus the odbcinst.h header - gt Nov 2 2000
59 //
60 // Must add "odbccp32.lib" in \wx2\wxWidgets\src\makevc.env to the WINLIBS= line
61 //
62 #include "sql.h"
63 #include "sqlext.h"
64 //#if wxUSE_UNICODE
65 // #include <sqlucode.h>
66 //#endif
67 #include "odbcinst.h"
68 #else
69 #if defined(__WINDOWS__) && ( defined(HAVE_W32API_H) || defined(__BORLANDC__) )
70 #include <windows.h>
71 #include "wx/msw/winundef.h"
72 #endif
73 extern "C" {
74 #if defined(wxUSE_BUILTIN_IODBC) && wxUSE_BUILTIN_IODBC
75 // Use the ones from the library
76 #include "wx/isql.h"
77 #include "wx/isqlext.h"
78 // Not available in v2.x of iODBC
79 #ifndef __WXMSW__
80 typedef wxChar SQLTCHAR;
81 #endif
82 #else
83 #include <sql.h>
84 #include <sqlext.h>
85 //#if wxUSE_UNICODE
86 // #include <sqlucode.h>
87 //#endif
88 #endif
89 }
90 #endif
91
92 #if wxUSE_UNICODE
93 #define SQL_C_WXCHAR SQL_C_WCHAR
94 #else
95 #define SQL_C_WXCHAR SQL_C_CHAR
96 #endif
97
98 typedef float SFLOAT;
99 typedef double SDOUBLE;
100 typedef unsigned int UINT;
101 #define ULONG UDWORD
102
103 #ifndef wxODBC_FWD_ONLY_CURSORS
104 #define wxODBC_FWD_ONLY_CURSORS 1
105 #endif
106
107 enum enumDummy {enumDum1};
108
109 #ifndef SQL_C_BOOLEAN
110 #define SQL_C_BOOLEAN(datatype) (sizeof(datatype) == 1 ? SQL_C_UTINYINT : (sizeof(datatype) == 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 // NOTE: If SQL_C_BLOB is defined, and it is not SQL_C_BINARY, iODBC 2.x
118 // may not function correctly. Likely best to use SQL_C_BINARY direct
119 #ifndef SQL_C_BLOB
120 #ifdef SQL_C_BINARY
121 #define SQL_C_BLOB SQL_C_BINARY
122 #endif
123 #endif
124
125 const int wxDB_PATH_MAX = 254;
126
127 extern WXDLLIMPEXP_DATA_ODBC(wxChar const *) SQL_LOG_FILENAME;
128 extern WXDLLIMPEXP_DATA_ODBC(wxChar const *) SQL_CATALOG_FILENAME;
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 #ifndef SQL_MAX_CONNECTSTR_LEN
274 // There does not seem to be a standard for this, so I am
275 // defaulting to the value that MS recommends
276 #define SQL_MAX_CONNECTSTR_LEN 1024
277 #endif
278
279
280 class WXDLLIMPEXP_ODBC wxDbConnectInf
281 {
282 private:
283 bool freeHenvOnDestroy;
284 bool useConnectionStr;
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 wxChar ConnectionStr[SQL_MAX_CONNECTSTR_LEN+1]; // Connection string (password)
292
293 wxString Description; // Not sure what the max length is
294 wxString FileType; // Not sure what the max length is
295
296 // Optionals needed for some databases like dBase
297 wxString DefaultDir; // Directory that db file resides in
298
299 public:
300
301 wxDbConnectInf();
302 wxDbConnectInf(HENV henv, const wxString &dsn, const wxString &userID=wxEmptyString,
303 const wxString &password=wxEmptyString, const wxString &defaultDir=wxEmptyString,
304 const wxString &description=wxEmptyString, const wxString &fileType=wxEmptyString);
305
306 ~wxDbConnectInf();
307
308 bool Initialize();
309
310 bool AllocHenv();
311 void FreeHenv();
312
313 // Accessors
314 const HENV &GetHenv() { return Henv; };
315
316 const wxChar *GetDsn() { return Dsn; };
317
318 const wxChar *GetUid() { return Uid; };
319 const wxChar *GetUserID() { return Uid; };
320
321 const wxChar *GetAuthStr() { return AuthStr; };
322 const wxChar *GetPassword() { return AuthStr; };
323
324 const wxChar *GetConnectionStr() { return ConnectionStr; };
325 bool UseConnectionStr() { return useConnectionStr; };
326
327 const wxChar *GetDescription() { return Description; };
328 const wxChar *GetFileType() { return FileType; };
329 const wxChar *GetDefaultDir() { return DefaultDir; };
330
331 void SetHenv(const HENV henv) { Henv = henv; };
332
333 void SetDsn(const wxString &dsn);
334
335 void SetUserID(const wxString &userID);
336 void SetUid(const wxString &uid) { SetUserID(uid); };
337
338 void SetPassword(const wxString &password);
339 void SetAuthStr(const wxString &authstr) { SetPassword(authstr); };
340
341 void SetConnectionStr(const wxString &connectStr);
342
343 void SetDescription(const wxString &desc) { Description = desc; };
344 void SetFileType(const wxString &fileType) { FileType = fileType; };
345 void SetDefaultDir(const wxString &defDir) { DefaultDir = defDir; };
346 }; // class wxDbConnectInf
347
348
349 struct WXDLLIMPEXP_ODBC wxDbSqlTypeInfo
350 {
351 wxString TypeName;
352 SWORD FsqlType;
353 long Precision;
354 short CaseSensitive;
355 short MaximumScale;
356 };
357
358
359 class WXDLLIMPEXP_ODBC wxDbColFor
360 {
361 public:
362 wxString s_Field; // Formated String for Output
363 wxString s_Format[7]; // Formated Objects - TIMESTAMP has the biggest (7)
364 wxString s_Amount[7]; // Formated Objects - amount of things that can be formatted
365 int i_Amount[7]; // Formated Objects - TT MM YYYY HH MM SS m
366 int i_Nation; // 0 = timestamp , 1=EU, 2=UK, 3=International, 4=US
367 int i_dbDataType; // conversion of the 'sqlDataType' to the generic data type used by these classes
368 SWORD i_sqlDataType;
369
370 wxDbColFor();
371 ~wxDbColFor(){}
372
373 void Initialize();
374 int Format(int Nation, int dbDataType, SWORD sqlDataType, short columnLength, short decimalDigits);
375 };
376
377
378 class WXDLLIMPEXP_ODBC wxDbColInf
379 {
380 public:
381 wxChar catalog[128+1];
382 wxChar schema[128+1];
383 wxChar tableName[DB_MAX_TABLE_NAME_LEN+1];
384 wxChar colName[DB_MAX_COLUMN_NAME_LEN+1];
385 SWORD sqlDataType;
386 wxChar typeName[128+1];
387 SWORD columnLength;
388 SWORD bufferSize;
389 short decimalDigits;
390 short numPrecRadix;
391 short nullable;
392 wxChar remarks[254+1];
393 int dbDataType; // conversion of the 'sqlDataType' to the generic data type used by these classes
394 // mj10777.19991224 : new
395 int PkCol; // Primary key column 0=No; 1= First Key, 2 = Second Key etc.
396 wxChar PkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Tables that use this PKey as a FKey
397 int FkCol; // Foreign key column 0=No; 1= First Key, 2 = Second Key etc.
398 wxChar FkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Foreign key table name
399 wxDbColFor *pColFor; // How should this columns be formatted
400
401 wxDbColInf();
402 ~wxDbColInf();
403
404 bool Initialize();
405 };
406
407
408 class WXDLLIMPEXP_ODBC wxDbTableInf // Description of a Table
409 {
410 public:
411 wxChar tableName[DB_MAX_TABLE_NAME_LEN+1];
412 wxChar tableType[254+1]; // "TABLE" or "SYSTEM TABLE" etc.
413 wxChar tableRemarks[254+1];
414 UWORD numCols; // How many Columns does this Table have: GetColumnCount(..);
415 wxDbColInf *pColInf; // pColInf = NULL ; User can later call GetColumns(..);
416
417 wxDbTableInf();
418 ~wxDbTableInf();
419
420 bool Initialize();
421 };
422
423
424 class WXDLLIMPEXP_ODBC wxDbInf // Description of a Database
425 {
426 public:
427 wxChar catalog[128+1];
428 wxChar schema[128+1];
429 int numTables; // How many tables does this database have
430 wxDbTableInf *pTableInf; // pTableInf = new wxDbTableInf[numTables];
431
432 wxDbInf();
433 ~wxDbInf();
434
435 bool Initialize();
436 };
437
438
439 enum wxDbSqlLogState
440 {
441 sqlLogOFF,
442 sqlLogON
443 };
444
445 // These are the databases currently tested and working with these classes
446 // See the comments in wxDb::Dbms() for exceptions/issues with
447 // each of these database engines
448 enum wxDBMS
449 {
450 dbmsUNIDENTIFIED,
451 dbmsORACLE,
452 dbmsSYBASE_ASA, // Adaptive Server Anywhere
453 dbmsSYBASE_ASE, // Adaptive Server Enterprise
454 dbmsMS_SQL_SERVER,
455 dbmsMY_SQL,
456 dbmsPOSTGRES,
457 dbmsACCESS,
458 dbmsDBASE,
459 dbmsINFORMIX,
460 dbmsVIRTUOSO,
461 dbmsDB2,
462 dbmsINTERBASE,
463 dbmsPERVASIVE_SQL,
464 dbmsXBASE_SEQUITER,
465 dbmsFIREBIRD,
466 dbmsMAXDB,
467 dbmsFuture1,
468 dbmsFuture2,
469 dbmsFuture3,
470 dbmsFuture4,
471 dbmsFuture5,
472 dbmsFuture6,
473 dbmsFuture7,
474 dbmsFuture8,
475 dbmsFuture9,
476 dbmsFuture10
477 };
478
479
480 // The wxDb::errorList is copied to this variable when the wxDb object
481 // is closed. This way, the error list is still available after the
482 // database object is closed. This is necessary if the database
483 // connection fails so the calling application can show the operator
484 // why the connection failed. Note: as each wxDb object is closed, it
485 // will overwrite the errors of the previously destroyed wxDb object in
486 // this variable.
487
488 extern WXDLLIMPEXP_DATA_ODBC(wxChar)
489 DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN+1];
490
491
492 class WXDLLIMPEXP_ODBC wxDb
493 {
494 private:
495 bool dbIsOpen;
496 bool dbIsCached; // Was connection created by caching functions
497 bool dbOpenedWithConnectionString; // Was the database connection opened with a connection string
498 wxString dsn; // Data source name
499 wxString uid; // User ID
500 wxString authStr; // Authorization string (password)
501 wxString inConnectionStr; // Connection string used to connect to the database
502 wxString outConnectionStr;// Connection string returned by the database when a connection is successfully opened
503 FILE *fpSqlLog; // Sql Log file pointer
504 wxDbSqlLogState sqlLogState; // On or Off
505 bool fwdOnlyCursors;
506 wxDBMS dbmsType; // Type of datasource - i.e. Oracle, dBase, SQLServer, etc
507
508 // Private member functions
509 bool getDbInfo(bool failOnDataTypeUnsupported=true);
510 bool getDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo);
511 bool setConnectionOptions(void);
512 void logError(const wxString &errMsg, const wxString &SQLState);
513 const wxChar *convertUserID(const wxChar *userID, wxString &UserID);
514 bool determineDataTypes(bool failOnDataTypeUnsupported);
515 void initialize();
516 bool open(bool failOnDataTypeUnsupported=true);
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
530 // Information about logical data types VARCHAR, INTEGER, FLOAT and DATE.
531 //
532 // This information is obtained from the ODBC driver by use of the
533 // SQLGetTypeInfo() function. The key piece of information is the
534 // type name the data source uses for each logical data type.
535 // e.g. VARCHAR; Oracle calls it VARCHAR2.
536 wxDbSqlTypeInfo typeInfVarchar;
537 wxDbSqlTypeInfo typeInfInteger;
538 wxDbSqlTypeInfo typeInfFloat;
539 wxDbSqlTypeInfo typeInfDate;
540 wxDbSqlTypeInfo typeInfBlob;
541 #endif
542
543 public:
544
545 void setCached(bool cached) { dbIsCached = cached; }; // This function must only be called by wxDbGetConnection() and wxDbCloseConnections!!!
546 bool IsCached() { return dbIsCached; };
547
548 bool GetDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo)
549 { return getDataTypeInfo(fSqlType, structSQLTypeInfo); }
550
551 #if wxODBC_BACKWARD_COMPATABILITY
552 // ODBC handles
553 HENV henv; // ODBC Environment handle
554 HDBC hdbc; // ODBC DB Connection handle
555 HSTMT hstmt; // ODBC Statement handle
556
557 //Error reporting mode
558 bool silent;
559
560 // Number of Ctable objects connected to this db object. FOR INTERNAL USE ONLY!!!
561 unsigned int nTables;
562 #endif
563
564 // The following structure contains database information gathered from the
565 // datasource when the datasource is first opened.
566 struct
567 {
568 wxChar dbmsName[40]; // Name of the dbms product
569 wxChar dbmsVer[64]; // Version # of the dbms product
570 wxChar driverName[40]; // Driver name
571 wxChar odbcVer[60]; // ODBC version of the driver
572 wxChar drvMgrOdbcVer[60]; // ODBC version of the driver manager
573 wxChar driverVer[60]; // Driver version
574 wxChar serverName[80]; // Server Name, typically a connect string
575 wxChar databaseName[128]; // Database filename
576 wxChar outerJoins[2]; // Indicates whether the data source supports outer joins
577 wxChar procedureSupport[2]; // Indicates whether the data source supports stored procedures
578 wxChar accessibleTables[2]; // Indicates whether the data source only reports accessible tables in SQLTables.
579 UWORD maxConnections; // Maximum # of connections the data source supports
580 UWORD maxStmts; // Maximum # of HSTMTs per HDBC
581 UWORD apiConfLvl; // ODBC API conformance level
582 UWORD cliConfLvl; // Indicates whether the data source is SAG compliant
583 UWORD sqlConfLvl; // SQL conformance level
584 UWORD cursorCommitBehavior; // Indicates how cursors are affected by a db commit
585 UWORD cursorRollbackBehavior; // Indicates how cursors are affected by a db rollback
586 UWORD supportNotNullClause; // Indicates if data source supports NOT NULL clause
587 wxChar supportIEF[2]; // Integrity Enhancement Facility (Referential Integrity)
588 UDWORD txnIsolation; // Default transaction isolation level supported by the driver
589 UDWORD txnIsolationOptions; // Transaction isolation level options available
590 UDWORD fetchDirections; // Fetch directions supported
591 UDWORD lockTypes; // Lock types supported in SQLSetPos
592 UDWORD posOperations; // Position operations supported in SQLSetPos
593 UDWORD posStmts; // Position statements supported
594 UDWORD scrollConcurrency; // Concurrency control options supported for scrollable cursors
595 UDWORD scrollOptions; // Scroll Options supported for scrollable cursors
596 UDWORD staticSensitivity; // Indicates if additions, deletions and updates can be detected
597 UWORD txnCapable; // Indicates if the data source supports transactions
598 UDWORD loginTimeout; // Number seconds to wait for a login request
599 } dbInf;
600
601 // ODBC Error Inf.
602 SWORD cbErrorMsg;
603 int DB_STATUS;
604 #ifdef __VMS
605 // The DECC compiler chokes when in db.cpp the array is accessed outside
606 // its bounds. Maybe this change should also applied for other platforms.
607 wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN+1];
608 #else
609 wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
610 #endif
611 wxChar errorMsg[SQL_MAX_MESSAGE_LENGTH];
612 SDWORD nativeError;
613 wxChar sqlState[20];
614
615 #if wxODBC_BACKWARD_COMPATABILITY
616 // Information about logical data types VARCHAR, INTEGER, FLOAT and DATE.
617 //
618 // This information is obtained from the ODBC driver by use of the
619 // SQLGetTypeInfo() function. The key piece of information is the
620 // type name the data source uses for each logical data type.
621 // e.g. VARCHAR; Oracle calls it VARCHAR2.
622 wxDbSqlTypeInfo typeInfVarchar;
623 wxDbSqlTypeInfo typeInfInteger;
624 wxDbSqlTypeInfo typeInfFloat;
625 wxDbSqlTypeInfo typeInfDate;
626 wxDbSqlTypeInfo typeInfBlob;
627 #endif
628
629 // Public member functions
630 wxDb(const HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
631 ~wxDb();
632
633 // Data Source Name, User ID, Password and whether open should fail on data type not supported
634 bool Open(const wxString& inConnectStr, bool failOnDataTypeUnsupported=true);
635 bool Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr, bool failOnDataTypeUnsupported=true);
636 bool Open(wxDbConnectInf *dbConnectInf, bool failOnDataTypeUnsupported=true);
637 bool Open(wxDb *copyDb); // pointer to a wxDb whose connection info should be copied rather than re-queried
638 void Close(void);
639 bool CommitTrans(void);
640 bool RollbackTrans(void);
641 bool DispAllErrors(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
642 bool GetNextError(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
643 void DispNextError(void);
644 bool CreateView(const wxString &viewName, const wxString &colList, const wxString &pSqlStmt, bool attemptDrop=true);
645 bool DropView(const wxString &viewName);
646 bool ExecSql(const wxString &pSqlStmt);
647 bool ExecSql(const wxString &pSqlStmt, wxDbColInf** columns, short& numcols);
648 bool GetNext(void);
649 bool GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SDWORD FAR *cbReturned);
650 bool Grant(int privileges, const wxString &tableName, const wxString &userList = wxT("PUBLIC"));
651 int TranslateSqlState(const wxString &SQLState);
652 wxDbInf *GetCatalog(const wxChar *userID=NULL);
653 bool Catalog(const wxChar *userID=NULL, const wxString &fileName=SQL_CATALOG_FILENAME);
654 int GetKeyFields(const wxString &tableName, wxDbColInf* colInf, UWORD noCols);
655
656 wxDbColInf *GetColumns(wxChar *tableName[], const wxChar *userID=NULL);
657 wxDbColInf *GetColumns(const wxString &tableName, UWORD *numCols, const wxChar *userID=NULL);
658
659 int GetColumnCount(const wxString &tableName, const wxChar *userID=NULL);
660 const wxChar *GetDatabaseName(void) {return dbInf.dbmsName;}
661 const wxString &GetDataSource(void) {return dsn;}
662 const wxString &GetDatasourceName(void){return dsn;}
663 const wxString &GetUsername(void) {return uid;}
664 const wxString &GetPassword(void) {return authStr;}
665 const wxString &GetConnectionInStr(void) {return inConnectionStr;}
666 const wxString &GetConnectionOutStr(void) {return outConnectionStr;}
667 bool IsOpen(void) {return dbIsOpen;}
668 bool OpenedWithConnectionString(void) {return dbOpenedWithConnectionString;}
669 HENV GetHENV(void) {return henv;}
670 HDBC GetHDBC(void) {return hdbc;}
671 HSTMT GetHSTMT(void) {return hstmt;}
672 int GetTableCount() {return nTables;} // number of tables using this connection
673 wxDbSqlTypeInfo GetTypeInfVarchar() {return typeInfVarchar;}
674 wxDbSqlTypeInfo GetTypeInfInteger() {return typeInfInteger;}
675 wxDbSqlTypeInfo GetTypeInfFloat() {return typeInfFloat;}
676 wxDbSqlTypeInfo GetTypeInfDate() {return typeInfDate;}
677 wxDbSqlTypeInfo GetTypeInfBlob() {return typeInfBlob;}
678
679 // tableName can refer to a table, view, alias or synonym
680 bool TableExists(const wxString &tableName, const wxChar *userID=NULL,
681 const wxString &tablePath=wxEmptyString);
682 bool TablePrivileges(const wxString &tableName, const wxString &priv,
683 const wxChar *userID=NULL, const wxChar *schema=NULL,
684 const wxString &path=wxEmptyString);
685
686 // These two functions return the table name or column name in a form ready
687 // for use in SQL statements. For example, if the datasource allows spaces
688 // in the table name or column name, the returned string will have the
689 // correct enclosing marks around the name to allow it to be properly
690 // included in a SQL statement
691 const wxString SQLTableName(const wxChar *tableName);
692 const wxString SQLColumnName(const wxChar *colName);
693
694 void LogError(const wxString &errMsg, const wxString &SQLState = wxEmptyString)
695 { logError(errMsg, SQLState); }
696 void SetDebugErrorMessages(bool state) { silent = !state; }
697 bool SetSqlLogging(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME,
698 bool append = false);
699 bool WriteSqlLog(const wxString &logMsg);
700
701 wxDBMS Dbms(void);
702 bool ModifyColumn(const wxString &tableName, const wxString &columnName,
703 int dataType, ULONG columnLength=0,
704 const wxString &optionalParam=wxEmptyString);
705
706 bool FwdOnlyCursors(void) {return fwdOnlyCursors;}
707
708 // These two functions are provided strictly for use by wxDbTable.
709 // DO NOT USE THESE FUNCTIONS, OR MEMORY LEAKS MAY OCCUR
710 void incrementTableCount() { nTables++; return; }
711 void decrementTableCount() { nTables--; return; }
712
713 }; // wxDb
714
715
716 // This structure forms a node in a linked list. The linked list of "DbList" objects
717 // keeps track of allocated database connections. This allows the application to
718 // open more than one database connection through ODBC for multiple transaction support
719 // or for multiple database support.
720 struct wxDbList
721 {
722 wxDbList *PtrPrev; // Pointer to previous item in the list
723 wxString Dsn; // Data Source Name
724 wxString Uid; // User ID
725 wxString AuthStr; // Authorization string (password)
726 wxString ConnectionStr; // Connection string used instead of DSN
727 wxDb *PtrDb; // Pointer to the wxDb object
728 bool Free; // Is item free or in use?
729 wxDbList *PtrNext; // Pointer to next item in the list
730 };
731
732
733 #ifdef __WXDEBUG__
734 #include "wx/object.h"
735 class wxTablesInUse : public wxObject
736 {
737 public:
738 const wxChar *tableName;
739 ULONG tableID;
740 class wxDb *pDb;
741 }; // wxTablesInUse
742 #endif
743
744
745 // The following routines allow a user to get new database connections, free them
746 // for other code segments to use, or close all of them when the application has
747 // completed.
748 wxDb WXDLLIMPEXP_ODBC *wxDbGetConnection(wxDbConnectInf *pDbConfig, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
749 bool WXDLLIMPEXP_ODBC wxDbFreeConnection(wxDb *pDb);
750 void WXDLLIMPEXP_ODBC wxDbCloseConnections(void);
751 int WXDLLIMPEXP_ODBC wxDbConnectionsInUse(void);
752
753
754 // Writes a message to the wxLog window (stdout usually) when an internal error
755 // situation occurs. This function only works in DEBUG builds
756 const wxChar WXDLLIMPEXP_ODBC *
757 wxDbLogExtendedErrorMsg(const wxChar *userText,
758 wxDb *pDb,
759 const wxChar *ErrFile,
760 int ErrLine);
761
762
763 // This function sets the sql log state for all open wxDb objects
764 bool WXDLLIMPEXP_ODBC
765 wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);
766
767
768 #if 0
769 // MSW/VC6 ONLY!!! Experimental
770 int WXDLLEXPORT wxDbCreateDataSource(const wxString &driverName, const wxString &dsn, const wxString &description=wxEmptyString,
771 bool sysDSN=false, const wxString &defDir=wxEmptyString, wxWindow *parent=NULL);
772 #endif
773
774 // This routine allows you to query a driver manager
775 // for a list of available datasources. Call this routine
776 // the first time using SQL_FETCH_FIRST. Continue to call it
777 // using SQL_FETCH_NEXT until you've exhausted the list.
778 bool WXDLLIMPEXP_ODBC
779 wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMaxLength, wxChar *DsDesc,
780 SWORD DsDescMaxLength, UWORD direction = SQL_FETCH_NEXT);
781
782
783 // Change this to 0 to remove use of all deprecated functions
784 #if wxODBC_BACKWARD_COMPATABILITY
785 //#################################################################################
786 //############### DEPRECATED functions for backward compatability #################
787 //#################################################################################
788
789 // Backward compability structures/classes. This will eventually go away
790 const int DB_PATH_MAX = wxDB_PATH_MAX;
791
792 typedef wxDb wxDB;
793 typedef wxDbTableInf wxTableInf;
794 typedef wxDbColInf wxColInf;
795 typedef wxDbColInf CcolInf;
796 typedef wxDbColFor wxColFor;
797 typedef wxDbSqlTypeInfo SqlTypeInfo;
798 typedef wxDbSqlTypeInfo wxSqlTypeInfo;
799 typedef enum wxDbSqlLogState sqlLog;
800 typedef enum wxDbSqlLogState wxSqlLogState;
801 typedef enum wxDBMS dbms;
802 typedef enum wxDBMS DBMS;
803 typedef wxODBC_ERRORS ODBC_ERRORS;
804 typedef wxDbConnectInf DbStuff;
805 typedef wxDbList DbList;
806 #ifdef __WXDEBUG__
807 typedef wxTablesInUse CstructTablesInUse;
808 #endif
809
810 // Deprecated function names that are replaced by the function names listed above
811 wxDB WXDLLIMPEXP_ODBC
812 *GetDbConnection(DbStuff *pDbStuff, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
813 bool WXDLLIMPEXP_ODBC FreeDbConnection(wxDB *pDb);
814 void WXDLLIMPEXP_ODBC CloseDbConnections(void);
815 int WXDLLIMPEXP_ODBC NumberDbConnectionsInUse(void);
816
817 bool SqlLog(sqlLog state, const wxChar *filename = SQL_LOG_FILENAME);
818
819 bool WXDLLIMPEXP_ODBC
820 GetDataSource(HENV henv, char *Dsn, SWORD DsnMaxLength, char *DsDesc, SWORD DsDescMaxLength,
821 UWORD direction = SQL_FETCH_NEXT);
822
823 #endif // Deprecated structures/classes/functions
824
825 #endif // _WX_DB_H_
826
wxWidgets (Impactor)