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