database.h

Go to the documentation of this file.

#ifndef _WX_DATABASE_H_
#define _WX_DATABASE_H_

#include "wx/database/wxprec.h"
#include "wx/config.h"

WX_DECLARE_HASH_SET( wxDatabaseResultSet*, wxPointerHash, wxPointerEqual, wxDatabaseResultSetHashSet );
WX_DECLARE_HASH_SET( wxPreparedStatement*, wxPointerHash, wxPointerEqual, wxDatabaseStatementHashSet );

class WXDLLIMPEXP_DATABASE wxDatabase : public wxDatabaseErrorReporter, public wxDatabaseStringConverter
{
public:
  wxDatabase();
  
  virtual ~wxDatabase();
  
  // Open database
  virtual bool Open(const wxString& strDatabase) = 0;
  
  /***
   * Causes the database specified by db to become the default (current) database on the connection
   * If unimplemented just return false (Equivalent to unsuccessful operation)
   */
  virtual bool ChangeDatabase(const wxString& database) { return false; }
  
  virtual bool Close() = 0;
 
  virtual bool IsOpen() = 0;

  // transaction support
  virtual void BeginTransaction() = 0;
  virtual void Commit() = 0;
  virtual void RollBack() = 0;
 
  // query database
  virtual int RunQuery(const wxString& strQuery);
  virtual int RunQuery(const wxString& strQuery, bool bParseQueries) = 0;
  virtual wxDatabaseResultSet* RunQueryWithResults(const wxString& strQuery) = 0;
  
  virtual bool CloseResultSet(wxDatabaseResultSet* pResultSet);

  // wxPreparedStatement support
  virtual wxPreparedStatement* PrepareStatement(const wxString& strQuery) = 0;
  virtual bool CloseStatement(wxPreparedStatement* pStatement);

  // function names more consistent with JDBC and wxSQLite3
  // these just provide wrappers for existing functions
  int ExecuteUpdate(const wxString& strQuery) { return RunQuery(strQuery); }
  wxDatabaseResultSet* ExecuteQuery(const wxString& strQuery) { return RunQueryWithResults(strQuery); }

  // Database schema API contributed by M. Szeftel (author of wxActiveRecordGenerator)
  virtual bool TableExists(const wxString& table) = 0;
  virtual bool ViewExists(const wxString& view) = 0;
  virtual wxArrayString GetTables() = 0;
  virtual wxArrayString GetViews() = 0;
  virtual wxArrayString GetColumns(const wxString& table) = 0;
  virtual wxArrayString GetPKColumns(const wxString& table) = 0;

  // Database single result retrieval API contributed by Guru Kathiresan

  virtual int GetSingleResultInt(const wxString& strSQL, int nField, bool bRequireUniqueResult = true);
  virtual int GetSingleResultInt(const wxString& strSQL, const wxString& strField, bool bRequireUniqueResult = true);
  
  virtual wxString GetSingleResultString(const wxString& strSQL, int nField, bool bRequireUniqueResult = true);
  virtual wxString GetSingleResultString(const wxString& strSQL, const wxString& strField, bool bRequireUniqueResult = true);
  
  virtual long GetSingleResultLong(const wxString& strSQL, int nField, bool bRequireUniqueResult = true);
  virtual long GetSingleResultLong(const wxString& strSQL, const wxString& strField, bool bRequireUniqueResult = true);
  
  virtual bool GetSingleResultBool(const wxString& strSQL, int nField, bool bRequireUniqueResult = true);
  virtual bool GetSingleResultBool(const wxString& strSQL, const wxString& strField, bool bRequireUniqueResult = true);
  
  virtual wxDateTime GetSingleResultDate(const wxString& strSQL, int nField, bool bRequireUniqueResult = true);
  virtual wxDateTime GetSingleResultDate(const wxString& strSQL, const wxString& strField, bool bRequireUniqueResult = true);
  
  virtual void* GetSingleResultBlob(const wxString& strSQL, int nField, wxMemoryBuffer& Buffer, bool bRequireUniqueResult = true);
  virtual void* GetSingleResultBlob(const wxString& strSQL, const wxString& strField, wxMemoryBuffer& Buffer, bool bRequireUniqueResult = true);
  
