dbi.h

Go to the documentation of this file.

// Name:        wx/dbi.h
// Purpose:     
// Author:      Joe Yates
// Created:     2004-11-17
// Copyright:   (c) Joe Yates
// License:     BSD license (see the file 'LICENSE.txt')

#ifndef __wx_dbi_h__
#define __wx_dbi_h__

#include <wx/wxprec.h>

#ifndef WX_PRECOMP
# include "wx/wx.h"
#endif

#if _MSC_VER > 1000
# ifdef _DEBUG
#   include "crtdbg.h"
#   define new                    new(_NORMAL_BLOCK, __FILE__, __LINE__)
# endif // def _DEBUG
#endif // _MSC_VER > 1000

#ifdef _MSC_VER
#pragma warning (disable : 4786) // identifier was truncated to '255' characters in the browser information
#endif // def _MSC_VER

#include <map>

#include <wx/variant.h>

#include <wx/exception.h>
#include <wx/dbi/types.h>
#include <wx/dbi/record.h>

namespace wx
{

namespace DBI
{

/*
To do:
- Named bind parameters
*/

#define DATABASE_HOST     wxT("Host")
#define DATABASE_NAME     wxT("Name")
#define DATABASE_LOGON    wxT("Logon")
#define DATABASE_PASSWORD wxT("Password")

class Statement;

class Database
  {
  // friends, classes, enums and types

  public:
    class ConnectionInfo : private std::map<wxString, wxString>
      {
      public:
        ConnectionInfo()
          {}
        ConnectionInfo(const ConnectionInfo& cni);
        ConnectionInfo& operator=(const ConnectionInfo& cni);

      public:
        void Set(const wxString& sName, const wxString& sValue);
    
        wxString  Get(const wxString& sName) const;
    
        bool IsSet(const wxString& sName) const;
      };

  // Constructors/destructors
  public:
    Database()
      {}
    
    virtual ~Database()
      {}

  // Operators

  // Methods
  public:
    // Connection

    virtual void Connect(const ConnectionInfo& cni)     = 0;

    virtual void Disconnect()                           = 0;

    virtual bool IsConnected()                          = 0;

    // Transactions
    virtual void Begin()
      {
      wxLogFatalError(wxT("Database::Begin() Transaction support not implemented"));
      }

    virtual void Rollback()
      {
      wxLogFatalError(wxT("Database::Rollback() Transaction support not implemented"));
      }

    virtual void Commit()
      {
      wxLogFatalError(wxT("Database::Commit() Transaction support not implemented"));
      }

    // Queries

    virtual Statement * Prepare
      (
      const wxString& sQuery
      )                                                 = 0;

    // Database info

    virtual wxArrayString GetDatabases()                = 0;

    virtual bool DatabaseExists
      (
      const wxString& sDatabaseName
      )                                                 = 0;

    virtual wxArrayString GetTables()                   = 0;

    virtual bool TableExists
      (
      const wxString& sTableName
      )                                                 = 0;

  // Members
  protected:
    ConnectionInfo m_cni;
  };

class Statement
  {
  // friends, classes, enums and types

  // Constructors/destructors
  public:
    Statement(Database * pdbOwner, const wxString& sNewQuery);
    virtual ~Statement()
      {}

  // Operators

  // Methods
  public:

    wxString            GetQuery();
    virtual bool        DataAvailable()                 = 0;
    virtual void ExecutePrepared
      (
      const ArrayRecord& raParameters = ArrayRecord()
      )                                                 = 0;
    virtual void ExecuteTemporary
      (
      const ArrayRecord& raParameters = ArrayRecord()
      )                                                 = 0;
    void  Fetch(ArrayRecord& ar);
    void  Fetch(HashRecord& hr);
    void  Fetch(ArrayRecordArray& ara);
    void  Fetch(HashRecordArray& hra);

    virtual long  GetLastInsertId();

  protected:
    virtual int   GetFieldCount()                       = 0;
    virtual void  MoveNext()                            = 0;
    virtual void  GetFieldValue
      (
      int nIndex,
      wxVariant&  v
      )                                                 = 0;
    virtual wxString GetFieldName
      (
      int nIndex
      )                                                 = 0;

  // Members
  protected:
    Database *        pdb;
    wxString          sQuery;
  };

class StatementCache
  {
  // friends, classes, enums and types
  private:
    typedef std::map<wxString, Statement *> Cache;

  // Constructors/destructors
  public:
    StatementCache(Database * pdbNew);
    virtual ~StatementCache();
  private:
    StatementCache();

  // Methods
  public:
    virtual void CacheExecute
      (
      const wxString&     sName,
      const wxString&     sQuery,
      const ArrayRecord&  arParameters = ArrayRecord()
      );

    virtual void CacheExecute
      (
      const wxString&     sName,
      const wxString&     sQuery,
      const ArrayRecord&  arParameters,
      wxVariant&          v
      );

    virtual void CacheExecute
      (
      const wxString&     sName,
      const wxString&     sQuery,
      const ArrayRecord&  arParameters,
      ArrayRecord&        arResult
      );

    virtual void CacheExecute
      (
      const wxString&     sName,
      const wxString&     sQuery,
      const ArrayRecord&  arParameters,
      HashRecord&         hrResult
      );

    virtual void CacheExecute
      (
      const wxString&     sName,
      const wxString&     sQuery,
      const ArrayRecord&  arParameters,
      ArrayRecordArray&   araResult
      );

    virtual void CacheExecute
      (
      const wxString&     sName,
      const wxString&     sQuery,
      const ArrayRecord&  arParameters,
      HashRecordArray&    hraResult
      );

    virtual void CacheExecuteInsert
      (
      const wxString&     sName,
      const wxString&     sQuery,
      const ArrayRecord&  arParameters,
      long&               nLastInsertId
      );

    virtual void ExecuteTemporary
      (
      const wxString&     sQuery,
      const ArrayRecord&  arParameters = ArrayRecord()
      );

    virtual void ExecuteTemporary
      (
      const wxString&     sQuery,
      const ArrayRecord&  arParameters,
      ArrayRecordArray&   araResult
      );

    virtual void Clear();

  private:
    Statement * HandleCaching
      (
      const wxString& sName,
      const wxString& sQuery
      );

    void  Delete(const wxString& sName);

    bool  Exists(const wxString& sName);

  protected:
    Cache           cch;
    Database *      pdb;
  };

} // namespace DBI

} // namespace wx

#ifdef wxDBI_POSTGRES
#include <wx/dbi/postgres.h>
#endif // def wxDBI_POSTGRES
#ifdef wxDBI_SQLITE
#include <wx/dbi/sqlite.h>
#endif // def wxDBI_SQLITE

#endif // ndef __wx_dbi_h__

---