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