]> git.saurik.com Git - wxWidgets.git/blame - include/wx/db.h
Added wxFileName.
[wxWidgets.git] / include / wx / db.h
CommitLineData
108106cf
JS
1///////////////////////////////////////////////////////////////////////////////
2// Name: db.h
f6bcfd97
BP
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
108106cf
JS
5// source such as opening and closing the data source.
6// Author: Doug Card
30a6d2d2 7// Modified by: George Tasker
3ca6a5f0 8// Bart Jourquin
a9f4558f 9// Mark Johnson, wxWindows@mj10777.de
ad2522ad 10// Mods: Dec, 1998:
a2115c88 11// -Added support for SQL statement logging and database cataloging
95ca6a20
GT
12// April, 1999
13// -Added QUERY_ONLY mode support to reduce default number of cursors
14// -Added additional SQL logging code
a2115c88 15// -Added DEBUG-ONLY tracking of Ctable objects to detect orphaned DB connections
95ca6a20
GT
16// -Set ODBC option to only read committed writes to the DB so all
17// databases operate the same in that respect
a2115c88 18//
108106cf
JS
19// Created: 9.96
20// RCS-ID: $Id$
21// Copyright: (c) 1996 Remstar International, Inc.
22// Licence: wxWindows licence, plus:
95ca6a20 23// Notice: This class library and its intellectual design are free of charge for use,
108106cf
JS
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.
1fc5dd6f 32//
108106cf
JS
33///////////////////////////////////////////////////////////////////////////////
34
35/*
36// SYNOPSIS START
37// SYNOPSIS STOP
38*/
39
40#ifndef DB_DOT_H
41#define DB_DOT_H
a2115c88 42
f6bcfd97
BP
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
e2f4e132 47#define EXPERIMENTAL_WXDB_FUNCTIONS 1
f6bcfd97 48
a2115c88
GT
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
95ca6a20 55 #ifdef __GNUG__
3ca6a5f0 56 #pragma interface "db.h"
95ca6a20 57 #endif
108106cf
JS
58#endif
59
16b52fa1
RR
60#include "wx/setup.h"
61
a2115c88 62#if wxMAJOR_VERSION == 2
95ca6a20 63 extern "C" {
e2f4e132
GT
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
95ca6a20
GT
75 #include "wx/isql.h"
76 #include "wx/isqlext.h"
e2f4e132 77#endif
95ca6a20 78 }
a2115c88 79#else // version == 1
95ca6a20 80 extern "C" {
e2f4e132
GT
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
95ca6a20
GT
89 #include "iodbc.h"
90 #include "isqlext.h"
e2f4e132 91#endif
95ca6a20 92 }
a2115c88 93#endif
30a6d2d2 94
595b5c4e
MJ
95typedef float SFLOAT;
96typedef double SDOUBLE;
95ca6a20
GT
97typedef unsigned int UINT;
98#define ULONG UDWORD
30a6d2d2
GT
99
100#ifndef wxODBC_FWD_ONLY_CURSORS
101#define wxODBC_FWD_ONLY_CURSORS 1
102#endif
103
95ca6a20 104enum enumDummy {enumDum1};
7e616b10 105
a2115c88 106#define SQL_C_BOOLEAN(datatype) (sizeof(datatype) == 1 ? SQL_C_UTINYINT : (sizeof(datatype) == 2 ? SQL_C_USHORT : SQL_C_ULONG))
95ca6a20 107// #define SQL_C_BOOLEAN (sizeof(Bool) == 2 ? SQL_C_USHORT : SQL_C_ULONG)
7e616b10 108
a2115c88 109#define SQL_C_ENUM (sizeof(enumDummy) == 2 ? SQL_C_USHORT : SQL_C_ULONG)
108106cf 110
a2115c88
GT
111#ifndef TRUE
112#define TRUE 1
7e616b10
RR
113#endif
114
a2115c88
GT
115#ifndef FALSE
116#define FALSE 0
117#endif
108106cf 118
f6bcfd97 119const int wxDB_PATH_MAX = 254;
95ca6a20 120
ad2522ad
BJ
121extern char const *SQL_LOG_FILENAME;
122extern char const *SQL_CATALOG_FILENAME;
123
108106cf 124
108106cf 125// Database Globals
95ca6a20 126const int DB_TYPE_NAME_LEN = 40;
eb3b9dda
GT
127const int DB_MAX_STATEMENT_LEN = 4096;
128const int DB_MAX_WHERE_CLAUSE_LEN = 2048;
95ca6a20
GT
129const int DB_MAX_ERROR_MSG_LEN = 512;
130const int DB_MAX_ERROR_HISTORY = 5;
131const int DB_MAX_TABLE_NAME_LEN = 128;
132const int DB_MAX_COLUMN_NAME_LEN = 128;
133
134const int DB_DATA_TYPE_VARCHAR = 1;
135const int DB_DATA_TYPE_INTEGER = 2;
136const int DB_DATA_TYPE_FLOAT = 3;
137const int DB_DATA_TYPE_DATE = 4;
138
139const int DB_SELECT_KEYFIELDS = 1;
140const int DB_SELECT_WHERE = 2;
141const int DB_SELECT_MATCHING = 3;
142const int DB_SELECT_STATEMENT = 4;
143
144const int DB_UPD_KEYFIELDS = 1;
145const int DB_UPD_WHERE = 2;
146
147const int DB_DEL_KEYFIELDS = 1;
148const int DB_DEL_WHERE = 2;
149const int DB_DEL_MATCHING = 3;
150
151const int DB_WHERE_KEYFIELDS = 1;
152const int DB_WHERE_MATCHING = 2;
153
154const int DB_GRANT_SELECT = 1;
155const int DB_GRANT_INSERT = 2;
156const int DB_GRANT_UPDATE = 4;
157const int DB_GRANT_DELETE = 8;
158const int DB_GRANT_ALL = DB_GRANT_SELECT | DB_GRANT_INSERT | DB_GRANT_UPDATE | DB_GRANT_DELETE;
108106cf
JS
159
160// ODBC Error codes (derived from ODBC SqlState codes)
fdc03678 161enum wxODBC_ERRORS
108106cf 162{
95ca6a20
GT
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'
108106cf
JS
255};
256
95ca6a20 257
fdc03678 258struct wxDbConnectInf
108106cf 259{
95ca6a20
GT
260 HENV Henv;
261 char Dsn[SQL_MAX_DSN_LENGTH+1]; // Data Source Name
262 char Uid[20+1]; // User ID
263 char AuthStr[20+1]; // Authorization string (password)
a2115c88 264
95ca6a20
GT
265 char description[SQL_MAX_DSN_LENGTH+1]; // Not sure what the max length is
266 char fileType[SQL_MAX_DSN_LENGTH+1]; // Not sure what the max length is
a2115c88 267
95ca6a20 268 // Optionals needed for some databases like dBase
f6bcfd97 269 char defaultDir[wxDB_PATH_MAX]; // Directory that db file resides in
108106cf
JS
270};
271
f6bcfd97 272struct wxDbSqlTypeInfo
108106cf 273{
95ca6a20
GT
274 char TypeName[DB_TYPE_NAME_LEN];
275 int FsqlType;
276 long Precision;
277 short CaseSensitive;
278// short MinimumScale;
279 short MaximumScale;
fdc03678 280};
108106cf 281
95ca6a20 282
f6bcfd97 283class WXDLLEXPORT wxDbColFor
30a6d2d2 284{
95ca6a20
GT
285public:
286 wxString s_Field; // Formated String for Output
287 wxString s_Format[7]; // Formated Objects - TIMESTAMP has the biggest (7)
3ca6a5f0
BP
288 wxString s_Amount[7]; // Formated Objects - amount of things that can be formatted
289 int i_Amount[7]; // Formated Objects - TT MM YYYY HH MM SS m
95ca6a20
GT
290 int i_Nation; // 0 = timestamp , 1=EU, 2=UK, 3=International, 4=US
291 int i_dbDataType; // conversion of the 'sqlDataType' to the generic data type used by these classes
292 SWORD i_sqlDataType;
293
f6bcfd97
BP
294 wxDbColFor();
295 ~wxDbColFor();
595b5c4e 296
95ca6a20 297 int Format(int Nation, int dbDataType, SWORD sqlDataType, short columnSize, short decimalDigits);
30a6d2d2
GT
298};
299
95ca6a20 300
f6bcfd97 301class WXDLLEXPORT wxDbColInf
108106cf
JS
302{
303public:
95ca6a20
GT
304 char catalog[128+1];
305 char schema[128+1];
306 char tableName[DB_MAX_TABLE_NAME_LEN+1];
307 char colName[DB_MAX_COLUMN_NAME_LEN+1];
308 SWORD sqlDataType;
309 char typeName[128+1];
310 SWORD columnSize;
311 SWORD bufferLength;
312 short decimalDigits;
313 short numPrecRadix;
314 short nullable;
315 char remarks[254+1];
316 int dbDataType; // conversion of the 'sqlDataType' to the generic data type used by these classes
30a6d2d2
GT
317 // mj10777.19991224 : new
318 int PkCol; // Primary key column 0=No; 1= First Key, 2 = Second Key etc.
319 char PkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Tables that use this PKey as a FKey
320 int FkCol; // Foreign key column 0=No; 1= First Key, 2 = Second Key etc.
321 char FkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Foreign key table name
f6bcfd97 322 wxDbColFor *pColFor; // How should this columns be formatted
3ca6a5f0
BP
323
324 wxDbColInf();
325 ~wxDbColInf();
30a6d2d2
GT
326};
327
95ca6a20 328
f6bcfd97
BP
329
330
331class WXDLLEXPORT wxDbTableInf // Description of a Table
95ca6a20 332{
30a6d2d2 333public:
f6bcfd97
BP
334 char tableName[DB_MAX_TABLE_NAME_LEN+1];
335 char tableType[254+1]; // "TABLE" or "SYSTEM TABLE" etc.
336 char tableRemarks[254+1];
337 int numCols; // How many Columns does this Table have: GetColumnCount(..);
338 wxDbColInf *pColInf; // pColInf = NULL ; User can later call GetColumns(..);
3ca6a5f0
BP
339 wxDbTableInf();
340 ~wxDbTableInf();
30a6d2d2
GT
341};
342
95ca6a20 343
30a6d2d2 344class WXDLLEXPORT wxDbInf // Description of a Database
95ca6a20 345{
30a6d2d2 346public:
f6bcfd97
BP
347 char catalog[128+1];
348 char schema[128+1];
349 int numTables; // How many tables does this database have
350 wxDbTableInf *pTableInf; // pTableInf = new wxDbTableInf[numTables];
3ca6a5f0
BP
351
352 wxDbInf();
353 ~wxDbInf();
108106cf
JS
354};
355
95ca6a20 356
f6bcfd97 357enum wxDbSqlLogState
1fc5dd6f 358{
95ca6a20
GT
359 sqlLogOFF,
360 sqlLogON
1fc5dd6f
JS
361};
362
95ca6a20 363// These are the databases currently tested and working with these classes
f6bcfd97 364// See the comments in wxDb::Dbms() for exceptions/issues with
95ca6a20 365// each of these database engines
fdc03678 366enum wxDBMS
a2115c88 367{
95ca6a20
GT
368 dbmsUNIDENTIFIED,
369 dbmsORACLE,
370 dbmsSYBASE_ASA, // Adaptive Server Anywhere
371 dbmsSYBASE_ASE, // Adaptive Server Enterprise
372 dbmsMS_SQL_SERVER,
373 dbmsMY_SQL,
374 dbmsPOSTGRES,
375 dbmsACCESS,
376 dbmsDBASE,
f6bcfd97 377 dbmsINFORMIX,
e2f4e132 378 dbmsVIRTUOSO,
d8a0a1c9
GT
379 dbmsDB2,
380 dbmsINTERBASE
a2115c88
GT
381};
382
95ca6a20 383
f6bcfd97 384// The wxDb::errorList is copied to this variable when the wxDb object
a2115c88 385// is closed. This way, the error list is still available after the
595b5c4e 386// database object is closed. This is necessary if the database
a2115c88 387// connection fails so the calling application can show the operator
f6bcfd97
BP
388// why the connection failed. Note: as each wxDb object is closed, it
389// will overwrite the errors of the previously destroyed wxDb object in
a2115c88
GT
390// this variable.
391extern char DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
392
95ca6a20 393
f6bcfd97 394class WXDLLEXPORT wxDb
108106cf
JS
395{
396private:
95ca6a20
GT
397 bool dbIsOpen;
398 char *dsn; // Data source name
399 char *uid; // User ID
400 char *authStr; // Authorization string (password)
401 FILE *fpSqlLog; // Sql Log file pointer
f6bcfd97 402 wxDbSqlLogState sqlLogState; // On or Off
95ca6a20 403 bool fwdOnlyCursors;
e2f4e132 404 wxDBMS dbmsType; // Type of datasource - i.e. Oracle, dBase, SQLServer, etc
95ca6a20
GT
405
406 // Private member functions
407 bool getDbInfo(void);
f6bcfd97 408 bool getDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo);
95ca6a20
GT
409 bool setConnectionOptions(void);
410 void logError(const char *errMsg, const char *SQLState);
e2f4e132 411 void initialize();
f6bcfd97
BP
412#if !wxODBC_BACKWARD_COMPATABILITY
413 // ODBC handles
414 HENV henv; // ODBC Environment handle
415 HDBC hdbc; // ODBC DB Connection handle
416 HSTMT hstmt; // ODBC Statement handle
417
418 //Error reporting mode
419 bool silent;
420
421 // Number of Ctable objects connected to this db object. FOR INTERNAL USE ONLY!!!
422 unsigned int nTables;
423
424 // Information about logical data types VARCHAR, INTEGER, FLOAT and DATE.
3ca6a5f0 425 //
f6bcfd97
BP
426 // This information is obtained from the ODBC driver by use of the
427 // SQLGetTypeInfo() function. The key piece of information is the
428 // type name the data source uses for each logical data type.
429 // e.g. VARCHAR; Oracle calls it VARCHAR2.
430 wxDbSqlTypeInfo typeInfVarchar;
431 wxDbSqlTypeInfo typeInfInteger;
432 wxDbSqlTypeInfo typeInfFloat;
433 wxDbSqlTypeInfo typeInfDate;
434#endif
a3439c7d 435
108106cf 436public:
f6bcfd97
BP
437#if wxODBC_BACKWARD_COMPATABILITY
438 // ODBC handles
439 HENV henv; // ODBC Environment handle
440 HDBC hdbc; // ODBC DB Connection handle
441 HSTMT hstmt; // ODBC Statement handle
442
443 //Error reporting mode
444 bool silent;
445
446 // Number of Ctable objects connected to this db object. FOR INTERNAL USE ONLY!!!
447 unsigned int nTables;
448#endif
449
95ca6a20
GT
450 // The following structure contains database information gathered from the
451 // datasource when the datasource is first opened.
452 struct
453 {
454 char dbmsName[40]; // Name of the dbms product
455 char dbmsVer[64]; // Version # of the dbms product
456 char driverName[40]; // Driver name
457 char odbcVer[60]; // ODBC version of the driver
458 char drvMgrOdbcVer[60]; // ODBC version of the driver manager
459 char driverVer[60]; // Driver version
460 char serverName[80]; // Server Name, typically a connect string
461 char databaseName[128]; // Database filename
462 char outerJoins[2]; // Indicates whether the data source supports outer joins
463 char procedureSupport[2]; // Indicates whether the data source supports stored procedures
3ca6a5f0 464 char accessibleTables[2]; // Indicates whether the data source only reports accessible tables in SQLTables.
95ca6a20
GT
465 UWORD maxConnections; // Maximum # of connections the data source supports
466 UWORD maxStmts; // Maximum # of HSTMTs per HDBC
467 UWORD apiConfLvl; // ODBC API conformance level
468 UWORD cliConfLvl; // Indicates whether the data source is SAG compliant
469 UWORD sqlConfLvl; // SQL conformance level
470 UWORD cursorCommitBehavior; // Indicates how cursors are affected by a db commit
471 UWORD cursorRollbackBehavior; // Indicates how cursors are affected by a db rollback
472 UWORD supportNotNullClause; // Indicates if data source supports NOT NULL clause
473 char supportIEF[2]; // Integrity Enhancement Facility (Referential Integrity)
474 UDWORD txnIsolation; // Default transaction isolation level supported by the driver
475 UDWORD txnIsolationOptions; // Transaction isolation level options available
476 UDWORD fetchDirections; // Fetch directions supported
477 UDWORD lockTypes; // Lock types supported in SQLSetPos
478 UDWORD posOperations; // Position operations supported in SQLSetPos
479 UDWORD posStmts; // Position statements supported
480 UDWORD scrollConcurrency; // Concurrency control options supported for scrollable cursors
481 UDWORD scrollOptions; // Scroll Options supported for scrollable cursors
482 UDWORD staticSensitivity; // Indicates if additions, deletions and updates can be detected
483 UWORD txnCapable; // Indicates if the data source supports transactions
484 UDWORD loginTimeout; // Number seconds to wait for a login request
485 } dbInf;
486
95ca6a20 487 // ODBC Error Inf.
95ca6a20 488 SWORD cbErrorMsg;
95ca6a20 489 int DB_STATUS;
f6bcfd97
BP
490 wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
491 wxChar errorMsg[SQL_MAX_MESSAGE_LENGTH];
492 SDWORD nativeError;
493 wxChar sqlState[20];
95ca6a20 494
f6bcfd97
BP
495#if wxODBC_BACKWARD_COMPATABILITY
496 // Information about logical data types VARCHAR, INTEGER, FLOAT and DATE.
3ca6a5f0 497 //
f6bcfd97
BP
498 // This information is obtained from the ODBC driver by use of the
499 // SQLGetTypeInfo() function. The key piece of information is the
95ca6a20
GT
500 // type name the data source uses for each logical data type.
501 // e.g. VARCHAR; Oracle calls it VARCHAR2.
f6bcfd97
BP
502 wxDbSqlTypeInfo typeInfVarchar;
503 wxDbSqlTypeInfo typeInfInteger;
504 wxDbSqlTypeInfo typeInfFloat;
505 wxDbSqlTypeInfo typeInfDate;
506#endif
595b5c4e 507
95ca6a20 508 // Public member functions
3ca6a5f0 509 wxDb(HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
95ca6a20 510 bool Open(char *Dsn, char *Uid, char *AuthStr); // Data Source Name, User ID, Password
e2f4e132 511 bool Open(wxDb *copyDb); // pointer to a wxDb whose connection info should be copied rather than re-queried
95ca6a20
GT
512 void Close(void);
513 bool CommitTrans(void);
514 bool RollbackTrans(void);
515 bool DispAllErrors(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
516 bool GetNextError(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
517 void DispNextError(void);
518 bool CreateView(const char *viewName, const char *colList, const char *pSqlStmt, bool attemptDrop=TRUE);
519 bool DropView(const char *viewName);
520 bool ExecSql(const char *pSqlStmt);
521 bool GetNext(void);
522 bool GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SDWORD FAR *cbReturned);
523 bool Grant(int privileges, const char *tableName, const char *userList = "PUBLIC");
f6bcfd97 524 int TranslateSqlState(const wxChar *SQLState);
95ca6a20
GT
525 wxDbInf *GetCatalog(char *userID);
526 bool Catalog(const char *userID=NULL, const char *fileName = SQL_CATALOG_FILENAME);
f6bcfd97
BP
527 int GetKeyFields(char *tableName, wxDbColInf* colInf, int nocols);
528
529 wxDbColInf *GetColumns(char *tableName[], const char *userID=NULL);
530 wxDbColInf *GetColumns(char *tableName, int *numCols, const char *userID=NULL);
531
95ca6a20 532 int GetColumnCount(char *tableName, const char *userID=NULL);
e2f4e132
GT
533 const char *GetDatabaseName(void) {return dbInf.dbmsName;}
534 const char *GetDataSource(void) {return (const char *)dsn;}
eb3b9dda 535 const char *GetDatasourceName(void){return (const char *)dsn;}
e2f4e132
GT
536 const char *GetUsername(void) {return (const char *)uid;}
537 const char *GetPassword(void) {return (const char *)authStr;}
538 bool IsOpen(void) {return dbIsOpen;}
539 HENV GetHENV(void) {return henv;}
540 HDBC GetHDBC(void) {return hdbc;}
541 HSTMT GetHSTMT(void) {return hstmt;}
542 int GetTableCount() {return nTables;}; // number of tables using this connection
543 wxDbSqlTypeInfo GetTypeInfVarchar() {return typeInfVarchar;}
544 wxDbSqlTypeInfo GetTypeInfInteger() {return typeInfInteger;}
545 wxDbSqlTypeInfo GetTypeInfFloat() {return typeInfFloat;}
546 wxDbSqlTypeInfo GetTypeInfDate() {return typeInfDate;}
f6bcfd97 547
95ca6a20 548 bool TableExists(const char *tableName, const char *userID=NULL, const char *path=NULL); // Table name can refer to a table, view, alias or synonym
eb3b9dda
GT
549 bool TablePrivileges(const char *tableName, const char* priv, const char *userID="", const char *schema=NULL, const char *path=""); // Table name can refer to a table, view, alias or synonym
550 void LogError(const char *errMsg, const char *SQLState = NULL) {logError(errMsg, SQLState);}
f6bcfd97
BP
551 void SetDebugErrorMessages(bool state) { silent = !state; }
552 bool SetSqlLogging(wxDbSqlLogState state, const wxChar *filename = SQL_LOG_FILENAME, bool append = FALSE);
553 bool WriteSqlLog(const wxChar *logMsg);
fdc03678 554 wxDBMS Dbms(void);
f6bcfd97
BP
555 bool FwdOnlyCursors(void) {return fwdOnlyCursors;}
556
557 // These two functions are provided strictly for use by wxDbTable.
558 // DO NOT USE THESE FUNCTIONS, OR MEMORY LEAKS MAY OCCUR
559 void incrementTableCount() { nTables++; return; }
560 void decrementTableCount() { nTables--; return; }
561
562}; // wxDb
108106cf 563
fdc03678 564
108106cf
JS
565// This structure forms a node in a linked list. The linked list of "DbList" objects
566// keeps track of allocated database connections. This allows the application to
567// open more than one database connection through ODBC for multiple transaction support
568// or for multiple database support.
fdc03678 569struct wxDbList
108106cf 570{
fdc03678 571 wxDbList *PtrPrev; // Pointer to previous item in the list
f6bcfd97 572 wxChar Dsn[SQL_MAX_DSN_LENGTH+1]; // Data Source Name
e2f4e132
GT
573 wxChar Uid[20+1]; // User ID
574 wxChar AuthStr[20+1]; // Authorization string (password)
f6bcfd97 575 wxDb *PtrDb; // Pointer to the wxDb object
fdc03678
GT
576 bool Free; // Is item free or in use?
577 wxDbList *PtrNext; // Pointer to next item in the list
108106cf
JS
578};
579
154f22b3 580#ifdef __WXDEBUG__
e115e771 581#include "wx/object.h"
fdc03678 582class wxTablesInUse : public wxObject
a2115c88 583{
95ca6a20
GT
584 public:
585 const char *tableName;
586 ULONG tableID;
f6bcfd97 587 class wxDb *pDb;
fdc03678 588}; // wxTablesInUse
a2115c88
GT
589#endif
590
fdc03678 591
108106cf
JS
592// The following routines allow a user to get new database connections, free them
593// for other code segments to use, or close all of them when the application has
594// completed.
f6bcfd97
BP
595wxDb WXDLLEXPORT *wxDbGetConnection(wxDbConnectInf *pDbConfig, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
596bool WXDLLEXPORT wxDbFreeConnection(wxDb *pDb);
fdc03678 597void WXDLLEXPORT wxDbCloseConnections(void);
69d042c3 598int WXDLLEXPORT wxDbConnectionsInUse(void);
95ca6a20 599
108106cf 600
f6bcfd97
BP
601// This function sets the sql log state for all open wxDb objects
602bool wxDbSqlLog(wxDbSqlLogState state, const wxChar *filename = SQL_LOG_FILENAME);
fdc03678 603
95ca6a20 604
fdc03678
GT
605#if 0
606// MSW/VC6 ONLY!!! Experimental
595b5c4e 607int WXDLLEXPORT wxDbCreateDataSource(const char *driverName, const char *dsn, const char *description="",
fdc03678
GT
608 bool sysDSN=FALSE, const char *defDir="", wxWindow *parent=NULL);
609#endif
a2115c88 610
108106cf
JS
611// This routine allows you to query a driver manager
612// for a list of available datasources. Call this routine
613// the first time using SQL_FETCH_FIRST. Continue to call it
614// using SQL_FETCH_NEXT until you've exhausted the list.
fdc03678
GT
615bool WXDLLEXPORT wxDbGetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
616 UWORD direction = SQL_FETCH_NEXT);
617
618
619// Change this to 0 to remove use of all deprecated functions
f6bcfd97 620#if wxODBC_BACKWARD_COMPATABILITY
fdc03678
GT
621//#################################################################################
622//############### DEPRECATED functions for backward compatability #################
623//#################################################################################
624
625// Backward compability structures/classes. This will eventually go away
f6bcfd97
BP
626const int DB_PATH_MAX = wxDB_PATH_MAX;
627
628typedef wxDb wxDB;
629typedef wxDbTableInf wxTableInf;
630typedef wxDbColInf wxColInf;
631typedef wxDbColInf CcolInf;
632typedef wxDbColFor wxColFor;
633typedef wxDbSqlTypeInfo SqlTypeInfo;
634typedef wxDbSqlTypeInfo wxSqlTypeInfo;
635typedef enum wxDbSqlLogState sqlLog;
636typedef enum wxDbSqlLogState wxSqlLogState;
637typedef enum wxDBMS dbms;
638typedef enum wxDBMS DBMS;
639typedef wxODBC_ERRORS ODBC_ERRORS;
640typedef wxDbConnectInf DbStuff;
641typedef wxDbList DbList;
27508856 642#ifdef __WXDEBUG__
f6bcfd97 643typedef wxTablesInUse CstructTablesInUse;
27508856 644#endif
fdc03678
GT
645
646// Deprecated function names that are replaced by the function names listed above
647wxDB WXDLLEXPORT *GetDbConnection(DbStuff *pDbStuff, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
648bool WXDLLEXPORT FreeDbConnection(wxDB *pDb);
649void WXDLLEXPORT CloseDbConnections(void);
650int WXDLLEXPORT NumberDbConnectionsInUse(void);
651
f6bcfd97 652bool SqlLog(sqlLog state, const wxChar *filename = SQL_LOG_FILENAME);
fdc03678 653
30a6d2d2 654bool WXDLLEXPORT GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
95ca6a20 655 UWORD direction = SQL_FETCH_NEXT);
fdc03678 656#endif // Deprecated structures/classes/functions
108106cf
JS
657
658#endif