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