VSQLite++  0.3
transaction.hpp
Go to the documentation of this file.
1 /*##############################################################################
2  VSQLite++ - virtuosic bytes SQLite3 C++ wrapper
3 
4  Copyright (c) 2006-2014 Vinzenz Feenstra vinzenz.feenstra@gmail.com
5  Copyright (c) 2014 mickey mickey.mouse-1985@libero.it
6  All rights reserved.
7 
8  Redistribution and use in source and binary forms, with or without modification,
9  are permitted provided that the following conditions are met:
10 
11  * Redistributions of source code must retain the above copyright notice,
12  this list of conditions and the following disclaimer.
13  * Redistributions in binary form must reproduce the above copyright notice,
14  this list of conditions and the following disclaimer in the documentation
15  and/or other materials provided with the distribution.
16  * Neither the name of virtuosic bytes nor the names of its contributors may
17  be used to endorse or promote products derived from this software without
18  specific prior written permission.
19 
20  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  POSSIBILITY OF SUCH DAMAGE.
31 
32 ##############################################################################*/
33 #ifndef GUARD_SQLITE_TRANSACTION_HPP_INCLUDED
34 #define GUARD_SQLITE_TRANSACTION_HPP_INCLUDED
35 
36 namespace sqlite{
37  struct connection;
38 
52  enum class transaction_type {
53  undefined,
54  deferred,
55  immediate,
56  exclusive
57  };
58 
62  struct transaction{
63  public:
69  transaction(connection & con, transaction_type type = transaction_type::undefined);
70 
75 
79  void begin(transaction_type type = transaction_type::undefined);
80 
84  void end();
85 
89  void commit();
90 
94  void rollback();
95 
100  bool isActive() const { return m_isActive; }
101  private:
102  void exec(std::string const &);
104  bool m_isActive;
105  };
106 }
107 
108 #endif //GUARD_SQLITE_TRANSACTION_HPP_INCLUDED
109 
sqlite::transaction::transaction
transaction(connection &con, transaction_type type=transaction_type::undefined)
constructor
sqlite::transaction::end
void end()
Ends an transaction.
sqlite::transaction::~transaction
~transaction()
destructor
sqlite::transaction::isActive
bool isActive() const
Allow to check if transaction handled by this object is currently active.
Definition: transaction.hpp:100
sqlite::transaction_type
transaction_type
Defines the kind of transaction to begin.
Definition: transaction.hpp:52
sqlite::transaction::begin
void begin(transaction_type type=transaction_type::undefined)
Starts a transaction.
sqlite::connection
connection is used to open, close, attach and detach a database. Further it has to be passed to all c...
Definition: connection.hpp:45
sqlite::transaction::m_isActive
bool m_isActive
if true there is a transaction currently opened
Definition: transaction.hpp:104
sqlite::transaction::exec
void exec(std::string const &)
sqlite::transaction::m_con
connection & m_con
Definition: transaction.hpp:103
sqlite::transaction::rollback
void rollback()
Rolls back a transaction.
sqlite
Definition: command.hpp:42
sqlite::type
type
Definition: variant.hpp:43
sqlite::transaction::commit
void commit()
Commits a transaction.
sqlite::transaction_type::undefined
@ undefined
sqlite::transaction
transaction is a helper class to start transactions within SQLite
Definition: transaction.hpp:62