include/wx/db.h

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