Added preliminary support for Informix
[wxWidgets.git] / include / wx / db.h
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:
8 // Mods: Dec, 1998:
9 // -Added support for SQL statement logging and database cataloging
10 // April, 1999
11 // -Added QUERY_ONLY mode support to reduce default number of cursors
12 // -Added additional SQL logging code
13 // -Added DEBUG-ONLY tracking of Ctable objects to detect orphaned DB connections
14 // -Set ODBC option to only read committed writes to the DB so all
15 // databases operate the same in that respect
16 //
17 // Created: 9.96
18 // RCS-ID: $Id$
19 // Copyright: (c) 1996 Remstar International, Inc.
20 // Licence: wxWindows licence, plus:
21 // Notice: This class library and its intellectual design are free of charge for use,
22 // modification, enhancement, debugging under the following conditions:
23 // 1) These classes may only be used as part of the implementation of a
24 // wxWindows-based application
25 // 2) All enhancements and bug fixes are to be submitted back to the wxWindows
26 // user groups free of all charges for use with the wxWindows library.
27 // 3) These classes may not be distributed as part of any other class library,
28 // DLL, text (written or electronic), other than a complete distribution of
29 // the wxWindows GUI development toolkit.
30 //
31 ///////////////////////////////////////////////////////////////////////////////
32
33 /*
34 // SYNOPSIS START
35 // SYNOPSIS STOP
36 */
37
38 #ifndef DB_DOT_H
39 #define DB_DOT_H
40
41 // Use this line for wxWindows v1.x
42 //#include "wx_ver.h"
43 // Use this line for wxWindows v2.x
44 #include "wx/version.h"
45
46 #if wxMAJOR_VERSION == 2
47 #ifdef __GNUG__
48 #pragma interface "db.h"
49 #endif
50 #endif
51
52 #if defined(wx_msw) || defined(__WXMSW__) || defined(WIN32)
53 #include <windows.h>
54 #endif
55
56 #ifdef __UNIX__
57 #if wxMAJOR_VERSION == 2
58 extern "C" {
59 #include "../../src/iodbc/isql.h"
60 #include "../../src/iodbc/isqlext.h"
61 }
62 #else // version == 1
63 extern "C" {
64 #include "iodbc.h"
65 #include "isqlext.h"
66 }
67 #endif
68 typedef float SFLOAT;
69 typedef double SDOUBLE;
70 typedef unsigned int UINT;
71 #define ULONG UDWORD
72 #elif defined(__WXMAC__)
73 extern "C" {
74 #include "../../src/iodbc/isql.h"
75 #include "../../src/iodbc/isqlext.h"
76 }
77 typedef float SFLOAT;
78 typedef double SDOUBLE;
79 typedef unsigned int UINT;
80 #define ULONG UDWORD
81 #else // msw
82 #define ODBCVER 0x0250
83 #include <sql.h>
84 #include <sqlext.h>
85 #endif
86
87 #ifdef __UNIX__
88 # ifndef strnicmp
89 # define strnicmp strncasecmp
90 # endif
91 # ifndef stricmp
92 # define stricmp strcasecmp
93 # endif
94 #elif defined(__WXMAC__)
95 #else
96 # include <io.h>
97 #endif
98
99 enum enumDummy {enumDum1};
100
101 #define SQL_C_BOOLEAN(datatype) (sizeof(datatype) == 1 ? SQL_C_UTINYINT : (sizeof(datatype) == 2 ? SQL_C_USHORT : SQL_C_ULONG))
102 // #define SQL_C_BOOLEAN (sizeof(Bool) == 2 ? SQL_C_USHORT : SQL_C_ULONG)
103
104 #define SQL_C_ENUM (sizeof(enumDummy) == 2 ? SQL_C_USHORT : SQL_C_ULONG)
105
106 #ifndef TRUE
107 #define TRUE 1
108 #endif
109
110 #ifndef FALSE
111 #define FALSE 0
112 #endif
113
114 const int DB_PATH_MAX = 254;
115
116 // Database Globals
117 const int DB_TYPE_NAME_LEN = 40;
118 const int DB_MAX_STATEMENT_LEN = 2048;
119 const int DB_MAX_WHERE_CLAUSE_LEN = 1024;
120 const int DB_MAX_ERROR_MSG_LEN = 512;
121 const int DB_MAX_ERROR_HISTORY = 5;
122 const int DB_MAX_TABLE_NAME_LEN = 128;
123 const int DB_MAX_COLUMN_NAME_LEN = 128;
124
125 const int DB_DATA_TYPE_VARCHAR = 1;
126 const int DB_DATA_TYPE_INTEGER = 2;
127 const int DB_DATA_TYPE_FLOAT = 3;
128 const int DB_DATA_TYPE_DATE = 4;
129
130 const int DB_SELECT_KEYFIELDS = 1;
131 const int DB_SELECT_WHERE = 2;
132 const int DB_SELECT_MATCHING = 3;
133 const int DB_SELECT_STATEMENT = 4;
134
135 const int DB_UPD_KEYFIELDS = 1;
136 const int DB_UPD_WHERE = 2;
137
138 const int DB_DEL_KEYFIELDS = 1;
139 const int DB_DEL_WHERE = 2;
140 const int DB_DEL_MATCHING = 3;
141
142 const int DB_WHERE_KEYFIELDS = 1;
143 const int DB_WHERE_MATCHING = 2;
144
145 const int DB_GRANT_SELECT = 1;
146 const int DB_GRANT_INSERT = 2;
147 const int DB_GRANT_UPDATE = 4;
148 const int DB_GRANT_DELETE = 8;
149 const int DB_GRANT_ALL = DB_GRANT_SELECT | DB_GRANT_INSERT | DB_GRANT_UPDATE | DB_GRANT_DELETE;
150
151 // ODBC Error codes (derived from ODBC SqlState codes)
152 enum ODBC_ERRORS
153 {
154 DB_FAILURE = 0,
155 DB_SUCCESS = 1,
156 DB_ERR_NOT_IN_USE,
157 DB_ERR_GENERAL_WARNING, // SqlState = '01000'
158 DB_ERR_DISCONNECT_ERROR, // SqlState = '01002'
159 DB_ERR_DATA_TRUNCATED, // SqlState = '01004'
160 DB_ERR_PRIV_NOT_REVOKED, // SqlState = '01006'
161 DB_ERR_INVALID_CONN_STR_ATTR, // SqlState = '01S00'
162 DB_ERR_ERROR_IN_ROW, // SqlState = '01S01'
163 DB_ERR_OPTION_VALUE_CHANGED, // SqlState = '01S02'
164 DB_ERR_NO_ROWS_UPD_OR_DEL, // SqlState = '01S03'
165 DB_ERR_MULTI_ROWS_UPD_OR_DEL, // SqlState = '01S04'
166 DB_ERR_WRONG_NO_OF_PARAMS, // SqlState = '07001'
167 DB_ERR_DATA_TYPE_ATTR_VIOL, // SqlState = '07006'
168 DB_ERR_UNABLE_TO_CONNECT, // SqlState = '08001'
169 DB_ERR_CONNECTION_IN_USE, // SqlState = '08002'
170 DB_ERR_CONNECTION_NOT_OPEN, // SqlState = '08003'
171 DB_ERR_REJECTED_CONNECTION, // SqlState = '08004'
172 DB_ERR_CONN_FAIL_IN_TRANS, // SqlState = '08007'
173 DB_ERR_COMM_LINK_FAILURE, // SqlState = '08S01'
174 DB_ERR_INSERT_VALUE_LIST_MISMATCH, // SqlState = '21S01'
175 DB_ERR_DERIVED_TABLE_MISMATCH, // SqlState = '21S02'
176 DB_ERR_STRING_RIGHT_TRUNC, // SqlState = '22001'
177 DB_ERR_NUMERIC_VALUE_OUT_OF_RNG, // SqlState = '22003'
178 DB_ERR_ERROR_IN_ASSIGNMENT, // SqlState = '22005'
179 DB_ERR_DATETIME_FLD_OVERFLOW, // SqlState = '22008'
180 DB_ERR_DIVIDE_BY_ZERO, // SqlState = '22012'
181 DB_ERR_STR_DATA_LENGTH_MISMATCH, // SqlState = '22026'
182 DB_ERR_INTEGRITY_CONSTRAINT_VIOL, // SqlState = '23000'
183 DB_ERR_INVALID_CURSOR_STATE, // SqlState = '24000'
184 DB_ERR_INVALID_TRANS_STATE, // SqlState = '25000'
185 DB_ERR_INVALID_AUTH_SPEC, // SqlState = '28000'
186 DB_ERR_INVALID_CURSOR_NAME, // SqlState = '34000'
187 DB_ERR_SYNTAX_ERROR_OR_ACCESS_VIOL, // SqlState = '37000'
188 DB_ERR_DUPLICATE_CURSOR_NAME, // SqlState = '3C000'
189 DB_ERR_SERIALIZATION_FAILURE, // SqlState = '40001'
190 DB_ERR_SYNTAX_ERROR_OR_ACCESS_VIOL2, // SqlState = '42000'
191 DB_ERR_OPERATION_ABORTED, // SqlState = '70100'
192 DB_ERR_UNSUPPORTED_FUNCTION, // SqlState = 'IM001'
193 DB_ERR_NO_DATA_SOURCE, // SqlState = 'IM002'
194 DB_ERR_DRIVER_LOAD_ERROR, // SqlState = 'IM003'
195 DB_ERR_SQLALLOCENV_FAILED, // SqlState = 'IM004'
196 DB_ERR_SQLALLOCCONNECT_FAILED, // SqlState = 'IM005'
197 DB_ERR_SQLSETCONNECTOPTION_FAILED, // SqlState = 'IM006'
198 DB_ERR_NO_DATA_SOURCE_DLG_PROHIB, // SqlState = 'IM007'
199 DB_ERR_DIALOG_FAILED, // SqlState = 'IM008'
200 DB_ERR_UNABLE_TO_LOAD_TRANSLATION_DLL, // SqlState = 'IM009'
201 DB_ERR_DATA_SOURCE_NAME_TOO_LONG, // SqlState = 'IM010'
202 DB_ERR_DRIVER_NAME_TOO_LONG, // SqlState = 'IM011'
203 DB_ERR_DRIVER_KEYWORD_SYNTAX_ERROR, // SqlState = 'IM012'
204 DB_ERR_TRACE_FILE_ERROR, // SqlState = 'IM013'
205 DB_ERR_TABLE_OR_VIEW_ALREADY_EXISTS, // SqlState = 'S0001'
206 DB_ERR_TABLE_NOT_FOUND, // SqlState = 'S0002'
207 DB_ERR_INDEX_ALREADY_EXISTS, // SqlState = 'S0011'
208 DB_ERR_INDEX_NOT_FOUND, // SqlState = 'S0012'
209 DB_ERR_COLUMN_ALREADY_EXISTS, // SqlState = 'S0021'
210 DB_ERR_COLUMN_NOT_FOUND, // SqlState = 'S0022'
211 DB_ERR_NO_DEFAULT_FOR_COLUMN, // SqlState = 'S0023'
212 DB_ERR_GENERAL_ERROR, // SqlState = 'S1000'
213 DB_ERR_MEMORY_ALLOCATION_FAILURE, // SqlState = 'S1001'
214 DB_ERR_INVALID_COLUMN_NUMBER, // SqlState = 'S1002'
215 DB_ERR_PROGRAM_TYPE_OUT_OF_RANGE, // SqlState = 'S1003'
216 DB_ERR_SQL_DATA_TYPE_OUT_OF_RANGE, // SqlState = 'S1004'
217 DB_ERR_OPERATION_CANCELLED, // SqlState = 'S1008'
218 DB_ERR_INVALID_ARGUMENT_VALUE, // SqlState = 'S1009'
219 DB_ERR_FUNCTION_SEQUENCE_ERROR, // SqlState = 'S1010'
220 DB_ERR_OPERATION_INVALID_AT_THIS_TIME, // SqlState = 'S1011'
221 DB_ERR_INVALID_TRANS_OPERATION_CODE, // SqlState = 'S1012'
222 DB_ERR_NO_CURSOR_NAME_AVAIL, // SqlState = 'S1015'
223 DB_ERR_INVALID_STR_OR_BUF_LEN, // SqlState = 'S1090'
224 DB_ERR_DESCRIPTOR_TYPE_OUT_OF_RANGE, // SqlState = 'S1091'
225 DB_ERR_OPTION_TYPE_OUT_OF_RANGE, // SqlState = 'S1092'
226 DB_ERR_INVALID_PARAM_NO, // SqlState = 'S1093'
227 DB_ERR_INVALID_SCALE_VALUE, // SqlState = 'S1094'
228 DB_ERR_FUNCTION_TYPE_OUT_OF_RANGE, // SqlState = 'S1095'
229 DB_ERR_INF_TYPE_OUT_OF_RANGE, // SqlState = 'S1096'
230 DB_ERR_COLUMN_TYPE_OUT_OF_RANGE, // SqlState = 'S1097'
231 DB_ERR_SCOPE_TYPE_OUT_OF_RANGE, // SqlState = 'S1098'
232 DB_ERR_NULLABLE_TYPE_OUT_OF_RANGE, // SqlState = 'S1099'
233 DB_ERR_UNIQUENESS_OPTION_TYPE_OUT_OF_RANGE, // SqlState = 'S1100'
234 DB_ERR_ACCURACY_OPTION_TYPE_OUT_OF_RANGE, // SqlState = 'S1101'
235 DB_ERR_DIRECTION_OPTION_OUT_OF_RANGE, // SqlState = 'S1103'
236 DB_ERR_INVALID_PRECISION_VALUE, // SqlState = 'S1104'
237 DB_ERR_INVALID_PARAM_TYPE, // SqlState = 'S1105'
238 DB_ERR_FETCH_TYPE_OUT_OF_RANGE, // SqlState = 'S1106'
239 DB_ERR_ROW_VALUE_OUT_OF_RANGE, // SqlState = 'S1107'
240 DB_ERR_CONCURRENCY_OPTION_OUT_OF_RANGE, // SqlState = 'S1108'
241 DB_ERR_INVALID_CURSOR_POSITION, // SqlState = 'S1109'
242 DB_ERR_INVALID_DRIVER_COMPLETION, // SqlState = 'S1110'
243 DB_ERR_INVALID_BOOKMARK_VALUE, // SqlState = 'S1111'
244 DB_ERR_DRIVER_NOT_CAPABLE, // SqlState = 'S1C00'
245 DB_ERR_TIMEOUT_EXPIRED // SqlState = 'S1T00'
246 };
247
248 struct DbStuff
249 {
250 HENV Henv;
251 char Dsn[SQL_MAX_DSN_LENGTH+1]; // Data Source Name
252 char Uid[20+1]; // User ID
253 char AuthStr[20+1]; // Authorization string (password)
254
255 char description[SQL_MAX_DSN_LENGTH+1]; // Not sure what the max length is
256 char fileType[SQL_MAX_DSN_LENGTH+1]; // Not sure what the max length is
257
258 // Optionals needed for some databases like dBase
259 char defaultDir[DB_PATH_MAX]; // Directory that db file resides in
260 };
261
262 typedef struct
263 {
264 char TypeName[DB_TYPE_NAME_LEN];
265 int FsqlType;
266 long Precision;
267 short CaseSensitive;
268 // short MinimumScale;
269 short MaximumScale;
270 } SqlTypeInfo;
271
272 class WXDLLEXPORT CcolInf
273 {
274 public:
275 char tableName[DB_MAX_TABLE_NAME_LEN+1];
276 char colName[DB_MAX_COLUMN_NAME_LEN+1];
277 int sqlDataType;
278 };
279
280 enum sqlLog
281 {
282 sqlLogOFF,
283 sqlLogON
284 };
285
286 enum dbms
287 {
288 dbmsUNIDENTIFIED,
289 dbmsORACLE,
290 dbmsSYBASE_ASA, // Adaptive Server Anywhere
291 dbmsSYBASE_ASE, // Adaptive Server Enterprise
292 dbmsMS_SQL_SERVER,
293 dbmsMY_SQL,
294 dbmsPOSTGRES,
295 dbmsACCESS,
296 dbmsDBASE,
297 dbmsINFORMIX
298 };
299
300 typedef enum dbms DBMS;
301
302 // The wxDB::errorList is copied to this variable when the wxDB object
303 // is closed. This way, the error list is still available after the
304 // database object is closed. This is necessary if the database
305 // connection fails so the calling application can show the operator
306 // why the connection failed. Note: as each wxDB object is closed, it
307 // will overwrite the errors of the previously destroyed wxDB object in
308 // this variable.
309 extern char DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
310
311 class WXDLLEXPORT wxDB
312 {
313 private:
314
315 // Private data
316 bool dbIsOpen;
317 char *dsn; // Data source name
318 char *uid; // User ID
319 char *authStr; // Authorization string (password)
320 FILE *fpSqlLog; // Sql Log file pointer
321 enum sqlLog sqlLogState; // On or Off
322
323 // Private member functions
324 bool getDbInfo(void);
325 bool getDataTypeInfo(SWORD fSqlType, SqlTypeInfo &structSQLTypeInfo);
326 bool setConnectionOptions(void);
327 void logError(char *errMsg, char *SQLState);
328
329 public:
330
331 // The following structure contains database information gathered from the
332 // datasource when the datasource is first opened.
333 struct
334 {
335 char dbmsName[40]; // Name of the dbms product
336 char dbmsVer[64]; // Version # of the dbms product
337 char driverName[40]; // Driver name
338 char odbcVer[60]; // ODBC version of the driver
339 char drvMgrOdbcVer[60]; // ODBC version of the driver manager
340 char driverVer[60]; // Driver version
341 char serverName[80]; // Server Name, typically a connect string
342 char databaseName[128]; // Database filename
343 char outerJoins[2]; // Indicates whether the data source supports outer joins
344 char procedureSupport[2]; // Indicates whether the data source supports stored procedures
345 UWORD maxConnections; // Maximum # of connections the data source supports
346 UWORD maxStmts; // Maximum # of HSTMTs per HDBC
347 UWORD apiConfLvl; // ODBC API conformance level
348 UWORD cliConfLvl; // Indicates whether the data source is SAG compliant
349 UWORD sqlConfLvl; // SQL conformance level
350 UWORD cursorCommitBehavior; // Indicates how cursors are affected by a db commit
351 UWORD cursorRollbackBehavior; // Indicates how cursors are affected by a db rollback
352 UWORD supportNotNullClause; // Indicates if data source supports NOT NULL clause
353 char supportIEF[2]; // Integrity Enhancement Facility (Referential Integrity)
354 UDWORD txnIsolation; // Default transaction isolation level supported by the driver
355 UDWORD txnIsolationOptions; // Transaction isolation level options available
356 UDWORD fetchDirections; // Fetch directions supported
357 UDWORD lockTypes; // Lock types supported in SQLSetPos
358 UDWORD posOperations; // Position operations supported in SQLSetPos
359 UDWORD posStmts; // Position statements supported
360 UDWORD scrollConcurrency; // Concurrency control options supported for scrollable cursors
361 UDWORD scrollOptions; // Scroll Options supported for scrollable cursors
362 UDWORD staticSensitivity; // Indicates if additions, deletions and updates can be detected
363 UWORD txnCapable; // Indicates if the data source supports transactions
364 UDWORD loginTimeout; // Number seconds to wait for a login request
365 } dbInf;
366
367 // ODBC handles
368 HENV henv; // ODBC Environment handle
369 HDBC hdbc; // ODBC DB Connection handle
370 HSTMT hstmt; // ODBC Statement handle
371
372 // ODBC Error Inf.
373 char sqlState[20];
374 SDWORD nativeError;
375 char errorMsg[SQL_MAX_MESSAGE_LENGTH];
376 SWORD cbErrorMsg;
377 char errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
378 int DB_STATUS;
379
380 //Error reporting mode
381 bool silent;
382
383 // Number of Ctable objects connected to this db object
384 unsigned int nTables;
385
386 // Inf. about logical data types VARCHAR, INTEGER, FLOAT and DATE.
387 // This inf. is obtained from the ODBC driver by use of the
388 // SQLGetTypeInfo() function. The key piece of inf. is the
389 // type name the data source uses for each logical data type.
390 // e.g. VARCHAR; Oracle calls it VARCHAR2.
391 SqlTypeInfo typeInfVarchar, typeInfInteger, typeInfFloat, typeInfDate;
392
393 // Public member functions
394 wxDB(HENV &aHenv);
395 bool Open(char *Dsn, char *Uid, char *AuthStr); // Data Source Name, User ID, Password
396 void Close(void);
397 bool CommitTrans(void);
398 bool RollbackTrans(void);
399 bool DispAllErrors(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
400 bool GetNextError(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
401 void DispNextError(void);
402 bool CreateView(char *viewName, char *colList, char *pSqlStmt, bool attemptDrop=TRUE);
403 bool DropView(char *viewName);
404 bool ExecSql(char *pSqlStmt);
405 bool GetNext(void);
406 bool GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SDWORD FAR *cbReturned);
407 bool Grant(int privileges, char *tableName, char *userList = "PUBLIC");
408 int TranslateSqlState(char *SQLState);
409 bool Catalog(char *userID, char *fileName = "Catalog.txt");
410 CcolInf *GetColumns(char *tableName[], char *userID=NULL);
411 char *GetDatabaseName(void) {return dbInf.dbmsName;}
412 char *GetDataSource(void) {return dsn;}
413 char *GetUsername(void) {return uid;}
414 char *GetPassword(void) {return authStr;}
415 bool IsOpen(void) {return dbIsOpen;}
416 HENV GetHENV(void) {return henv;}
417 HDBC GetHDBC(void) {return hdbc;}
418 HSTMT GetHSTMT(void) {return hstmt;}
419 bool TableExists(char *tableName, char *userID=NULL, char *path=NULL); // Table name can refer to a table, view, alias or synonym
420 void LogError(char *errMsg, char *SQLState = 0) {logError(errMsg, SQLState);}
421 bool SqlLog(enum sqlLog state, char *filename = "sqllog.txt", bool append = FALSE);
422 bool WriteSqlLog(char *logMsg);
423 DBMS Dbms(void);
424
425 }; // wxDB
426
427 // This structure forms a node in a linked list. The linked list of "DbList" objects
428 // keeps track of allocated database connections. This allows the application to
429 // open more than one database connection through ODBC for multiple transaction support
430 // or for multiple database support.
431
432 struct DbList
433 {
434 DbList *PtrPrev; // Pointer to previous item in the list
435 char Dsn[SQL_MAX_DSN_LENGTH+1]; // Data Source Name
436 wxDB *PtrDb; // Pointer to the wxDB object
437 bool Free; // Is item free or in use?
438 DbList *PtrNext; // Pointer to next item in the list
439 };
440
441
442 #ifdef __WXDEBUG__
443 #include "wx/object.h"
444 class CstructTablesInUse : public wxObject
445 {
446 public:
447 const char *tableName;
448 ULONG tableID;
449 class wxDB *pDb;
450 }; // CstructTablesInUse
451 #endif
452
453 // The following routines allow a user to get new database connections, free them
454 // for other code segments to use, or close all of them when the application has
455 // completed.
456
457 wxDB WXDLLEXPORT *GetDbConnection(DbStuff *pDbStuff);
458 bool WXDLLEXPORT FreeDbConnection(wxDB *pDb);
459 void WXDLLEXPORT CloseDbConnections(void);
460 int WXDLLEXPORT NumberDbConnectionsInUse(void);
461
462 // This function sets the sql log state for all open wxDB objects
463 bool SqlLog(enum sqlLog state, char *filename = "sqllog.txt");
464
465 // This routine allows you to query a driver manager
466 // for a list of available datasources. Call this routine
467 // the first time using SQL_FETCH_FIRST. Continue to call it
468 // using SQL_FETCH_NEXT until you've exhausted the list.
469 bool WXDLLEXPORT GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
470 UWORD direction = SQL_FETCH_NEXT);
471
472 #endif