SQLDatabase.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_SQLDatabase_hxx
#define __ccxx_SQLDatabase_hxx

#include <commonc++/Common.h++>
#include <commonc++/IOException.h++>
#include <commonc++/InterruptedException.h++>
#include <commonc++/String.h++>
#include <commonc++/SQLException.h++>

namespace ccxx {

class SQLQuery; // fdw decl

class COMMONCPPDB_API SQLDatabase
{
  public:

  SQLDatabase();

  virtual ~SQLDatabase() throw();

  String getVersion() throw();

  void open(const String &path, bool create = true, bool readOnly = false)
    throw(IOException);

  void close() throw();

  uint_t executeSQL(const String &sql)
    throw(SQLException, InterruptedException);

  void interrupt() throw(SQLException);

  bool isAutoCommit() throw(SQLException);

  SQLQuery *prepareQuery(const String &sql) throw(SQLException);

  int64_t getGeneratedKey() throw(SQLException);

  uint_t getModifiedRowCount() throw(SQLException);

  void begin() throw(SQLException);

  void commit() throw(SQLException, TimeoutException);

  void rollback() throw(SQLException, TimeoutException);

  protected:

  virtual bool onProgress();

  virtual void onCommit();

  virtual void onRollback();

  private:

  void _checkOpened() throw(SQLException);

  static int _progressCallback(void *self);
  static int _commitCallback(void *self);
  static void _rollbackCallback(void *self);
  static int _execCallback(void *self, int cols, char **values,
                           char **colnames);

  class Private; // fwd decl
  Private *_private;

  CCXX_COPY_DECLS(SQLDatabase);
};

class COMMONCPPDB_API ScopedTransaction
{
  public:

  ScopedTransaction(SQLDatabase &database) throw(SQLException);

  ~ScopedTransaction() throw();

  void commit() throw(SQLException, TimeoutException);

  private:

  SQLDatabase &_database;
  bool _committed;

  CCXX_COPY_DECLS(ScopedTransaction);
};

}; // namespace ccxx

#endif // __ccxx_SQLDatabase_hxx

/* end of header file */