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