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