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