xref: /freebsd/contrib/kyua/utils/sqlite/transaction.hpp (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1 // Copyright 2011 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file utils/sqlite/transaction.hpp
30 /// A RAII model for SQLite transactions.
31 
32 #if !defined(UTILS_SQLITE_TRANSACTION_HPP)
33 #define UTILS_SQLITE_TRANSACTION_HPP
34 
35 #include "utils/sqlite/transaction_fwd.hpp"
36 
37 #include <memory>
38 
39 #include "utils/sqlite/database_fwd.hpp"
40 
41 namespace utils {
42 namespace sqlite {
43 
44 
45 /// A RAII model for an SQLite 3 statement.
46 ///
47 /// A transaction is automatically rolled back when it goes out of scope unless
48 /// it has been explicitly committed.
49 class transaction {
50     struct impl;
51 
52     /// Pointer to the shared internal implementation.
53     std::shared_ptr< impl > _pimpl;
54 
55     explicit transaction(database&);
56     friend class database;
57 
58 public:
59     ~transaction(void);
60 
61     void commit(void);
62     void rollback(void);
63 };
64 
65 
66 }  // namespace sqlite
67 }  // namespace utils
68 
69 #endif  // !defined(UTILS_SQLITE_TRANSACTION_HPP)
70