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