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
 258 struct wxDbConnectInf
 259 {
 260     HENV Henv;
 261     wxString Dsn;                                      // Data Source Name
 262     wxString Uid;                                      // User ID
 263     wxString AuthStr;                                  // Authorization string (password)
 264
 265     wxString description;                              // Not sure what the max length is
 266     wxString fileType;                                 // Not sure what the max length is
 267
 268     // Optionals needed for some databases like dBase
 269     wxString defaultDir;                               // Directory that db file resides in
 270 };
 271
 272 struct wxDbSqlTypeInfo
 273 {
 274     wxString    TypeName;
 275     int         FsqlType;
 276     long        Precision;
 277     short       CaseSensitive;
 278 //    short     MinimumScale;
 279     short       MaximumScale;
 280 };
 281
 282
 283 class WXDLLEXPORT wxDbColFor
 284 {
 285 public:
 286     wxString       s_Field;             // Formated String for Output
 287     wxString       s_Format[7];         // Formated Objects - TIMESTAMP has the biggest (7)
 288     wxString       s_Amount[7];          // Formated Objects - amount of things that can be formatted
 289     int            i_Amount[7];          // Formated Objects - TT MM YYYY HH MM SS m
 290     int            i_Nation;            // 0 = timestamp , 1=EU, 2=UK, 3=International, 4=US
 291     int            i_dbDataType;        // conversion of the 'sqlDataType' to the generic data type used by these classes
 292     SWORD          i_sqlDataType;
 293
 294     wxDbColFor();
 295     ~wxDbColFor();
 296
 297     int            Format(int Nation, int dbDataType, SWORD sqlDataType, short columnSize, short decimalDigits);
 298 };
 299
 300
 301 class WXDLLEXPORT wxDbColInf
 302 {
 303 public:
 304     wxChar       catalog[128+1];
 305     wxChar       schema[128+1];
 306     wxChar       tableName[DB_MAX_TABLE_NAME_LEN+1];
 307     wxChar       colName[DB_MAX_COLUMN_NAME_LEN+1];
 308     SWORD        sqlDataType;
 309     wxChar       typeName[128+1];
 310     SWORD        columnSize;
 311     SWORD        bufferLength;
 312     short        decimalDigits;
 313     short        numPrecRadix;
 314     short        nullable;
 315     wxChar       remarks[254+1];
 316     int          dbDataType;  // conversion of the 'sqlDataType' to the generic data type used by these classes
 317  // mj10777.19991224 : new
 318     int          PkCol;       // Primary key column       0=No; 1= First Key, 2 = Second Key etc.
 319     wxChar       PkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Tables that use this PKey as a FKey
 320     int          FkCol;       // Foreign key column       0=No; 1= First Key, 2 = Second Key etc.
 321     wxChar       FkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Foreign key table name
 322     wxDbColFor  *pColFor;                              // How should this columns be formatted
 323
 324     wxDbColInf();
 325     ~wxDbColInf();
 326 };
 327
 328
 329
 330
 331 class WXDLLEXPORT wxDbTableInf        // Description of a Table
 332 {
 333 public:
 334     wxChar      tableName[DB_MAX_TABLE_NAME_LEN+1];
 335     wxChar      tableType[254+1];           // "TABLE" or "SYSTEM TABLE" etc.
 336     wxChar      tableRemarks[254+1];
 337     int         numCols;                    // How many Columns does this Table have: GetColumnCount(..);
 338     wxDbColInf *pColInf;                    // pColInf = NULL ; User can later call GetColumns(..);
 339     wxDbTableInf();
 340     ~wxDbTableInf();
 341 };
 342
 343
 344 class WXDLLEXPORT wxDbInf     // Description of a Database
 345 {
 346 public:
 347     wxChar        catalog[128+1];
 348     wxChar        schema[128+1];
 349     int           numTables;           // How many tables does this database have
 350     wxDbTableInf *pTableInf;           // pTableInf = new wxDbTableInf[numTables];
 351
 352     wxDbInf();
 353     ~wxDbInf();
 354 };
 355
 356
 357 enum wxDbSqlLogState
 358 {
 359     sqlLogOFF,
 360     sqlLogON
 361 };
 362
 363 // These are the databases currently tested and working with these classes
 364 // See the comments in wxDb::Dbms() for exceptions/issues with
 365 // each of these database engines
 366 enum wxDBMS
 367 {
 368     dbmsUNIDENTIFIED,
 369     dbmsORACLE,
 370     dbmsSYBASE_ASA,        // Adaptive Server Anywhere
 371     dbmsSYBASE_ASE,        // Adaptive Server Enterprise
 372     dbmsMS_SQL_SERVER,
 373     dbmsMY_SQL,
 374     dbmsPOSTGRES,
 375     dbmsACCESS,
 376     dbmsDBASE,
 377     dbmsINFORMIX,
 378     dbmsVIRTUOSO,
 379     dbmsDB2,
 380     dbmsINTERBASE
 381 };
 382
 383
 384 // The wxDb::errorList is copied to this variable when the wxDb object
 385 // is closed.  This way, the error list is still available after the
 386 // database object is closed.  This is necessary if the database
 387 // connection fails so the calling application can show the operator
 388 // why the connection failed.  Note: as each wxDb object is closed, it
 389 // will overwrite the errors of the previously destroyed wxDb object in
 390 // this variable.
 391 extern wxChar DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
 392
 393
 394 class WXDLLEXPORT wxDb
 395 {
 396 private:
 397     bool             dbIsOpen;
 398     wxString         dsn;             // Data source name
 399     wxString         uid;             // User ID
 400     wxString         authStr;         // Authorization string (password)
 401     FILE            *fpSqlLog;        // Sql Log file pointer
 402     wxDbSqlLogState  sqlLogState;     // On or Off
 403     bool             fwdOnlyCursors;
 404     wxDBMS           dbmsType;        // Type of datasource - i.e. Oracle, dBase, SQLServer, etc
 405
 406     // Private member functions
 407     bool             getDbInfo(void);
 408     bool             getDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo);
 409     bool             setConnectionOptions(void);
 410     void             logError(const wxString &errMsg, const wxString &SQLState);
 411     void             initialize();
 412     const wxChar    *convertUserID(const wxChar *userID, wxString &UserID);
 413
 414 #if !wxODBC_BACKWARD_COMPATABILITY
 415     // ODBC handles
 416     HENV  henv;        // ODBC Environment handle
 417     HDBC  hdbc;        // ODBC DB Connection handle
 418     HSTMT hstmt;       // ODBC Statement handle
 419
 420     //Error reporting mode
 421     bool silent;
 422
 423     // Number of Ctable objects connected to this db object.  FOR INTERNAL USE ONLY!!!
 424     unsigned int nTables;
 425
 426     // Information about logical data types VARCHAR, INTEGER, FLOAT and DATE.
 427      //
 428     // This information is obtained from the ODBC driver by use of the
 429     // SQLGetTypeInfo() function.  The key piece of information is the
 430     // type name the data source uses for each logical data type.
 431     // e.g. VARCHAR; Oracle calls it VARCHAR2.
 432     wxDbSqlTypeInfo typeInfVarchar;
 433     wxDbSqlTypeInfo typeInfInteger;
 434     wxDbSqlTypeInfo typeInfFloat;
 435     wxDbSqlTypeInfo typeInfDate;
 436 #endif
 437
 438 public:
 439 #if wxODBC_BACKWARD_COMPATABILITY
 440     // ODBC handles
 441     HENV  henv;        // ODBC Environment handle
 442     HDBC  hdbc;        // ODBC DB Connection handle
 443     HSTMT hstmt;       // ODBC Statement handle
 444
 445     //Error reporting mode
 446     bool silent;
 447
 448     // Number of Ctable objects connected to this db object.  FOR INTERNAL USE ONLY!!!
 449     unsigned int nTables;
 450 #endif
 451
 452     // The following structure contains database information gathered from the
 453     // datasource when the datasource is first opened.
 454     struct
 455     {
 456         wxChar dbmsName[40];                             // Name of the dbms product
 457         wxChar dbmsVer[64];                              // Version # of the dbms product
 458         wxChar driverName[40];                           // Driver name
 459         wxChar odbcVer[60];                              // ODBC version of the driver
 460         wxChar drvMgrOdbcVer[60];                        // ODBC version of the driver manager
 461         wxChar driverVer[60];                            // Driver version
 462         wxChar serverName[80];                           // Server Name, typically a connect string
 463         wxChar databaseName[128];                        // Database filename
 464         wxChar outerJoins[2];                            // Indicates whether the data source supports outer joins
 465         wxChar procedureSupport[2];                      // Indicates whether the data source supports stored procedures
 466         wxChar accessibleTables[2];                      // Indicates whether the data source only reports accessible tables in SQLTables.
 467         UWORD  maxConnections;                           // Maximum # of connections the data source supports
 468         UWORD  maxStmts;                                 // Maximum # of HSTMTs per HDBC
 469         UWORD  apiConfLvl;                               // ODBC API conformance level
 470         UWORD  cliConfLvl;                               // Indicates whether the data source is SAG compliant
 471         UWORD  sqlConfLvl;                               // SQL conformance level
 472         UWORD  cursorCommitBehavior;                     // Indicates how cursors are affected by a db commit
 473         UWORD  cursorRollbackBehavior;                   // Indicates how cursors are affected by a db rollback
 474         UWORD  supportNotNullClause;                     // Indicates if data source supports NOT NULL clause
 475         wxChar supportIEF[2];                            // Integrity Enhancement Facility (Referential Integrity)
 476         UDWORD txnIsolation;                             // Default transaction isolation level supported by the driver
 477         UDWORD txnIsolationOptions;                      // Transaction isolation level options available
 478         UDWORD fetchDirections;                          // Fetch directions supported
 479         UDWORD lockTypes;                                // Lock types supported in SQLSetPos
 480         UDWORD posOperations;                            // Position operations supported in SQLSetPos
 481         UDWORD posStmts;                                 // Position statements supported
 482         UDWORD scrollConcurrency;                        // Concurrency control options supported for scrollable cursors
 483         UDWORD scrollOptions;                            // Scroll Options supported for scrollable cursors
 484         UDWORD staticSensitivity;                        // Indicates if additions, deletions and updates can be detected
 485         UWORD  txnCapable;                               // Indicates if the data source supports transactions
 486         UDWORD loginTimeout;                             // Number seconds to wait for a login request
 487     } dbInf;
 488
 489     // ODBC Error Inf.
 490     SWORD  cbErrorMsg;
 491     int    DB_STATUS;
 492     wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
 493     wxChar errorMsg[SQL_MAX_MESSAGE_LENGTH];
 494     SDWORD nativeError;
 495     wxChar sqlState[20];
 496
 497 #if wxODBC_BACKWARD_COMPATABILITY
 498     // Information about logical data types VARCHAR, INTEGER, FLOAT and DATE.
 499      //
 500     // This information is obtained from the ODBC driver by use of the
 501     // SQLGetTypeInfo() function.  The key piece of information is the
 502     // type name the data source uses for each logical data type.
 503     // e.g. VARCHAR; Oracle calls it VARCHAR2.
 504     wxDbSqlTypeInfo typeInfVarchar;
 505     wxDbSqlTypeInfo typeInfInteger;
 506     wxDbSqlTypeInfo typeInfFloat;
 507     wxDbSqlTypeInfo typeInfDate;
 508 #endif
 509
 510     // Public member functions
 511     wxDb(HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
 512     bool         Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr);  // Data Source Name, User ID, Password
 513     bool         Open(wxDb *copyDb);  // pointer to a wxDb whose connection info should be copied rather than re-queried
 514     void         Close(void);
 515     bool         CommitTrans(void);
 516     bool         RollbackTrans(void);
 517     bool         DispAllErrors(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
 518     bool         GetNextError(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
 519     void         DispNextError(void);
 520     bool         CreateView(const wxString &viewName, const wxString &colList, const wxString &pSqlStmt, bool attemptDrop=TRUE);
 521     bool         DropView(const wxString &viewName);
 522     bool         ExecSql(const wxString &pSqlStmt);
 523     bool         GetNext(void);
 524     bool         GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SDWORD FAR *cbReturned);
 525     bool         Grant(int privileges, const wxString &tableName, const wxString &userList = wxT("PUBLIC"));
 526     int          TranslateSqlState(const wxString &SQLState);
 527     wxDbInf     *GetCatalog(const wxChar *userID=NULL);
 528     bool         Catalog(const wxChar *userID=NULL, const wxString &fileName=SQL_CATALOG_FILENAME);
 529     int          GetKeyFields(const wxString &tableName, wxDbColInf* colInf, int nocols);
 530
 531     wxDbColInf  *GetColumns(wxChar *tableName[], const wxChar *userID=NULL);
 532     wxDbColInf  *GetColumns(const wxString &tableName, int *numCols, const wxChar *userID=NULL);
 533
 534     int          GetColumnCount(const wxString &tableName, const wxChar *userID=NULL);
 535     const wxChar *GetDatabaseName(void)  {return dbInf.dbmsName;}
 536     const wxString &GetDataSource(void)    {return dsn;}
 537     const wxString &GetDatasourceName(void){return dsn;}
 538     const wxString &GetUsername(void)      {return uid;}
 539     const wxString &GetPassword(void)      {return authStr;}
 540     bool         IsOpen(void)           {return dbIsOpen;}
 541     HENV         GetHENV(void)          {return henv;}
 542     HDBC         GetHDBC(void)          {return hdbc;}
 543     HSTMT        GetHSTMT(void)         {return hstmt;}
 544     int          GetTableCount()        {return nTables;};  // number of tables using this connection
 545     wxDbSqlTypeInfo GetTypeInfVarchar() {return typeInfVarchar;}
 546     wxDbSqlTypeInfo GetTypeInfInteger() {return typeInfInteger;}
 547     wxDbSqlTypeInfo GetTypeInfFloat()   {return typeInfFloat;}
 548     wxDbSqlTypeInfo GetTypeInfDate()    {return typeInfDate;}
 549
 550     bool         TableExists(const wxString &tableName, const wxChar *userID=NULL, const wxString &tablePath=wxT(""));  // tableName can refer to a table, view, alias or synonym
 551     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
 552     void         LogError(const wxString &errMsg, const wxString &SQLState = wxT("")) { logError(errMsg, SQLState); }
 553     void         SetDebugErrorMessages(bool state) { silent = !state; }
 554     bool         SetSqlLogging(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME, bool append = FALSE);
 555     bool         WriteSqlLog(const wxString &logMsg);
 556     wxDBMS       Dbms(void);
 557     bool         ModifyColumn(const wxString &tableName, const wxString &columnName,
 558                               int dataType, ULONG columnLength=0,
 559                               const wxString &optionalParam="");
 560
 561     bool         FwdOnlyCursors(void)  {return fwdOnlyCursors;}
 562
 563     // These two functions are provided strictly for use by wxDbTable.
 564     // DO NOT USE THESE FUNCTIONS, OR MEMORY LEAKS MAY OCCUR
 565     void         incrementTableCount() { nTables++; return; }
 566     void         decrementTableCount() { nTables--; return; }
 567
 568 };  // wxDb
 569
 570
 571 // This structure forms a node in a linked list.  The linked list of "DbList" objects
 572 // keeps track of allocated database connections.  This allows the application to
 573 // open more than one database connection through ODBC for multiple transaction support
 574 // or for multiple database support.
 575 struct wxDbList
 576 {
 577     wxDbList *PtrPrev;       // Pointer to previous item in the list
 578     wxString  Dsn;           // Data Source Name
 579     wxString  Uid;           // User ID
 580     wxString  AuthStr;       // Authorization string (password)
 581     wxDb     *PtrDb;         // Pointer to the wxDb object
 582     bool      Free;          // Is item free or in use?
 583     wxDbList *PtrNext;       // Pointer to next item in the list
 584 };
 585
 586 #ifdef __WXDEBUG__
 587 #include "wx/object.h"
 588 class wxTablesInUse : public wxObject
 589 {
 590     public:
 591         const wxChar  *tableName;
 592         ULONG          tableID;
 593         class wxDb    *pDb;
 594 };  // wxTablesInUse
 595 #endif
 596
 597
 598 // The following routines allow a user to get new database connections, free them
 599 // for other code segments to use, or close all of them when the application has
 600 // completed.
 601 wxDb  WXDLLEXPORT *wxDbGetConnection(wxDbConnectInf *pDbConfig, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
 602 bool  WXDLLEXPORT  wxDbFreeConnection(wxDb *pDb);
 603 void  WXDLLEXPORT  wxDbCloseConnections(void);
 604 int   WXDLLEXPORT  wxDbConnectionsInUse(void);
 605
 606
 607 // This function sets the sql log state for all open wxDb objects
 608 bool wxDbSqlLog(wxDbSqlLogState state, const wxChar *filename = SQL_LOG_FILENAME);
 609
 610
 611 #if 0
 612 // MSW/VC6 ONLY!!!  Experimental
 613 int WXDLLEXPORT wxDbCreateDataSource(const wxString &driverName, const wxString &dsn, const wxString &description=wxT(""),
 614                                      bool sysDSN=FALSE, const wxString &defDir=wxT(""), wxWindow *parent=NULL);
 615 #endif
 616
 617 // This routine allows you to query a driver manager
 618 // for a list of available datasources.  Call this routine
 619 // the first time using SQL_FETCH_FIRST.  Continue to call it
 620 // using SQL_FETCH_NEXT until you've exhausted the list.
 621 bool WXDLLEXPORT wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMax, wxChar *DsDesc,
 622                                    SWORD DsDescMax, UWORD direction = SQL_FETCH_NEXT);
 623
 624
 625 // Change this to 0 to remove use of all deprecated functions
 626 #if wxODBC_BACKWARD_COMPATABILITY
 627 //#################################################################################
 628 //############### DEPRECATED functions for backward compatability #################
 629 //#################################################################################
 630
 631 // Backward compability structures/classes.  This will eventually go away
 632 const int DB_PATH_MAX      = wxDB_PATH_MAX;
 633
 634 typedef wxDb                 wxDB;
 635 typedef wxDbTableInf         wxTableInf;
 636 typedef wxDbColInf           wxColInf;
 637 typedef wxDbColInf           CcolInf;
 638 typedef wxDbColFor           wxColFor;
 639 typedef wxDbSqlTypeInfo      SqlTypeInfo;
 640 typedef wxDbSqlTypeInfo      wxSqlTypeInfo;
 641 typedef enum wxDbSqlLogState sqlLog;
 642 typedef enum wxDbSqlLogState wxSqlLogState;
 643 typedef enum wxDBMS          dbms;
 644 typedef enum wxDBMS          DBMS;
 645 typedef wxODBC_ERRORS        ODBC_ERRORS;
 646 typedef wxDbConnectInf       DbStuff;
 647 typedef wxDbList             DbList;
 648 #ifdef __WXDEBUG__
 649 typedef wxTablesInUse        CstructTablesInUse;
 650 #endif
 651
 652 // Deprecated function names that are replaced by the function names listed above
 653 wxDB  WXDLLEXPORT *GetDbConnection(DbStuff *pDbStuff, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
 654 bool  WXDLLEXPORT  FreeDbConnection(wxDB *pDb);
 655 void  WXDLLEXPORT  CloseDbConnections(void);
 656 int   WXDLLEXPORT  NumberDbConnectionsInUse(void);
 657
 658 bool SqlLog(sqlLog state, const char *filename = SQL_LOG_FILENAME);
 659
 660 bool WXDLLEXPORT GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
 661                                UWORD direction = SQL_FETCH_NEXT);
 662 #endif  // Deprecated structures/classes/functions
 663
 664 #endif