X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4fdae9972d39fbe62adaa1c1d721ba1762cd8950..d494613ac1e0a1a9cdab21b757b2bc9367802654:/include/wx/db.h diff --git a/include/wx/db.h b/include/wx/db.h index 6df0e249f4..0c9b196a2b 100644 --- a/include/wx/db.h +++ b/include/wx/db.h @@ -1,5 +1,5 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: db.h +// 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. @@ -19,77 +19,85 @@ // Created: 9.96 // RCS-ID: $Id$ // Copyright: (c) 1996 Remstar International, Inc. -// Licence: wxWindows licence, plus: -// Notice: This class library and its intellectual design are free of charge for use, -// modification, enhancement, debugging under the following conditions: -// 1) These classes may only be used as part of the implementation of a -// wxWindows-based application -// 2) All enhancements and bug fixes are to be submitted back to the wxWindows -// user groups free of all charges for use with the wxWindows library. -// 3) These classes may not be distributed as part of any other class library, -// DLL, text (written or electronic), other than a complete distribution of -// the wxWindows GUI development toolkit. -// +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// -/* -// SYNOPSIS START -// SYNOPSIS STOP -*/ - -#ifndef DB_DOT_H -#define DB_DOT_H +#ifndef _WX_DB_H_ +#define _WX_DB_H_ -// BJO 20000503: introduce new GetColumns members which are more database independant and +// BJO 20000503: introduce new GetColumns members which are more database independent and // return columns in the order they were created #define OLD_GETCOLUMNS 1 #define EXPERIMENTAL_WXDB_FUNCTIONS 1 -// Use this line for wxWindows v1.x -//#include "wx_ver.h" -// Use this line for wxWindows v2.x -#include "wx/version.h" - -#if wxMAJOR_VERSION == 2 - #ifdef __GNUG__ - #pragma interface "db.h" - #endif -#endif - -#include "wx/setup.h" - -#if wxMAJOR_VERSION == 2 - extern "C" { -#ifdef __VISUALC__ -// 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 "wx/defs.h" +#include "wx/string.h" + +#if defined(__VISUALC__) + // we need to include standard Windows headers but we can't include + // directly when using MFC because it includes it itself in a + // different manner + #if wxUSE_MFC + #include + #else // !wxUSE_MFC + #include "wx/msw/wrapwin.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\wxWidgets\src\makevc.env to the WINLIBS= line + // #include "sql.h" #include "sqlext.h" + //#if wxUSE_UNICODE + // #include + //#endif #include "odbcinst.h" #else - #include "wx/isql.h" - #include "wx/isqlext.h" -#endif - } -#else // version == 1 + #if defined(__WINDOWS__) && ( defined(HAVE_W32API_H) || defined(__BORLANDC__) || defined (__DMC__)) + #include "wx/msw/wrapwin.h" + #endif extern "C" { -#ifdef __VISUALC__ -// 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 - #include "sql.h" - #include "sqlext.h" - #include "odbcinst.h" + #if defined(wxUSE_BUILTIN_IODBC) && wxUSE_BUILTIN_IODBC + // Use the ones from the library + #include "wx/isql.h" + #include "wx/isqlext.h" + // Not available in v2.x of iODBC + #ifndef __WXMSW__ + #if wxUSE_UNICODE + typedef wxChar SQLTCHAR; + #else + typedef UCHAR SQLTCHAR; + #endif + #endif + #else // !wxUSE_BUILTIN_IODBC + // SQL headers define BOOL if it's not defined yet but BOOL is also + // defined in many other places on other systems (Motif, at least on + // OpenVMS; Cocoa and X11) so prevent the problem by defining it before + // including these headers + #define BOOL int + #include + #include + #undef BOOL + #endif // wxUSE_BUILTIN_IODBC/!wxUSE_BUILTIN_IODBC + } +#endif + +#if wxUSE_UNICODE +#define SQL_C_WXCHAR SQL_C_WCHAR #else - #include "iodbc.h" - #include "isqlext.h" +#define SQL_C_WXCHAR SQL_C_CHAR +#endif + +#ifdef __DIGITALMARS__ +#if wxUSE_UNICODE +typedef wxChar SQLTCHAR; +#else +typedef UCHAR SQLTCHAR; #endif - } #endif typedef float SFLOAT; @@ -103,24 +111,35 @@ typedef unsigned int UINT; enum enumDummy {enumDum1}; -#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) +#ifndef SQL_C_BOOLEAN + #define SQL_C_BOOLEAN(datatype) (sizeof(datatype) == 1 ? SQL_C_UTINYINT : (sizeof(datatype) == 2 ? SQL_C_USHORT : SQL_C_ULONG)) +#endif -#define SQL_C_ENUM (sizeof(enumDummy) == 2 ? SQL_C_USHORT : SQL_C_ULONG) +#ifndef SQL_C_ENUM + #define SQL_C_ENUM (sizeof(enumDummy) == 2 ? SQL_C_USHORT : SQL_C_ULONG) +#endif -#ifndef TRUE -#define TRUE 1 +// NOTE: If SQL_C_BLOB is defined, and it is not SQL_C_BINARY, iODBC 2.x +// may not function correctly. Likely best to use SQL_C_BINARY direct +#ifndef SQL_C_BLOB + #ifdef SQL_C_BINARY + #define SQL_C_BLOB SQL_C_BINARY + #endif #endif -#ifndef FALSE -#define FALSE 0 +#ifndef _WIN64 +#ifndef SQLLEN +#define SQLLEN SQLINTEGER +#endif +#ifndef SQLULEN +#define SQLULEN SQLUINTEGER +#endif #endif const int wxDB_PATH_MAX = 254; -extern wxChar const *SQL_LOG_FILENAME; -extern wxChar const *SQL_CATALOG_FILENAME; - +extern WXDLLIMPEXP_DATA_ODBC(wxChar const *) SQL_LOG_FILENAME; +extern WXDLLIMPEXP_DATA_ODBC(wxChar const *) SQL_CATALOG_FILENAME; // Database Globals const int DB_TYPE_NAME_LEN = 40; @@ -135,6 +154,8 @@ const int DB_DATA_TYPE_VARCHAR = 1; 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_DATA_TYPE_MEMO = 6; const int DB_SELECT_KEYFIELDS = 1; const int DB_SELECT_WHERE = 2; @@ -254,51 +275,122 @@ enum wxODBC_ERRORS DB_ERR_TIMEOUT_EXPIRED // SqlState = 'S1T00' }; +#ifndef MAXNAME + #define MAXNAME 31 +#endif -struct wxDbConnectInf +#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 + +#ifndef SQL_MAX_CONNECTSTR_LEN + // There does not seem to be a standard for this, so I am + // defaulting to the value that MS recommends + #define SQL_MAX_CONNECTSTR_LEN 1024 +#endif + + +class WXDLLIMPEXP_ODBC wxDbConnectInf { - HENV Henv; - wxString Dsn; // Data Source Name - wxString Uid; // User ID - wxString AuthStr; // Authorization string (password) + private: + bool freeHenvOnDestroy; + bool useConnectionStr; - wxString description; // Not sure what the max length is - wxString fileType; // 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) + wxChar ConnectionStr[SQL_MAX_CONNECTSTR_LEN+1]; // Connection string (password) - // Optionals needed for some databases like dBase - wxString defaultDir; // Directory that db file resides in -}; + wxString Description; // Not sure what the max length is + wxString FileType; // Not sure what the max length is -struct wxDbSqlTypeInfo + // 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(); + + 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 *GetConnectionStr() { return ConnectionStr; } + bool UseConnectionStr() { return useConnectionStr; } + + 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 SetConnectionStr(const wxString &connectStr); + + 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 { wxString TypeName; - int FsqlType; + SWORD FsqlType; long Precision; short CaseSensitive; -// short MinimumScale; short MaximumScale; }; -class WXDLLEXPORT wxDbColFor +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_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 + wxString s_Field; // Formatted String for Output + wxString s_Format[7]; // Formatted Objects - TIMESTAMP has the biggest (7) + wxString s_Amount[7]; // Formatted Objects - amount of things that can be formatted + int i_Amount[7]; // Formatted 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; wxDbColFor(); - ~wxDbColFor(); + ~wxDbColFor(){} - int Format(int Nation, int dbDataType, SWORD sqlDataType, short columnSize, short decimalDigits); + void Initialize(); + int Format(int Nation, int dbDataType, SWORD sqlDataType, short columnLength, short decimalDigits); }; -class WXDLLEXPORT wxDbColInf +class WXDLLIMPEXP_ODBC wxDbColInf { public: wxChar catalog[128+1]; @@ -307,8 +399,8 @@ public: wxChar colName[DB_MAX_COLUMN_NAME_LEN+1]; SWORD sqlDataType; wxChar typeName[128+1]; - SWORD columnSize; - SWORD bufferLength; + SWORD columnLength; + SWORD bufferSize; short decimalDigits; short numPrecRadix; short nullable; @@ -323,25 +415,28 @@ public: wxDbColInf(); ~wxDbColInf(); -}; - + bool Initialize(); +}; -class WXDLLEXPORT wxDbTableInf // Description of a Table +class WXDLLIMPEXP_ODBC wxDbTableInf // Description of a Table { public: wxChar tableName[DB_MAX_TABLE_NAME_LEN+1]; wxChar tableType[254+1]; // "TABLE" or "SYSTEM TABLE" etc. wxChar tableRemarks[254+1]; - int numCols; // How many Columns does this Table have: GetColumnCount(..); + 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: wxChar catalog[128+1]; @@ -351,6 +446,8 @@ public: wxDbInf(); ~wxDbInf(); + + bool Initialize(); }; @@ -377,7 +474,21 @@ enum wxDBMS dbmsINFORMIX, dbmsVIRTUOSO, dbmsDB2, - dbmsINTERBASE + dbmsINTERBASE, + dbmsPERVASIVE_SQL, + dbmsXBASE_SEQUITER, + dbmsFIREBIRD, + dbmsMAXDB, + dbmsFuture1, + dbmsFuture2, + dbmsFuture3, + dbmsFuture4, + dbmsFuture5, + dbmsFuture6, + dbmsFuture7, + dbmsFuture8, + dbmsFuture9, + dbmsFuture10 }; @@ -388,28 +499,36 @@ enum wxDBMS // 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 wxChar DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN]; +extern WXDLLIMPEXP_DATA_ODBC(wxChar) + DBerrorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN+1]; -class WXDLLEXPORT wxDb + +class WXDLLIMPEXP_ODBC wxDb { private: bool dbIsOpen; + bool dbIsCached; // Was connection created by caching functions + bool dbOpenedWithConnectionString; // Was the database connection opened with a connection string wxString dsn; // Data source name wxString uid; // User ID wxString authStr; // Authorization string (password) + wxString inConnectionStr; // Connection string used to connect to the database + wxString outConnectionStr;// Connection string returned by the database when a connection is successfully opened FILE *fpSqlLog; // Sql Log file pointer 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 getDbInfo(bool failOnDataTypeUnsupported=true); bool getDataTypeInfo(SWORD fSqlType, wxDbSqlTypeInfo &structSQLTypeInfo); bool setConnectionOptions(void); void logError(const wxString &errMsg, const wxString &SQLState); + void convertUserID(const wxChar *userID, wxString &UserID); + bool determineDataTypes(bool failOnDataTypeUnsupported); void initialize(); - const wxChar *convertUserID(const wxChar *userID, wxString &UserID); + bool open(bool failOnDataTypeUnsupported=true); #if !wxODBC_BACKWARD_COMPATABILITY // ODBC handles @@ -433,9 +552,18 @@ private: wxDbSqlTypeInfo typeInfInteger; wxDbSqlTypeInfo typeInfFloat; wxDbSqlTypeInfo typeInfDate; + wxDbSqlTypeInfo typeInfBlob; + wxDbSqlTypeInfo typeInfMemo; #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 @@ -489,9 +617,15 @@ public: // ODBC Error Inf. SWORD cbErrorMsg; int DB_STATUS; +#ifdef __VMS + // The DECC compiler chokes when in db.cpp the array is accessed outside + // its bounds. Maybe this change should also applied for other platforms. + wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN+1]; +#else wxChar errorList[DB_MAX_ERROR_HISTORY][DB_MAX_ERROR_MSG_LEN]; +#endif wxChar errorMsg[SQL_MAX_MESSAGE_LENGTH]; - SDWORD nativeError; + SQLINTEGER nativeError; wxChar sqlState[20]; #if wxODBC_BACKWARD_COMPATABILITY @@ -505,11 +639,19 @@ public: wxDbSqlTypeInfo typeInfInteger; wxDbSqlTypeInfo typeInfFloat; wxDbSqlTypeInfo typeInfDate; + wxDbSqlTypeInfo typeInfBlob; #endif // Public member functions - wxDb(HENV &aHenv, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS); - bool Open(const wxString &Dsn, const wxString &Uid, const wxString &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& inConnectStr, bool failOnDataTypeUnsupported=true); + ///This version of Open will open the odbc source selection dialog. Cast a wxWindow::GetHandle() to SQLHWND to use. + bool Open(const wxString& inConnectStr, SQLHWND parentWnd, bool failOnDataTypeUnsupported=true); + bool Open(const wxString &Dsn, const wxString &Uid, const wxString &AuthStr, bool failOnDataTypeUnsupported=true); + bool Open(wxDbConnectInf *dbConnectInf, bool failOnDataTypeUnsupported=true); bool Open(wxDb *copyDb); // pointer to a wxDb whose connection info should be copied rather than re-queried void Close(void); bool CommitTrans(void); @@ -517,49 +659,74 @@ public: 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 wxString &viewName, const wxString &colList, const wxString &pSqlStmt, bool attemptDrop=TRUE); + 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 ExecSql(const wxString &pSqlStmt, wxDbColInf** columns, short& numcols); bool GetNext(void); - bool GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SDWORD FAR *cbReturned); + bool GetData(UWORD colNo, SWORD cType, PTR pData, SDWORD maxLen, SQLLEN FAR *cbReturned); 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, int nocols); + int GetKeyFields(const wxString &tableName, wxDbColInf* colInf, UWORD noCols); wxDbColInf *GetColumns(wxChar *tableName[], const wxChar *userID=NULL); - wxDbColInf *GetColumns(const wxString &tableName, int *numCols, 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;} + 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;} - - bool TableExists(const wxString &tableName, const wxChar *userID=NULL, const wxString &tablePath=wxT("")); // tableName can refer to a table, view, alias or synonym - bool TablePrivileges(const wxString &tableName, const wxString &priv, const wxChar *userID=NULL, const wxChar *schema=NULL, const wxString &path=wxT("")); // tableName can refer to a table, view, alias or synonym - void LogError(const wxString &errMsg, const wxString &SQLState = wxT("")) { logError(errMsg, SQLState); } + const wxString &GetConnectionInStr(void) {return inConnectionStr;} + const wxString &GetConnectionOutStr(void) {return outConnectionStr;} + bool IsOpen(void) {return dbIsOpen;} + bool OpenedWithConnectionString(void) {return dbOpenedWithConnectionString;} + 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;} + wxDbSqlTypeInfo GetTypeInfMemo() {return typeInfMemo;} + + // 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 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=""); + const wxString &optionalParam=wxEmptyString); bool FwdOnlyCursors(void) {return fwdOnlyCursors;} + // return the string with all special SQL characters escaped + wxString EscapeSqlChars(const wxString& value); + // These two functions are provided strictly for use by wxDbTable. // DO NOT USE THESE FUNCTIONS, OR MEMORY LEAKS MAY OCCUR void incrementTableCount() { nTables++; return; } @@ -578,11 +745,13 @@ struct wxDbList wxString Dsn; // Data Source Name wxString Uid; // User ID wxString AuthStr; // Authorization string (password) + wxString ConnectionStr; // Connection string used instead of DSN 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 wxTablesInUse : public wxObject @@ -598,34 +767,45 @@ class wxTablesInUse : public wxObject // 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 WXDLLEXPORT *wxDbGetConnection(wxDbConnectInf *pDbConfig, bool FwdOnlyCursors=(bool)wxODBC_FWD_ONLY_CURSORS); -bool WXDLLEXPORT wxDbFreeConnection(wxDb *pDb); -void WXDLLEXPORT wxDbCloseConnections(void); -int WXDLLEXPORT wxDbConnectionsInUse(void); +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); + + +// 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 wxDbSqlLog(wxDbSqlLogState state, const wxChar *filename = SQL_LOG_FILENAME); +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=wxT(""), - bool sysDSN=FALSE, const wxString &defDir=wxT(""), wxWindow *parent=NULL); +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 wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMax, wxChar *DsDesc, - SWORD DsDescMax, UWORD direction = SQL_FETCH_NEXT); +bool WXDLLIMPEXP_ODBC +wxDbGetDataSource(HENV henv, wxChar *Dsn, SWORD DsnMaxLength, wxChar *DsDesc, + SWORD DsDescMaxLength, 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 ################# +//############### DEPRECATED functions for backward compatibility ################# //################################################################################# // Backward compability structures/classes. This will eventually go away @@ -650,15 +830,19 @@ typedef wxTablesInUse CstructTablesInUse; #endif // Deprecated function names that are replaced by the function names listed above -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); +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 SqlLog(sqlLog state, const char *filename = SQL_LOG_FILENAME); +bool WXDLLIMPEXP_ODBC +GetDataSource(HENV henv, char *Dsn, SWORD DsnMaxLength, char *DsDesc, SWORD DsDescMaxLength, + UWORD direction = SQL_FETCH_NEXT); -bool WXDLLEXPORT GetDataSource(HENV henv, char *Dsn, SWORD DsnMax, char *DsDesc, SWORD DsDescMax, - UWORD direction = SQL_FETCH_NEXT); #endif // Deprecated structures/classes/functions -#endif +#endif // _WX_DB_H_ +