///////////////////////////////////////////////////////////////////////////////
-// Name: db.h
-// Purpose: Header file wxDB class. The wxDB class represents a connection
-// to an ODBC data source. The wxDB class allows operations on the data
+// Name: wx/db.h
+// Purpose: Header file wxDb class. The wxDb class represents a connection
+// to an ODBC data source. The wxDb class allows operations on the data
// source such as opening and closing the data source.
// Author: Doug Card
// Modified by: George Tasker
-// Mods: Dec, 1998:
+// Bart Jourquin
+// Mark Johnson, wxWindows@mj10777.de
+// Mods: Dec, 1998:
// -Added support for SQL statement logging and database cataloging
// April, 1999
// -Added QUERY_ONLY mode support to reduce default number of cursors
//
///////////////////////////////////////////////////////////////////////////////
-/*
-// SYNOPSIS START
-// SYNOPSIS STOP
-*/
+#ifndef _WX_DB_H_
+#define _WX_DB_H_
-#ifndef DB_DOT_H
-#define DB_DOT_H
-// Use this line for wxWindows v1.x
-//#include "wx_ver.h"
-// Use this line for wxWindows v2.x
+// BJO 20000503: introduce new GetColumns members which are more database independant and
+// return columns in the order they were created
+#define OLD_GETCOLUMNS 1
+#define EXPERIMENTAL_WXDB_FUNCTIONS 1
+
#include "wx/version.h"
-#if wxMAJOR_VERSION == 2
- #ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma interface "db.h"
- #endif
#endif
#include "wx/setup.h"
-#if wxMAJOR_VERSION == 2
- extern "C" {
- #include "wx/isql.h"
- #include "wx/isqlext.h"
- }
-#else // version == 1
+#include "wx/defs.h"
+#include "wx/string.h"
+
+#if defined(__VISUALC__)
+ // we need to include standard Windows headers but we can't include
+ // <windows.h> directly when using MFC because it includes it itself in a
+ // different manner
+ #if wxUSE_MFC
+ #include <afxwin.h>
+ #else // !wxUSE_MFC
+ #ifndef STRICT
+ #define STRICT 1
+ #endif
+
+ #include <windows.h>
+ #include "wx/msw/winundef.h"
+ #endif // wxUSE_MFC/!wxUSE_MFC
+
+ // If you use the wxDbCreateDataSource() function with MSW/VC6,
+ // you cannot use the iODBC headers, you must use the VC headers,
+ // plus the odbcinst.h header - gt Nov 2 2000
+ //
+ // Must add "odbccp32.lib" in \wx2\wxWindows\src\makevc.env to the WINLIBS= line
+ //
+ #include "sql.h"
+ #include "sqlext.h"
+ #include "odbcinst.h"
+#else
+ #if defined(__WINDOWS__) && ( defined(HAVE_W32API_H) || defined(__BORLANDC__) )
+ #include <windows.h>
+ #include "wx/msw/winundef.h"
+ #endif
extern "C" {
- #include "iodbc.h"
- #include "isqlext.h"
+ #if defined(wxUSE_BUILTIN_IODBC) && wxUSE_BUILTIN_IODBC
+ // Use the ones from the library
+ #include "wx/isql.h"
+ #include "wx/isqlext.h"
+ #else
+ #include <sql.h>
+ #include <sqlext.h>
+ #endif
}
#endif
-typedef float SFLOAT;
-typedef double SDOUBLE;
+
+typedef float SFLOAT;
+typedef double SDOUBLE;
typedef unsigned int UINT;
#define ULONG UDWORD
+// Not available in iODBC
+#ifndef __WXMSW__
+typedef UCHAR SQLTCHAR;
+#endif
+
#ifndef wxODBC_FWD_ONLY_CURSORS
#define wxODBC_FWD_ONLY_CURSORS 1
#endif
enum enumDummy {enumDum1};
+#ifndef SQL_C_BOOLEAN
#define SQL_C_BOOLEAN(datatype) (sizeof(datatype) == 1 ? SQL_C_UTINYINT : (sizeof(datatype) == 2 ? SQL_C_USHORT : SQL_C_ULONG))
-// #define SQL_C_BOOLEAN (sizeof(Bool) == 2 ? SQL_C_USHORT : SQL_C_ULONG)
+//# define SQL_C_BOOLEAN (sizeof(int) == 2 ? SQL_C_USHORT : SQL_C_ULONG)
+#endif
+#ifndef SQL_C_ENUM
#define SQL_C_ENUM (sizeof(enumDummy) == 2 ? SQL_C_USHORT : SQL_C_ULONG)
+#endif
+#ifndef SQL_C_BLOB
+ #ifdef SQL_LONGVARBINARY
+ #define SQL_C_BLOB SQL_LONGVARBINARY
+ #elif SQL_VARBINARY
+ #define SQL_C_BLOB SQL_VARBINARY
+ #endif
+#endif
+/*
#ifndef TRUE
-#define TRUE 1
+#define TRUE true
#endif
#ifndef FALSE
-#define FALSE 0
+#define FALSE false
#endif
+*/
+const int wxDB_PATH_MAX = 254;
-const int DB_PATH_MAX = 254;
-
-char * const SQL_LOG_FILENAME = "sqllog.txt";
-char * const SQL_CATALOG_FILENAME = "catalog.txt";
+WXDLLIMPEXP_DATA_ODBC(extern wxChar const *) SQL_LOG_FILENAME;
+WXDLLIMPEXP_DATA_ODBC(extern wxChar const *) SQL_CATALOG_FILENAME;
// Database Globals
const int DB_TYPE_NAME_LEN = 40;
-const int DB_MAX_STATEMENT_LEN = 2048;
-const int DB_MAX_WHERE_CLAUSE_LEN = 1024;
+const int DB_MAX_STATEMENT_LEN = 4096;
+const int DB_MAX_WHERE_CLAUSE_LEN = 2048;
const int DB_MAX_ERROR_MSG_LEN = 512;
const int DB_MAX_ERROR_HISTORY = 5;
const int DB_MAX_TABLE_NAME_LEN = 128;
const int DB_DATA_TYPE_INTEGER = 2;
const int DB_DATA_TYPE_FLOAT = 3;
const int DB_DATA_TYPE_DATE = 4;
+const int DB_DATA_TYPE_BLOB = 5;
const int DB_SELECT_KEYFIELDS = 1;
const int DB_SELECT_WHERE = 2;
const int DB_GRANT_ALL = DB_GRANT_SELECT | DB_GRANT_INSERT | DB_GRANT_UPDATE | DB_GRANT_DELETE;
// ODBC Error codes (derived from ODBC SqlState codes)
-enum ODBC_ERRORS
+enum wxODBC_ERRORS
{
DB_FAILURE = 0,
DB_SUCCESS = 1,
DB_ERR_TIMEOUT_EXPIRED // SqlState = 'S1T00'
};
+#ifndef MAXNAME
+#define MAXNAME 31
+#endif
+
+#ifndef SQL_MAX_AUTHSTR_LEN
+// There does not seem to be a standard for this, so I am
+// defaulting to the value that MS uses
+#define SQL_MAX_AUTHSTR_LEN MAXNAME
+#endif
-struct DbStuff
+class WXDLLIMPEXP_ODBC wxDbConnectInf
{
- HENV Henv;
- char Dsn[SQL_MAX_DSN_LENGTH+1]; // Data Source Name
- char Uid[20+1]; // User ID
- char AuthStr[20+1]; // Authorization string (password)
+ private:
+ bool freeHenvOnDestroy;
- char description[SQL_MAX_DSN_LENGTH+1]; // Not sure what the max length is
- char fileType[SQL_MAX_DSN_LENGTH+1]; // Not sure what the max length is
+ public:
+ HENV Henv;
+ wxChar Dsn[SQL_MAX_DSN_LENGTH+1]; // Data Source Name
+ wxChar Uid[SQL_MAX_USER_NAME_LEN+1]; // User ID
+ wxChar AuthStr[SQL_MAX_AUTHSTR_LEN+1]; // Authorization string (password)
- // Optionals needed for some databases like dBase
- char defaultDir[DB_PATH_MAX]; // Directory that db file resides in
-};
+ wxString Description; // Not sure what the max length is
+ wxString FileType; // Not sure what the max length is
+
+ // Optionals needed for some databases like dBase
+ wxString DefaultDir; // Directory that db file resides in
+
+ public:
+
+ wxDbConnectInf();
+ wxDbConnectInf(HENV henv, const wxString &dsn, const wxString &userID=wxEmptyString,
+ const wxString &password=wxEmptyString, const wxString &defaultDir=wxEmptyString,
+ const wxString &description=wxEmptyString, const wxString &fileType=wxEmptyString);
+
+ ~wxDbConnectInf();
+ bool Initialize();
-typedef struct
+ bool AllocHenv();
+ void FreeHenv();
+
+ // Accessors
+ const HENV &GetHenv() { return Henv; };
+
+ const wxChar *GetDsn() { return Dsn; };
+
+ const wxChar *GetUid() { return Uid; };
+ const wxChar *GetUserID() { return Uid; };
+
+ const wxChar *GetAuthStr() { return AuthStr; };
+ const wxChar *GetPassword() { return AuthStr; };
+
+ const wxChar *GetDescription() { return Description; };
+ const wxChar *GetFileType() { return FileType; };
+ const wxChar *GetDefaultDir() { return DefaultDir; };
+
+ void SetHenv(const HENV henv) { Henv = henv; };
+
+ void SetDsn(const wxString &dsn);
+
+ void SetUserID(const wxString &userID);
+ void SetUid(const wxString &uid) { SetUserID(uid); };
+
+ void SetPassword(const wxString &password);
+ void SetAuthStr(const wxString &authstr) { SetPassword(authstr); };
+
+ void SetDescription(const wxString &desc) { Description = desc; };
+ void SetFileType(const wxString &fileType) { FileType = fileType; };
+ void SetDefaultDir(const wxString &defDir) { DefaultDir = defDir; };
+}; // class wxDbConnectInf
+
+
+struct WXDLLIMPEXP_ODBC wxDbSqlTypeInfo
{
- char TypeName[DB_TYPE_NAME_LEN];
- int FsqlType;
- long Precision;
- short CaseSensitive;
-// short MinimumScale;
- short MaximumScale;
-} SqlTypeInfo;
+ wxString TypeName;
+ SWORD FsqlType;
+ long Precision;
+ short CaseSensitive;
+// short MinimumScale;
+ short MaximumScale;
+};
-class WXDLLEXPORT wxColFor
+class WXDLLIMPEXP_ODBC wxDbColFor
{
public:
- wxString s_Field; // Formated String for Output
- wxString s_Format[7]; // Formated Objects - TIMESTAMP has the biggest (7)
- wxString s_Menge[7]; // Formated Objects - amount of things that can be formatted
- int i_Menge[7]; // Formated Objects - TT MM YYYY HH MM SS m
- int i_Nation; // 0 = timestamp , 1=EU, 2=UK, 3=International, 4=US
- int i_dbDataType; // conversion of the 'sqlDataType' to the generic data type used by these classes
+ wxString s_Field; // Formated String for Output
+ wxString s_Format[7]; // Formated Objects - TIMESTAMP has the biggest (7)
+ wxString s_Amount[7]; // Formated Objects - amount of things that can be formatted
+ int i_Amount[7]; // Formated Objects - TT MM YYYY HH MM SS m
+ int i_Nation; // 0 = timestamp , 1=EU, 2=UK, 3=International, 4=US
+ int i_dbDataType; // conversion of the 'sqlDataType' to the generic data type used by these classes
SWORD i_sqlDataType;
- wxColFor();
- ~wxColFor();
-
+ wxDbColFor();
+ ~wxDbColFor();
+
+ void Initialize();
int Format(int Nation, int dbDataType, SWORD sqlDataType, short columnSize, short decimalDigits);
};
-class WXDLLEXPORT wxColInf
+class WXDLLIMPEXP_ODBC wxDbColInf
{
public:
- char catalog[128+1];
- char schema[128+1];
- char tableName[DB_MAX_TABLE_NAME_LEN+1];
- char colName[DB_MAX_COLUMN_NAME_LEN+1];
+ wxChar catalog[128+1];
+ wxChar schema[128+1];
+ wxChar tableName[DB_MAX_TABLE_NAME_LEN+1];
+ wxChar colName[DB_MAX_COLUMN_NAME_LEN+1];
SWORD sqlDataType;
- char typeName[128+1];
+ wxChar typeName[128+1];
SWORD columnSize;
SWORD bufferLength;
short decimalDigits;
short numPrecRadix;
short nullable;
- char remarks[254+1];
+ wxChar remarks[254+1];
int dbDataType; // conversion of the 'sqlDataType' to the generic data type used by these classes
// mj10777.19991224 : new
int PkCol; // Primary key column 0=No; 1= First Key, 2 = Second Key etc.
- char PkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Tables that use this PKey as a FKey
+ wxChar PkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Tables that use this PKey as a FKey
int FkCol; // Foreign key column 0=No; 1= First Key, 2 = Second Key etc.
- char FkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Foreign key table name
- wxColFor *pColFor; // How should this columns be formatted
+ wxChar FkTableName[DB_MAX_TABLE_NAME_LEN+1]; // Foreign key table name
+ wxDbColFor *pColFor; // How should this columns be formatted
+
+ wxDbColInf();
+ ~wxDbColInf();
+
+ bool Initialize();
};
-class WXDLLEXPORT wxTableInf // Description of a Table
+class WXDLLIMPEXP_ODBC wxDbTableInf // Description of a Table
{
public:
- char tableName[DB_MAX_TABLE_NAME_LEN+1];
- char tableType[254+1]; // "TABLE" or "SYSTEM TABLE" etc.
- char tableRemarks[254+1];
- int numCols; // How many Columns does this Table have: GetColumnCount(..);
- wxColInf *pColInf; // pColInf = NULL ; User can later call GetColumns(..);
+ wxChar tableName[DB_MAX_TABLE_NAME_LEN+1];
+ wxChar tableType[254+1]; // "TABLE" or "SYSTEM TABLE" etc.
+ wxChar tableRemarks[254+1];
+ UWORD numCols; // How many Columns does this Table have: GetColumnCount(..);
+ wxDbColInf *pColInf; // pColInf = NULL ; User can later call GetColumns(..);
+
+ wxDbTableInf();
+ ~wxDbTableInf();
+
+ bool Initialize();
};
-class WXDLLEXPORT wxDbInf // Description of a Database
+class WXDLLIMPEXP_ODBC wxDbInf // Description of a Database
{
public:
- char catalog[128+1];
- char schema[128+1];
- int numTables; // How many tables does this database have
- wxTableInf *pTableInf; // pTableInf = new wxTableInf[numTables];
+ wxChar catalog[128+1];
+ wxChar schema[128+1];
+ int numTables; // How many tables does this database have
+ wxDbTableInf *pTableInf; // pTableInf = new wxDbTableInf[numTables];
+
+ wxDbInf();
+ ~wxDbInf();
+
+ bool Initialize();
};
-enum sqlLog
+enum wxDbSqlLogState
{
sqlLogOFF,
sqlLogON
};
-
// These are the databases currently tested and working with these classes
-// See the comments in wxDB::Dbms() for exceptions/issues with
+// See the comments in wxDb::Dbms() for exceptions/issues with
// each of these database engines
-enum dbms
+enum wxDBMS
{
dbmsUNIDENTIFIED,
dbmsORACLE,
dbmsPOSTGRES,
dbmsACCESS,
dbmsDBASE,
- dbmsINFORMIX
+ dbmsINFORMIX,
+ dbmsVIRTUOSO,
+ dbmsDB2,
+ dbmsINTERBASE,
+ dbmsPERVASIVE_SQL,
+ dbmsXBASE_SEQUITER
};
-typedef enum dbms DBMS;
-
-
-// The wxDB::errorList is copied to this variable when the wxDB object
+// The wxDb::errorList is copied to this variable when the wxDb object
// is closed. This way, the error list is still available after the
-// database object is closed. This is necessary if the database
+// database object is closed. This is necessary if the database
// connection fails so the calling application can show the operator
-// why the connection failed. Note: as each wxDB object is closed, it
-// will overwrite the errors of the previously destroyed wxDB object in
+// why the connection failed. Note: as each wxDb object is closed, it
+// will overwrite the errors of the previously destroyed wxDb object in
// this variable.
-extern char DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
-
-// Backward compability for Remstar classes. This
-// will eventually go away, so the wxColXxxx classes
-// should be used
-typedef wxColInf CcolInf;
+WXDLLIMPEXP_DATA_BASE(extern wxChar)
+ DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
-class WXDLLEXPORT wxDB
+class WXDLLIMPEXP_ODBC wxDb
{
private:
-
- // Private data
bool dbIsOpen;
- char *dsn; // Data source name
- char *uid; // User ID
- char *authStr; // Authorization string (password)
+ bool dbIsCached; // Was connection created by caching functions
+ wxString dsn; // Data source name
+ wxString uid; // User ID
+ wxString authStr; // Authorization string (password)
FILE *fpSqlLog; // Sql Log file pointer
- enum sqlLog sqlLogState; // On or Off
+ wxDbSqlLogState sqlLogState; // On or Off
bool fwdOnlyCursors;
+ wxDBMS dbmsType; // Type of datasource - i.e. Oracle, dBase, SQLServer, etc
// Private member functions
- bool getDbInfo(void);
- bool getDataTypeInfo(SWORD fSqlType, SqlTypeInfo &structSQLTypeInfo);
+ bool getDbInfo(bool failOnDataTypeUnsupported = TRUE);
+ bool getDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo);
bool setConnectionOptions(void);
- void logError(const char *errMsg, const char *SQLState);
+ void logError(const wxString &errMsg, const wxString &SQLState);
+ const wxChar *convertUserID(const wxChar *userID, wxString &UserID);
+ void initialize();
+
+#if !wxODBC_BACKWARD_COMPATABILITY
+ // ODBC handles
+ HENV henv; // ODBC Environment handle
+ HDBC hdbc; // ODBC DB Connection handle
+ HSTMT hstmt; // ODBC Statement handle
+
+ //Error reporting mode
+ bool silent;
+
+ // Number of Ctable objects connected to this db object. FOR INTERNAL USE ONLY!!!
+ unsigned int nTables;
+
+ // Information about logical data types VARCHAR, INTEGER, FLOAT and DATE.
+ //
+ // This information is obtained from the ODBC driver by use of the
+ // SQLGetTypeInfo() function. The key piece of information is the
+ // type name the data source uses for each logical data type.
+ // e.g. VARCHAR; Oracle calls it VARCHAR2.
+ wxDbSqlTypeInfo typeInfVarchar;
+ wxDbSqlTypeInfo typeInfInteger;
+ wxDbSqlTypeInfo typeInfFloat;
+ wxDbSqlTypeInfo typeInfDate;
+ wxDbSqlTypeInfo typeInfBlob;
+#endif
public:
+
+ void setCached(bool cached) { dbIsCached = cached; }; // This function must only be called by wxDbGetConnection() and wxDbCloseConnections!!!
+ bool IsCached() { return dbIsCached; };
+
+ bool GetDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo)
+ { return getDataTypeInfo(fSqlType, structSQLTypeInfo); }
+
+#if wxODBC_BACKWARD_COMPATABILITY
+ // ODBC handles
+ HENV henv; // ODBC Environment handle
+ HDBC hdbc; // ODBC DB Connection handle
+ HSTMT hstmt; // ODBC Statement handle
+
+ //Error reporting mode
+ bool silent;
+
+ // Number of Ctable objects connected to this db object. FOR INTERNAL USE ONLY!!!
+ unsigned int nTables;
+#endif
+
// The following structure contains database information gathered from the
// datasource when the datasource is first opened.
struct
{
- char dbmsName[40]; // Name of the dbms product
- char dbmsVer[64]; // Version # of the dbms product
- char driverName[40]; // Driver name
- char odbcVer[60]; // ODBC version of the driver
- char drvMgrOdbcVer[60]; // ODBC version of the driver manager
- char driverVer[60]; // Driver version
- char serverName[80]; // Server Name, typically a connect string
- char databaseName[128]; // Database filename
- char outerJoins[2]; // Indicates whether the data source supports outer joins
- char procedureSupport[2]; // Indicates whether the data source supports stored procedures
+ wxChar dbmsName[40]; // Name of the dbms product
+ wxChar dbmsVer[64]; // Version # of the dbms product
+ wxChar driverName[40]; // Driver name
+ wxChar odbcVer[60]; // ODBC version of the driver
+ wxChar drvMgrOdbcVer[60]; // ODBC version of the driver manager
+ wxChar driverVer[60]; // Driver version
+ wxChar serverName[80]; // Server Name, typically a connect string
+ wxChar databaseName[128]; // Database filename
+ wxChar outerJoins[2]; // Indicates whether the data source supports outer joins
+ wxChar procedureSupport[2]; // Indicates whether the data source supports stored procedures
+ wxChar accessibleTables[2]; // Indicates whether the data source only reports accessible tables in SQLTables.
UWORD maxConnections; // Maximum # of connections the data source supports
UWORD maxStmts; // Maximum # of HSTMTs per HDBC
UWORD apiConfLvl; // ODBC API conformance level
UWORD cursorCommitBehavior; // Indicates how cursors are affected by a db commit
UWORD cursorRollbackBehavior; // Indicates how cursors are affected by a db rollback
UWORD supportNotNullClause; // Indicates if data source supports NOT NULL clause
- char supportIEF[2]; // Integrity Enhancement Facility (Referential Integrity)
+ wxChar supportIEF[2]; // Integrity Enhancement Facility (Referential Integrity)
UDWORD txnIsolation; // Default transaction isolation level supported by the driver
UDWORD txnIsolationOptions; // Transaction isolation level options available
UDWORD fetchDirections; // Fetch directions supported
UDWORD loginTimeout; // Number seconds to wait for a login request
} dbInf;
- // ODBC handles
- HENV henv; // ODBC Environment handle
- HDBC hdbc; // ODBC DB Connection handle
- HSTMT hstmt; // ODBC Statement handle
-
// ODBC Error Inf.
- char sqlState[20];
- SDWORD nativeError;
- char errorMsg[SQL_MAX_MESSAGE_LENGTH];
SWORD cbErrorMsg;
- char errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
int DB_STATUS;
+ wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN];
+ wxChar errorMsg[SQL_MAX_MESSAGE_LENGTH];
+ SDWORD nativeError;
+ wxChar sqlState[20];
- //Error reporting mode
- bool silent;
-
- // Number of Ctable objects connected to this db object
- unsigned int nTables;
-
- // Inf. about logical data types VARCHAR, INTEGER, FLOAT and DATE.
- // This inf. is obtained from the ODBC driver by use of the
- // SQLGetTypeInfo() function. The key piece of inf. is the
+#if wxODBC_BACKWARD_COMPATABILITY
+ // Information about logical data types VARCHAR, INTEGER, FLOAT and DATE.
+ //
+ // This information is obtained from the ODBC driver by use of the
+ // SQLGetTypeInfo() function. The key piece of information is the
// type name the data source uses for each logical data type.
// e.g. VARCHAR; Oracle calls it VARCHAR2.
- SqlTypeInfo typeInfVarchar, typeInfInteger, typeInfFloat, typeInfDate;
-
+ wxDbSqlTypeInfo typeInfVarchar;
+ wxDbSqlTypeInfo typeInfInteger;
+ wxDbSqlTypeInfo typeInfFloat;
+ wxDbSqlTypeInfo typeInfDate;
+ wxDbSqlTypeInfo typeInfBlob;
+#endif
+
// Public member functions
- wxDB(HENV &aHenv, bool FwdOnlyCursors=(bool)TRUE);
- bool Open(char *Dsn, char *Uid, char *AuthStr); // Data Source Name, User ID, Password
+ wxDb(const HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
+ ~wxDb();
+
+ // Data Source Name, User ID, Password and whether open should fail on data type not supported
+ bool Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr, bool failOnDataTypeUnsupported=TRUE);
+ bool Open(wxDbConnectInf *dbConnectInf);
+ bool Open(wxDb *copyDb); // pointer to a wxDb whose connection info should be copied rather than re-queried
void Close(void);
bool CommitTrans(void);
bool RollbackTrans(void);
bool DispAllErrors(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
bool GetNextError(HENV aHenv, HDBC aHdbc = SQL_NULL_HDBC, HSTMT aHstmt = SQL_NULL_HSTMT);
void DispNextError(void);
- bool CreateView(const char *viewName, const char *colList, const char *pSqlStmt, bool attemptDrop=TRUE);
- bool DropView(const char *viewName);
- bool ExecSql(const char *pSqlStmt);
+ bool CreateView(const wxString &viewName, const wxString &colList, const wxString &pSqlStmt, bool attemptDrop=TRUE);
+ bool DropView(const wxString &viewName);
+ bool ExecSql(const wxString &pSqlStmt);
bool GetNext(void);
bool GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SDWORD FAR *cbReturned);
- bool Grant(int privileges, const char *tableName, const char *userList = "PUBLIC");
- int TranslateSqlState(const char *SQLState);
- wxDbInf *GetCatalog(char *userID);
- bool Catalog(const char *userID=NULL, const char *fileName = SQL_CATALOG_FILENAME);
- int GetKeyFields(char *tableName, wxColInf* colInf,int nocols);
- wxColInf *GetColumns(char *tableName[], const char *userID=NULL);
- wxColInf *GetColumns(char *tableName, int *numCols, const char *userID=NULL);
- int GetColumnCount(char *tableName, const char *userID=NULL);
- char *GetDatabaseName(void) {return dbInf.dbmsName;}
- char *GetDataSource(void) {return dsn;}
- char *GetUsername(void) {return uid;}
- char *GetPassword(void) {return authStr;}
- bool IsOpen(void) {return dbIsOpen;}
- HENV GetHENV(void) {return henv;}
- HDBC GetHDBC(void) {return hdbc;}
- HSTMT GetHSTMT(void) {return hstmt;}
- bool TableExists(const char *tableName, const char *userID=NULL, const char *path=NULL); // Table name can refer to a table, view, alias or synonym
- void LogError(const char *errMsg, const char *SQLState = 0) {logError(errMsg, SQLState);}
- bool SqlLog(enum sqlLog state, const char *filename = SQL_LOG_FILENAME, bool append = FALSE);
- bool WriteSqlLog(const char *logMsg);
- DBMS Dbms(void);
- bool FwdOnlyCursors(void) {return fwdOnlyCursors;}
-}; // wxDB
+ bool Grant(int privileges, const wxString &tableName, const wxString &userList = wxT("PUBLIC"));
+ int TranslateSqlState(const wxString &SQLState);
+ wxDbInf *GetCatalog(const wxChar *userID=NULL);
+ bool Catalog(const wxChar *userID=NULL, const wxString &fileName=SQL_CATALOG_FILENAME);
+ int GetKeyFields(const wxString &tableName, wxDbColInf* colInf, UWORD noCols);
+
+ wxDbColInf *GetColumns(wxChar *tableName[], const wxChar *userID=NULL);
+ wxDbColInf *GetColumns(const wxString &tableName, UWORD *numCols, const wxChar *userID=NULL);
+
+ int GetColumnCount(const wxString &tableName, const wxChar *userID=NULL);
+ const wxChar *GetDatabaseName(void) {return dbInf.dbmsName;}
+ const wxString &GetDataSource(void) {return dsn;}
+ const wxString &GetDatasourceName(void){return dsn;}
+ const wxString &GetUsername(void) {return uid;}
+ const wxString &GetPassword(void) {return authStr;}
+ bool IsOpen(void) {return dbIsOpen;}
+ HENV GetHENV(void) {return henv;}
+ HDBC GetHDBC(void) {return hdbc;}
+ HSTMT GetHSTMT(void) {return hstmt;}
+ int GetTableCount() {return nTables;} // number of tables using this connection
+ wxDbSqlTypeInfo GetTypeInfVarchar() {return typeInfVarchar;}
+ wxDbSqlTypeInfo GetTypeInfInteger() {return typeInfInteger;}
+ wxDbSqlTypeInfo GetTypeInfFloat() {return typeInfFloat;}
+ wxDbSqlTypeInfo GetTypeInfDate() {return typeInfDate;}
+ wxDbSqlTypeInfo GetTypeInfBlob() {return typeInfBlob;}
+
+ // tableName can refer to a table, view, alias or synonym
+ bool TableExists(const wxString &tableName, const wxChar *userID=NULL,
+ const wxString &tablePath=wxEmptyString);
+ bool TablePrivileges(const wxString &tableName, const wxString &priv,
+ const wxChar *userID=NULL, const wxChar *schema=NULL,
+ const wxString &path=wxEmptyString);
+
+ // These two functions return the table name or column name in a form ready
+ // for use in SQL statements. For example, if the datasource allows spaces
+ // in the table name or column name, the returned string will have the
+ // correct enclosing marks around the name to allow it to be properly
+ // included in a SQL statement
+ const wxString SQLTableName(const wxChar *tableName);
+ const wxString SQLColumnName(const wxChar *colName);
+
+ void LogError(const wxString &errMsg, const wxString &SQLState = wxEmptyString)
+ { logError(errMsg, SQLState); }
+ void SetDebugErrorMessages(bool state) { silent = !state; }
+ bool SetSqlLogging(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME,
+ bool append = FALSE);
+ bool WriteSqlLog(const wxString &logMsg);
+
+ wxDBMS Dbms(void);
+ bool ModifyColumn(const wxString &tableName, const wxString &columnName,
+ int dataType, ULONG columnLength=0,
+ const wxString &optionalParam=wxEmptyString);
+
+ bool FwdOnlyCursors(void) {return fwdOnlyCursors;}
+
+ // These two functions are provided strictly for use by wxDbTable.
+ // DO NOT USE THESE FUNCTIONS, OR MEMORY LEAKS MAY OCCUR
+ void incrementTableCount() { nTables++; return; }
+ void decrementTableCount() { nTables--; return; }
+
+}; // wxDb
+
// This structure forms a node in a linked list. The linked list of "DbList" objects
// keeps track of allocated database connections. This allows the application to
// open more than one database connection through ODBC for multiple transaction support
// or for multiple database support.
-
-struct DbList
+struct wxDbList
{
- DbList *PtrPrev; // Pointer to previous item in the list
- char Dsn[SQL_MAX_DSN_LENGTH+1]; // Data Source Name
- wxDB *PtrDb; // Pointer to the wxDB object
- bool Free; // Is item free or in use?
- DbList *PtrNext; // Pointer to next item in the list
+ wxDbList *PtrPrev; // Pointer to previous item in the list
+ wxString Dsn; // Data Source Name
+ wxString Uid; // User ID
+ wxString AuthStr; // Authorization string (password)
+ wxDb *PtrDb; // Pointer to the wxDb object
+ bool Free; // Is item free or in use?
+ wxDbList *PtrNext; // Pointer to next item in the list
};
#ifdef __WXDEBUG__
#include "wx/object.h"
-class CstructTablesInUse : public wxObject
+class wxTablesInUse : public wxObject
{
public:
- const char *tableName;
+ const wxChar *tableName;
ULONG tableID;
- class wxDB *pDb;
-}; // CstructTablesInUse
+ class wxDb *pDb;
+}; // wxTablesInUse
#endif
+
// The following routines allow a user to get new database connections, free them
// for other code segments to use, or close all of them when the application has
// completed.
+wxDb WXDLLIMPEXP_ODBC *wxDbGetConnection(wxDbConnectInf *pDbConfig, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
+bool WXDLLIMPEXP_ODBC wxDbFreeConnection(wxDb *pDb);
+void WXDLLIMPEXP_ODBC wxDbCloseConnections(void);
+int WXDLLIMPEXP_ODBC wxDbConnectionsInUse(void);
-wxDB WXDLLEXPORT *GetDbConnection(DbStuff *pDbStuff, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
-bool WXDLLEXPORT FreeDbConnection(wxDB *pDb);
-void WXDLLEXPORT CloseDbConnections(void);
-int WXDLLEXPORT NumberDbConnectionsInUse(void);
+// Writes a message to the wxLog window (stdout usually) when an internal error
+// situation occurs. This function only works in DEBUG builds
+const wxChar WXDLLIMPEXP_ODBC *
+wxDbLogExtendedErrorMsg(const wxChar *userText,
+ wxDb *pDb,
+ const wxChar *ErrFile,
+ int ErrLine);
-// This function sets the sql log state for all open wxDB objects
-bool SqlLog(enum sqlLog state, const char *filename = SQL_LOG_FILENAME);
+// This function sets the sql log state for all open wxDb objects
+bool WXDLLIMPEXP_ODBC
+wxDbSqlLog(wxDbSqlLogState state, const wxString &filename = SQL_LOG_FILENAME);
+
+
+#if 0
+// MSW/VC6 ONLY!!! Experimental
+int WXDLLEXPORT wxDbCreateDataSource(const wxString &driverName, const wxString &dsn, const wxString &description=wxEmptyString,
+ bool sysDSN=FALSE, const wxString &defDir=wxEmptyString, wxWindow *parent=NULL);
+#endif
// This routine allows you to query a driver manager
// for a list of available datasources. Call this routine
// the first time using SQL_FETCH_FIRST. Continue to call it
// using SQL_FETCH_NEXT until you've exhausted the list.
-bool WXDLLEXPORT GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
- UWORD direction = SQL_FETCH_NEXT);
-
+bool WXDLLIMPEXP_ODBC
+wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMax, wxChar *DsDesc,
+ SWORD DsDescMax, UWORD direction = SQL_FETCH_NEXT);
+
+
+// Change this to 0 to remove use of all deprecated functions
+#if wxODBC_BACKWARD_COMPATABILITY
+//#################################################################################
+//############### DEPRECATED functions for backward compatability #################
+//#################################################################################
+
+// Backward compability structures/classes. This will eventually go away
+const int DB_PATH_MAX = wxDB_PATH_MAX;
+
+typedef wxDb wxDB;
+typedef wxDbTableInf wxTableInf;
+typedef wxDbColInf wxColInf;
+typedef wxDbColInf CcolInf;
+typedef wxDbColFor wxColFor;
+typedef wxDbSqlTypeInfo SqlTypeInfo;
+typedef wxDbSqlTypeInfo wxSqlTypeInfo;
+typedef enum wxDbSqlLogState sqlLog;
+typedef enum wxDbSqlLogState wxSqlLogState;
+typedef enum wxDBMS dbms;
+typedef enum wxDBMS DBMS;
+typedef wxODBC_ERRORS ODBC_ERRORS;
+typedef wxDbConnectInf DbStuff;
+typedef wxDbList DbList;
+#ifdef __WXDEBUG__
+typedef wxTablesInUse CstructTablesInUse;
#endif
+
+// Deprecated function names that are replaced by the function names listed above
+wxDB WXDLLIMPEXP_ODBC
+*GetDbConnection(DbStuff *pDbStuff, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS);
+bool WXDLLIMPEXP_ODBC FreeDbConnection(wxDB *pDb);
+void WXDLLIMPEXP_ODBC CloseDbConnections(void);
+int WXDLLIMPEXP_ODBC NumberDbConnectionsInUse(void);
+
+bool SqlLog(sqlLog state, const wxChar *filename = SQL_LOG_FILENAME);
+
+bool WXDLLIMPEXP_ODBC
+GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax,
+ UWORD direction = SQL_FETCH_NEXT);
+
+#endif // Deprecated structures/classes/functions
+
+#endif // _WX_DB_H_
+
projects / wxWidgets.git / blobdiff