include/wx/db.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/db.h
   3 // Purpose:     Header file wxDb class.  The wxDb class represents a connection
   4 //              to an ODBC data source.  The wxDb class allows operations on the data
   5 //              source such as opening and closing the data source.
   6 // Author:      Doug Card
   7 // Modified by: George Tasker
   8 //              Bart Jourquin
   9 //              Mark Johnson, wxWindows@mj10777.de
  10 // Mods:        Dec, 1998:
  11 //                -Added support for SQL statement logging and database cataloging
  12 //                     April, 1999
  13 //                -Added QUERY_ONLY mode support to reduce default number of cursors
  14 //                -Added additional SQL logging code
  15 //                -Added DEBUG-ONLY tracking of Ctable objects to detect orphaned DB connections
  16 //                -Set ODBC option to only read committed writes to the DB so all
  17 //                     databases operate the same in that respect
  18 //
  19 // Created:     9.96
  20 // RCS-ID:      $Id$
  21 // Copyright:   (c) 1996 Remstar International, Inc.
  22 // Licence:     wxWindows licence
  23 ///////////////////////////////////////////////////////////////////////////////
  24
  25 #ifndef _WX_DB_H_
  26 #define _WX_DB_H_
  27
  28
  29 // BJO 20000503: introduce new GetColumns members which are more database independant and
  30 //               return columns in the order they were created
  31 #define OLD_GETCOLUMNS 1
  32 #define EXPERIMENTAL_WXDB_FUNCTIONS 1
  33
  34 #include "wx/version.h"
  35
  36 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  37     #pragma interface "db.h"
  38 #endif
  39
  40 #include "wx/setup.h"
  41
  42 #include "wx/defs.h"
  43 #include "wx/string.h"
  44
  45 #if defined(__VISUALC__)
  46     // we need to include standard Windows headers but we can't include
  47     // <windows.h> directly when using MFC because it includes it itself in a
  48     // different manner
  49     #if wxUSE_MFC
  50         #include <afxwin.h>
  51     #else // !wxUSE_MFC
  52         #ifndef STRICT
  53             #define STRICT 1
  54         #endif
  55
  56         #include <windows.h>
  57         #include "wx/msw/winundef.h"
  58     #endif // wxUSE_MFC/!wxUSE_MFC
  59
  60     // If you use the wxDbCreateDataSource() function with MSW/VC6,
  61     // you cannot use the iODBC headers, you must use the VC headers,
  62     // plus the odbcinst.h header - gt Nov 2 2000
  63     //
  64     // Must add "odbccp32.lib" in \wx2\wxWidgets\src\makevc.env to the WINLIBS= line
  65     //
  66     #include "sql.h"
  67     #include "sqlext.h"
  68     #include "odbcinst.h"
  69 #else
  70     #if defined(__WINDOWS__) && ( defined(HAVE_W32API_H) || defined(__BORLANDC__) )
  71         #include <windows.h>
  72         #include "wx/msw/winundef.h"
  73     #endif
  74     extern "C" {
  75     #if defined(wxUSE_BUILTIN_IODBC) && wxUSE_BUILTIN_IODBC
  76         // Use the ones from the library
  77         #include "wx/isql.h"
  78         #include "wx/isqlext.h"
  79     #else
  80         #include <sql.h>
  81         #include <sqlext.h>
  82     #endif
  83     }
  84 #endif
  85
  86
  87 typedef float SFLOAT;
  88 typedef double SDOUBLE;
  89 typedef unsigned int UINT;
  90 #define ULONG UDWORD
  91
  92 // Not available in iODBC
  93 #ifndef __WXMSW__
  94 typedef UCHAR SQLTCHAR;
  95 #endif
  96
  97 #ifndef wxODBC_FWD_ONLY_CURSORS
  98 #define wxODBC_FWD_ONLY_CURSORS 1
  99 #endif
 100
 101 enum enumDummy {enumDum1};
 102
 103 #ifndef SQL_C_BOOLEAN
 104     #define SQL_C_BOOLEAN(datatype) (sizeof(datatype) == 1 ? SQL_C_UTINYINT : (sizeof(datatype) == 2 ? SQL_C_USHORT : SQL_C_ULONG))
 105 #endif
 106
 107 #ifndef SQL_C_ENUM
 108     #define SQL_C_ENUM (sizeof(enumDummy) == 2 ? SQL_C_USHORT : SQL_C_ULONG)
 109 #endif
 110
 111 // NOTE: If SQL_C_BLOB is defined, and it is not SQL_C_BINARY, iODBC 2.x
 112 //       may not function correctly.  Likely best to use SQL_C_BINARY direct
 113 #ifndef SQL_C_BLOB
 114     #ifdef SQL_C_BINARY
 115         #define SQL_C_BLOB SQL_C_BINARY
 116     #endif
 117 #endif
 118
 119 const int wxDB_PATH_MAX                 = 254;
 120
 121 WXDLLIMPEXP_DATA_ODBC(extern wxChar const *) SQL_LOG_FILENAME;
 122 WXDLLIMPEXP_DATA_ODBC(extern wxChar const *) SQL_CATALOG_FILENAME;
 123
 124 // Database Globals
 125 const int DB_TYPE_NAME_LEN            = 40;
 126 const int DB_MAX_STATEMENT_LEN        = 4096;
 127 const int DB_MAX_WHERE_CLAUSE_LEN     = 2048;
 128 const int DB_MAX_ERROR_MSG_LEN        = 512;
 129 const int DB_MAX_ERROR_HISTORY        = 5;
 130 const int DB_MAX_TABLE_NAME_LEN       = 128;
 131 const int DB_MAX_COLUMN_NAME_LEN      = 128;
 132
 133 const int DB_DATA_TYPE_VARCHAR        = 1;
 134 const int DB_DATA_TYPE_INTEGER        = 2;
 135 const int DB_DATA_TYPE_FLOAT          = 3;
 136 const int DB_DATA_TYPE_DATE           = 4;
 137 const int DB_DATA_TYPE_BLOB           = 5;
 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 #ifndef SQL_MAX_CONNECTSTR_LEN
 268     // There does not seem to be a standard for this, so I am
 269     // defaulting to the value that MS recommends
 270     #define SQL_MAX_CONNECTSTR_LEN 1024
 271 #endif
 272
 273
 274 class WXDLLIMPEXP_ODBC wxDbConnectInf
 275 {
 276     private:
 277         bool freeHenvOnDestroy;
 278         bool useConnectionStr;
 279
 280     public:
 281         HENV Henv;
 282         wxChar Dsn[SQL_MAX_DSN_LENGTH+1];                  // Data Source Name
 283         wxChar Uid[SQL_MAX_USER_NAME_LEN+1];               // User ID
 284         wxChar AuthStr[SQL_MAX_AUTHSTR_LEN+1];             // Authorization string (password)
 285         wxChar ConnectionStr[SQL_MAX_CONNECTSTR_LEN+1];    // Connection string (password)
 286
 287         wxString Description;                              // Not sure what the max length is
 288         wxString FileType;                                 // Not sure what the max length is
 289
 290         // Optionals needed for some databases like dBase
 291         wxString DefaultDir;                               // Directory that db file resides in
 292
 293     public:
 294
 295         wxDbConnectInf();
 296         wxDbConnectInf(HENV henv, const wxString &dsn, const wxString &userID=wxEmptyString,
 297                        const wxString &password=wxEmptyString, const wxString &defaultDir=wxEmptyString,
 298                        const wxString &description=wxEmptyString, const wxString &fileType=wxEmptyString);
 299
 300         ~wxDbConnectInf();
 301
 302         bool             Initialize();
 303
 304         bool             AllocHenv();
 305         void             FreeHenv();
 306
 307         // Accessors
 308         const HENV       &GetHenv()          { return Henv; };
 309
 310         const wxChar    *GetDsn()           { return Dsn; };
 311
 312         const wxChar    *GetUid()           { return Uid; };
 313         const wxChar    *GetUserID()        { return Uid; };
 314
 315         const wxChar    *GetAuthStr()       { return AuthStr; };
 316         const wxChar    *GetPassword()      { return AuthStr; };
 317
 318         const wxChar    *GetConnectionStr() { return ConnectionStr; };
 319         bool             UseConnectionStr() { return useConnectionStr; };
 320
 321         const wxChar    *GetDescription()   { return Description; };
 322         const wxChar    *GetFileType()      { return FileType; };
 323         const wxChar    *GetDefaultDir()    { return DefaultDir; };
 324
 325         void             SetHenv(const HENV henv)               { Henv = henv; };
 326
 327         void             SetDsn(const wxString &dsn);
 328
 329         void             SetUserID(const wxString &userID);
 330         void             SetUid(const wxString &uid)            { SetUserID(uid); };
 331
 332         void             SetPassword(const wxString &password);
 333         void             SetAuthStr(const wxString &authstr)    { SetPassword(authstr); };
 334
 335         void             SetConnectionStr(const wxString &connectStr);
 336
 337         void             SetDescription(const wxString &desc)   { Description   = desc;     };
 338         void             SetFileType(const wxString &fileType)  { FileType      = fileType; };
 339         void             SetDefaultDir(const wxString &defDir)  { DefaultDir    = defDir;   };
 340 };  // class wxDbConnectInf
 341
 342
 343 struct WXDLLIMPEXP_ODBC wxDbSqlTypeInfo
 344 {
 345     wxString    TypeName;
 346     SWORD       FsqlType;
 347     long        Precision;
 348     short       CaseSensitive;
 349     short       MaximumScale;
 350 };
 351
 352
 353 class WXDLLIMPEXP_ODBC wxDbColFor
 354 {
 355 public:
 356     wxString       s_Field;              // Formated String for Output
 357     wxString       s_Format[7];          // Formated Objects - TIMESTAMP has the biggest (7)
 358     wxString       s_Amount[7];          // Formated Objects - amount of things that can be formatted
 359     int            i_Amount[7];          // Formated Objects - TT MM YYYY HH MM SS m
 360     int            i_Nation;             // 0 = timestamp , 1=EU, 2=UK, 3=International, 4=US
 361     int            i_dbDataType;         // conversion of the 'sqlDataType' to the generic data type used by these classes
 362     SWORD          i_sqlDataType;
 363
 364     wxDbColFor();
 365     ~wxDbColFor();
 366
 367     void           Initialize();
 368     int            Format(int Nation, int dbDataType, SWORD sqlDataType, short columnSize, short decimalDigits);
 369 };
 370
 371
 372 class WXDLLIMPEXP_ODBC wxDbColInf
 373 {
 374 public:
 375     wxChar       catalog[128+1];
 376     wxChar       schema[128+1];
 377     wxChar       tableName[DB_MAX_TABLE_NAME_LEN+1];
 378     wxChar       colName[DB_MAX_COLUMN_NAME_LEN+1];
 379     SWORD        sqlDataType;
 380     wxChar       typeName[128+1];
 381     SWORD        columnSize;
 382     SWORD        bufferLength;
 383     short        decimalDigits;
 384     short        numPrecRadix;
 385     short        nullable;
 386     wxChar       remarks[254+1];
 387     int          dbDataType;  // conversion of the 'sqlDataType' to the generic data type used by these classes
 388  // mj10777.19991224 : new
 389     int          PkCol;       // Primary key column       0=No; 1= First Key, 2 = Second Key etc.
 390     wxChar       PkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Tables that use this PKey as a FKey
 391     int          FkCol;       // Foreign key column       0=No; 1= First Key, 2 = Second Key etc.
 392     wxChar       FkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Foreign key table name
 393     wxDbColFor  *pColFor;                              // How should this columns be formatted
 394
 395     wxDbColInf();
 396     ~wxDbColInf();
 397
 398     bool Initialize();
 399 };
 400
 401
 402 class WXDLLIMPEXP_ODBC wxDbTableInf        // Description of a Table
 403 {
 404 public:
 405     wxChar      tableName[DB_MAX_TABLE_NAME_LEN+1];
 406     wxChar      tableType[254+1];           // "TABLE" or "SYSTEM TABLE" etc.
 407     wxChar      tableRemarks[254+1];
 408     UWORD       numCols;                    // How many Columns does this Table have: GetColumnCount(..);
 409     wxDbColInf *pColInf;                    // pColInf = NULL ; User can later call GetColumns(..);
 410
 411     wxDbTableInf();
 412     ~wxDbTableInf();
 413
 414     bool             Initialize();
 415 };
 416
 417
 418 class WXDLLIMPEXP_ODBC wxDbInf     // Description of a Database
 419 {
 420 public:
 421     wxChar        catalog[128+1];
 422     wxChar        schema[128+1];
 423     int           numTables;           // How many tables does this database have
 424     wxDbTableInf *pTableInf;           // pTableInf = new wxDbTableInf[numTables];
 425
 426     wxDbInf();
 427     ~wxDbInf();
 428
 429     bool          Initialize();
 430 };
 431
 432
 433 enum wxDbSqlLogState
 434 {
 435     sqlLogOFF,
 436     sqlLogON
 437 };
 438
 439 // These are the databases currently tested and working with these classes
 440 // See the comments in wxDb::Dbms() for exceptions/issues with
 441 // each of these database engines
 442 enum wxDBMS
 443 {
 444     dbmsUNIDENTIFIED,
 445     dbmsORACLE,
 446     dbmsSYBASE_ASA,        // Adaptive Server Anywhere
 447     dbmsSYBASE_ASE,        // Adaptive Server Enterprise
 448     dbmsMS_SQL_SERVER,
 449     dbmsMY_SQL,
 450     dbmsPOSTGRES,
 451     dbmsACCESS,
 452     dbmsDBASE,
 453     dbmsINFORMIX,
 454     dbmsVIRTUOSO,
 455     dbmsDB2,
 456     dbmsINTERBASE,
 457     dbmsPERVASIVE_SQL,
 458     dbmsXBASE_SEQUITER
 459 };
 460
 461
 462 // The wxDb::errorList is copied to this variable when the wxDb object
 463 // is closed.  This way, the error list is still available after the
 464 // database object is closed.  This is necessary if the database
 465 // connection fails so the calling application can show the operator
 466 // why the connection failed.  Note: as each wxDb object is closed, it
 467 // will overwrite the errors of the previously destroyed wxDb object in
 468 // this variable.
 469
 470 WXDLLIMPEXP_DATA_ODBC(extern wxChar)
 471     DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
 472
 473
 474 class WXDLLIMPEXP_ODBC wxDb
 475 {
 476 private:
 477     bool             dbIsOpen;
 478     bool             dbIsCached;      // Was connection created by caching functions
 479     bool             dbOpenedWithConnectionString;  // Was the database connection opened with a connection string
 480     wxString         dsn;             // Data source name
 481     wxString         uid;             // User ID
 482     wxString         authStr;         // Authorization string (password)
 483     wxString         inConnectionStr; // Connection string used to connect to the database
 484     wxString         outConnectionStr;// Connection string returned by the database when a connection is successfully opened
 485     FILE            *fpSqlLog;        // Sql Log file pointer
 486     wxDbSqlLogState  sqlLogState;     // On or Off
 487     bool             fwdOnlyCursors;
 488     wxDBMS           dbmsType;        // Type of datasource - i.e. Oracle, dBase, SQLServer, etc
 489
 490     // Private member functions
 491     bool             getDbInfo(bool failOnDataTypeUnsupported=TRUE);
 492     bool             getDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo);
 493     bool             setConnectionOptions(void);
 494     void             logError(const wxString &errMsg, const wxString &SQLState);
 495     const wxChar    *convertUserID(const wxChar *userID, wxString &UserID);
 496     void             initialize();
 497     bool             open(bool failOnDataTypeUnsupported=TRUE);
 498
 499 #if !wxODBC_BACKWARD_COMPATABILITY
 500     // ODBC handles
 501     HENV  henv;        // ODBC Environment handle
 502     HDBC  hdbc;        // ODBC DB Connection handle
 503     HSTMT hstmt;       // ODBC Statement handle
 504
 505     //Error reporting mode
 506     bool silent;
 507
 508     // Number of Ctable objects connected to this db object.  FOR INTERNAL USE ONLY!!!
 509     unsigned int nTables;
 510
 511     // Information about logical data types VARCHAR, INTEGER, FLOAT and DATE.
 512      //
 513     // This information is obtained from the ODBC driver by use of the
 514     // SQLGetTypeInfo() function.  The key piece of information is the
 515     // type name the data source uses for each logical data type.
 516     // e.g. VARCHAR; Oracle calls it VARCHAR2.
 517     wxDbSqlTypeInfo typeInfVarchar;
 518     wxDbSqlTypeInfo typeInfInteger;
 519     wxDbSqlTypeInfo typeInfFloat;
 520     wxDbSqlTypeInfo typeInfDate;
 521     wxDbSqlTypeInfo typeInfBlob;
 522 #endif
 523
 524 public:
 525
 526     void             setCached(bool cached)  { dbIsCached = cached; };  // This function must only be called by wxDbGetConnection() and wxDbCloseConnections!!!
 527     bool             IsCached() { return dbIsCached; };
 528
 529     bool             GetDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo)
 530                             { return getDataTypeInfo(fSqlType, structSQLTypeInfo); }
 531
 532 #if wxODBC_BACKWARD_COMPATABILITY
 533     // ODBC handles
 534     HENV  henv;        // ODBC Environment handle
 535     HDBC  hdbc;        // ODBC DB Connection handle
 536     HSTMT hstmt;       // ODBC Statement handle
 537
 538     //Error reporting mode
 539     bool silent;
 540
 541     // Number of Ctable objects connected to this db object.  FOR INTERNAL USE ONLY!!!
 542     unsigned int nTables;
 543 #endif
 544
 545     // The following structure contains database information gathered from the
 546     // datasource when the datasource is first opened.
 547     struct
 548     {
 549         wxChar dbmsName[40];                             // Name of the dbms product
 550         wxChar dbmsVer[64];                              // Version # of the dbms product
 551         wxChar driverName[40];                           // Driver name
 552         wxChar odbcVer[60];                              // ODBC version of the driver
 553         wxChar drvMgrOdbcVer[60];                        // ODBC version of the driver manager
 554         wxChar driverVer[60];                            // Driver version
 555         wxChar serverName[80];                           // Server Name, typically a connect string
 556         wxChar databaseName[128];                        // Database filename
 557         wxChar outerJoins[2];                            // Indicates whether the data source supports outer joins
 558         wxChar procedureSupport[2];                      // Indicates whether the data source supports stored procedures
 559         wxChar accessibleTables[2];                      // Indicates whether the data source only reports accessible tables in SQLTables.
 560         UWORD  maxConnections;                           // Maximum # of connections the data source supports
 561         UWORD  maxStmts;                                 // Maximum # of HSTMTs per HDBC
 562         UWORD  apiConfLvl;                               // ODBC API conformance level
 563         UWORD  cliConfLvl;                               // Indicates whether the data source is SAG compliant
 564         UWORD  sqlConfLvl;                               // SQL conformance level
 565         UWORD  cursorCommitBehavior;                     // Indicates how cursors are affected by a db commit
 566         UWORD  cursorRollbackBehavior;                   // Indicates how cursors are affected by a db rollback
 567         UWORD  supportNotNullClause;                     // Indicates if data source supports NOT NULL clause
 568         wxChar supportIEF[2];                            // Integrity Enhancement Facility (Referential Integrity)
 569         UDWORD txnIsolation;                             // Default transaction isolation level supported by the driver
 570         UDWORD txnIsolationOptions;                      // Transaction isolation level options available
 571         UDWORD fetchDirections;                          // Fetch directions supported
 572         UDWORD lockTypes;                                // Lock types supported in SQLSetPos
 573         UDWORD posOperations;                            // Position operations supported in SQLSetPos
 574         UDWORD posStmts;                                 // Position statements supported
 575         UDWORD scrollConcurrency;                        // Concurrency control options supported for scrollable cursors
 576         UDWORD scrollOptions;                            // Scroll Options supported for scrollable cursors
 577         UDWORD staticSensitivity;                        // Indicates if additions, deletions and updates can be detected
 578         UWORD  txnCapable;                               // Indicates if the data source supports transactions
 579         UDWORD loginTimeout;                             // Number seconds to wait for a login request
 580     } dbInf;
 581
 582     // ODBC Error Inf.
 583     SWORD  cbErrorMsg;
 584     int    DB_STATUS;
 585     wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
 586     wxChar errorMsg[SQL_MAX_MESSAGE_LENGTH];
 587     SDWORD nativeError;
 588     wxChar sqlState[20];
 589
 590 #if wxODBC_BACKWARD_COMPATABILITY
 591     // Information about logical data types VARCHAR, INTEGER, FLOAT and DATE.
 592      //
 593     // This information is obtained from the ODBC driver by use of the
 594     // SQLGetTypeInfo() function.  The key piece of information is the
 595     // type name the data source uses for each logical data type.
 596     // e.g. VARCHAR; Oracle calls it VARCHAR2.
 597     wxDbSqlTypeInfo typeInfVarchar;
 598     wxDbSqlTypeInfo typeInfInteger;
 599     wxDbSqlTypeInfo typeInfFloat;
 600     wxDbSqlTypeInfo typeInfDate;
 601     wxDbSqlTypeInfo typeInfBlob;
 602 #endif
 603
 604     // Public member functions
 605     wxDb(const HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
 606     ~wxDb();
 607
 608     // Data Source Name, User ID, Password and whether open should fail on data type not supported
 609     bool         Open(const wxString& inConnectStr, bool failOnDataTypeUnsupported=TRUE);
 610     bool         Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr, bool failOnDataTypeUnsupported=TRUE);
 611     bool         Open(wxDbConnectInf *dbConnectInf, bool failOnDataTypeUnsupported=TRUE);
 612     bool         Open(wxDb *copyDb);  // pointer to a wxDb whose connection info should be copied rather than re-queried
 613     void         Close(void);
 614     bool         CommitTrans(void);
 615     bool         RollbackTrans(void);
 616     bool         DispAllErrors(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
 617     bool         GetNextError(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
 618     void         DispNextError(void);
 619     bool         CreateView(const wxString &viewName, const wxString &colList, const wxString &pSqlStmt, bool attemptDrop=TRUE);
 620     bool         DropView(const wxString &viewName);
 621     bool         ExecSql(const wxString &pSqlStmt);
 622     bool         GetNext(void);
 623     bool         GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SDWORD FAR *cbReturned);
 624     bool         Grant(int privileges, const wxString &tableName, const wxString &userList = wxT("PUBLIC"));
 625     int          TranslateSqlState(const wxString &SQLState);
 626     wxDbInf     *GetCatalog(const wxChar *userID=NULL);
 627     bool         Catalog(const wxChar *userID=NULL, const wxString &fileName=SQL_CATALOG_FILENAME);
 628     int          GetKeyFields(const wxString &tableName, wxDbColInf* colInf, UWORD noCols);
 629
 630     wxDbColInf  *GetColumns(wxChar *tableName[], const wxChar *userID=NULL);
 631     wxDbColInf  *GetColumns(const wxString &tableName, UWORD *numCols, const wxChar *userID=NULL);
 632
 633     int             GetColumnCount(const wxString &tableName, const wxChar *userID=NULL);
 634     const wxChar   *GetDatabaseName(void)  {return dbInf.dbmsName;}
 635     const wxString &GetDataSource(void)    {return dsn;}
 636     const wxString &GetDatasourceName(void){return dsn;}
 637     const wxString &GetUsername(void)      {return uid;}
 638     const wxString &GetPassword(void)      {return authStr;}
 639     const wxString &GetConnectionInStr(void)  {return inConnectionStr;}
 640     const wxString &GetConnectionOutStr(void) {return outConnectionStr;}
 641     bool            IsOpen(void)           {return dbIsOpen;}
 642     bool            OpenedWithConnectionString(void) {return dbOpenedWithConnectionString;}
 643     HENV            GetHENV(void)          {return henv;}
 644     HDBC            GetHDBC(void)          {return hdbc;}
 645     HSTMT           GetHSTMT(void)         {return hstmt;}
 646     int             GetTableCount()        {return nTables;}  // number of tables using this connection
 647     wxDbSqlTypeInfo GetTypeInfVarchar()    {return typeInfVarchar;}
 648     wxDbSqlTypeInfo GetTypeInfInteger()    {return typeInfInteger;}
 649     wxDbSqlTypeInfo GetTypeInfFloat()      {return typeInfFloat;}
 650     wxDbSqlTypeInfo GetTypeInfDate()       {return typeInfDate;}
 651     wxDbSqlTypeInfo GetTypeInfBlob()       {return typeInfBlob;}
 652
 653     // tableName can refer to a table, view, alias or synonym
 654     bool         TableExists(const wxString &tableName, const wxChar *userID=NULL,
 655                              const wxString &tablePath=wxEmptyString);
 656     bool         TablePrivileges(const wxString &tableName, const wxString &priv,
 657                                  const wxChar *userID=NULL, const wxChar *schema=NULL,
 658                                  const wxString &path=wxEmptyString);
 659
 660     // These two functions return the table name or column name in a form ready
 661     // for use in SQL statements.  For example, if the datasource allows spaces
 662     // in the table name or column name, the returned string will have the
 663     // correct enclosing marks around the name to allow it to be properly
 664     // included in a SQL statement
 665     const wxString  SQLTableName(const wxChar *tableName);
 666     const wxString  SQLColumnName(const wxChar *colName);
 667
 668     void         LogError(const wxString &errMsg, const wxString &SQLState = wxEmptyString)
 669                         { logError(errMsg, SQLState); }
 670     void         SetDebugErrorMessages(bool state) { silent = !state; }
 671     bool         SetSqlLogging(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME,
 672                                bool append = FALSE);
 673     bool         WriteSqlLog(const wxString &logMsg);
 674
 675     wxDBMS       Dbms(void);
 676     bool         ModifyColumn(const wxString &tableName, const wxString &columnName,
 677                               int dataType, ULONG columnLength=0,
 678                               const wxString &optionalParam=wxEmptyString);
 679
 680     bool         FwdOnlyCursors(void)  {return fwdOnlyCursors;}
 681
 682     // These two functions are provided strictly for use by wxDbTable.
 683     // DO NOT USE THESE FUNCTIONS, OR MEMORY LEAKS MAY OCCUR
 684     void         incrementTableCount() { nTables++; return; }
 685     void         decrementTableCount() { nTables--; return; }
 686
 687 };  // wxDb
 688
 689
 690 // This structure forms a node in a linked list.  The linked list of "DbList" objects
 691 // keeps track of allocated database connections.  This allows the application to
 692 // open more than one database connection through ODBC for multiple transaction support
 693 // or for multiple database support.
 694 struct wxDbList
 695 {
 696     wxDbList *PtrPrev;       // Pointer to previous item in the list
 697     wxString  Dsn;           // Data Source Name
 698     wxString  Uid;           // User ID
 699     wxString  AuthStr;       // Authorization string (password)
 700     wxString  ConnectionStr; // Connection string used instead of DSN
 701     wxDb     *PtrDb;         // Pointer to the wxDb object
 702     bool      Free;          // Is item free or in use?
 703     wxDbList *PtrNext;       // Pointer to next item in the list
 704 };
 705
 706
 707 #ifdef __WXDEBUG__
 708 #include "wx/object.h"
 709 class wxTablesInUse : public wxObject
 710 {
 711     public:
 712         const wxChar  *tableName;
 713         ULONG          tableID;
 714         class wxDb    *pDb;
 715 };  // wxTablesInUse
 716 #endif
 717
 718
 719 // The following routines allow a user to get new database connections, free them
 720 // for other code segments to use, or close all of them when the application has
 721 // completed.
 722 wxDb  WXDLLIMPEXP_ODBC *wxDbGetConnection(wxDbConnectInf *pDbConfig, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
 723 bool  WXDLLIMPEXP_ODBC  wxDbFreeConnection(wxDb *pDb);
 724 void  WXDLLIMPEXP_ODBC  wxDbCloseConnections(void);
 725 int   WXDLLIMPEXP_ODBC  wxDbConnectionsInUse(void);
 726
 727
 728 // Writes a message to the wxLog window (stdout usually) when an internal error
 729 // situation occurs.  This function only works in DEBUG builds
 730 const wxChar WXDLLIMPEXP_ODBC *
 731 wxDbLogExtendedErrorMsg(const wxChar *userText,
 732                         wxDb *pDb,
 733                         const wxChar *ErrFile,
 734                         int ErrLine);
 735
 736
 737 // This function sets the sql log state for all open wxDb objects
 738 bool WXDLLIMPEXP_ODBC
 739 wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);
 740
 741
 742 #if 0
 743 // MSW/VC6 ONLY!!!  Experimental
 744 int WXDLLEXPORT wxDbCreateDataSource(const wxString &driverName, const wxString &dsn, const wxString &description=wxEmptyString,
 745                                      bool sysDSN=FALSE, const wxString &defDir=wxEmptyString, wxWindow *parent=NULL);
 746 #endif
 747
 748 // This routine allows you to query a driver manager
 749 // for a list of available datasources.  Call this routine
 750 // the first time using SQL_FETCH_FIRST.  Continue to call it
 751 // using SQL_FETCH_NEXT until you've exhausted the list.
 752 bool WXDLLIMPEXP_ODBC
 753 wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMax, wxChar *DsDesc,
 754                   SWORD DsDescMax, UWORD direction = SQL_FETCH_NEXT);
 755
 756
 757 // Change this to 0 to remove use of all deprecated functions
 758 #if wxODBC_BACKWARD_COMPATABILITY
 759 //#################################################################################
 760 //############### DEPRECATED functions for backward compatability #################
 761 //#################################################################################
 762
 763 // Backward compability structures/classes.  This will eventually go away
 764 const int DB_PATH_MAX      = wxDB_PATH_MAX;
 765
 766 typedef wxDb                 wxDB;
 767 typedef wxDbTableInf         wxTableInf;
 768 typedef wxDbColInf           wxColInf;
 769 typedef wxDbColInf           CcolInf;
 770 typedef wxDbColFor           wxColFor;
 771 typedef wxDbSqlTypeInfo      SqlTypeInfo;
 772 typedef wxDbSqlTypeInfo      wxSqlTypeInfo;
 773 typedef enum wxDbSqlLogState sqlLog;
 774 typedef enum wxDbSqlLogState wxSqlLogState;
 775 typedef enum wxDBMS          dbms;
 776 typedef enum wxDBMS          DBMS;
 777 typedef wxODBC_ERRORS        ODBC_ERRORS;
 778 typedef wxDbConnectInf       DbStuff;
 779 typedef wxDbList             DbList;
 780 #ifdef __WXDEBUG__
 781 typedef wxTablesInUse        CstructTablesInUse;
 782 #endif
 783
 784 // Deprecated function names that are replaced by the function names listed above
 785 wxDB  WXDLLIMPEXP_ODBC
 786 *GetDbConnection(DbStuff *pDbStuff, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
 787 bool  WXDLLIMPEXP_ODBC  FreeDbConnection(wxDB *pDb);
 788 void  WXDLLIMPEXP_ODBC  CloseDbConnections(void);
 789 int   WXDLLIMPEXP_ODBC  NumberDbConnectionsInUse(void);
 790
 791 bool SqlLog(sqlLog state, const wxChar *filename = SQL_LOG_FILENAME);
 792
 793 bool WXDLLIMPEXP_ODBC
 794 GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
 795               UWORD direction = SQL_FETCH_NEXT);
 796
 797 #endif  // Deprecated structures/classes/functions
 798
 799 #endif // _WX_DB_H_
 800