  virtual double GetSingleResultDouble(const wxString& strSQL, int nField, bool bRequireUniqueResult = true);
  virtual double GetSingleResultDouble(const wxString& strSQL, const wxString& strField, bool bRequireUniqueResult = true);

  virtual wxArrayInt GetResultsArrayInt(const wxString& strSQL, int nField);
  virtual wxArrayInt GetResultsArrayInt(const wxString& strSQL, const wxString& Field);
  
  virtual wxArrayString GetResultsArrayString(const wxString& strSQL, int nField);
  virtual wxArrayString GetResultsArrayString(const wxString& strSQL, const wxString& Field);
  
  virtual wxArrayLong GetResultsArrayLong(const wxString& strSQL, int nField);
  virtual wxArrayLong GetResultsArrayLong(const wxString& strSQL, const wxString& Field);
  
  virtual wxArrayDouble GetResultsArrayDouble(const wxString& strSQL, int nField);
  virtual wxArrayDouble GetResultsArrayDouble(const wxString& strSQL, const wxString& Field); 
  
  void CloseResultSets();
  void CloseStatements();

  //AML start
  const wxString& GetTypeName() { return m_typeName; }
  bool IsViaODBC() { return m_isViaODBC; }
  const wxString& GetLibraryPath() { return m_libraryPath; }
  static wxDatabase* GetDatabase(wxConfigBase& config, wxString* err = NULL, const wxString& path = "/");
private:
#if wxUSE_DATABASE_SQLITE
  static wxDatabase* GetSqliteDatabase(wxConfigBase& config, wxString* err = NULL);
#endif
#if wxUSE_DATABASE_POSTGRESQL
  static wxDatabase* GetPostgresDatabase(wxConfigBase& config, wxString* err = NULL);
#endif
#if wxUSE_DATABASE_MYSQL
  static wxDatabase* GetMysqlDatabase(wxConfigBase& config, wxString* err = NULL);
#endif
#if wxUSE_DATABASE_ODBC
  static wxDatabase* GetOdbcDatabase(wxConfigBase& config, wxString* err = NULL);
#endif
#if wxUSE_DATABASE_TDS
  static wxDatabase* GetTdsDatabase(wxConfigBase& config, wxString* err = NULL);
#endif
  //AML end
protected:
  void LogResultSetForCleanup(wxDatabaseResultSet* pResultSet) { m_ResultSets.insert(pResultSet); }
  void LogStatementForCleanup(wxPreparedStatement* pStatement) { m_Statements.insert(pStatement); }
  
private:
  int GetSingleResultInt(const wxString& strSQL, const wxVariant* field, bool bRequireUniqueResult = true);
  wxString GetSingleResultString(const wxString& strSQL, const wxVariant* field, bool bRequireUniqueResult = true);
  long GetSingleResultLong(const wxString& strSQL, const wxVariant* field, bool bRequireUniqueResult = true);
  bool GetSingleResultBool(const wxString& strSQL, const wxVariant* field, bool bRequireUniqueResult = true);
  wxDateTime GetSingleResultDate(const wxString& strSQL, const wxVariant* field, bool bRequireUniqueResult = true);
  void* GetSingleResultBlob(const wxString& strSQL, const wxVariant* field, wxMemoryBuffer& Buffer, bool bRequireUniqueResult = true);
  double GetSingleResultDouble(const wxString& strSQL, const wxVariant* field, bool bRequireUniqueResult = true);
  wxArrayInt GetResultsArrayInt(const wxString& strSQL, const wxVariant* field);
  wxArrayString GetResultsArrayString(const wxString& strSQL, const wxVariant* field);
  wxArrayLong GetResultsArrayLong(const wxString& strSQL, const wxVariant* field);
#if wxCHECK_VERSION(2, 7, 0)
  wxArrayDouble GetResultsArrayDouble(const wxString& strSQL, const wxVariant* field);
#endif

  wxDatabaseResultSetHashSet m_ResultSets;
  wxDatabaseStatementHashSet m_Statements;
  //AML start
  wxString m_typeName;
  bool m_isViaODBC;
  wxString m_libraryPath;
  //AML end
};

#endif//_WX_DATABASE_H_