1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
/*
* Copyright (c) 2015, Ford Motor Company
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the Ford Motor Company nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef SRC_COMPONENTS_UTILS_INCLUDE_UTILS_SQLITE_WRAPPER_SQL_DATABASE_H_
#define SRC_COMPONENTS_UTILS_INCLUDE_UTILS_SQLITE_WRAPPER_SQL_DATABASE_H_
#include <string>
#include "utils/lock.h"
#include "utils/sqlite_wrapper/sql_error.h"
struct sqlite3;
namespace utils {
namespace dbms {
class SQLQuery;
/**
* Represents a connection to a database.
*/
class SQLDatabase {
public:
SQLDatabase();
explicit SQLDatabase(const std::string& filename);
~SQLDatabase();
/**
* Opens connection to the temporary in-memory database
* @return true if successfully
*/
bool Open();
/**
* Closes connection to the database
*/
void Close();
/**
* Begins a transaction on the database
* @return true if successfully
*/
bool BeginTransaction();
/**
* Commits a transaction to the database
* @return true if successfully
*/
bool CommitTransaction();
/**
* Rolls back a transaction on the database
* @return true if successfully
*/
bool RollbackTransaction();
/**
* Gets information about the last error that occurred on the database
* @return last error
*/
SQLError LastError() const;
/**
* Sets path to database
* If the database is already opened then need reopen it
*/
void set_path(const std::string& path);
/**
* @brief get_path databse location path.
*
* @return the path to the database location
*/
std::string get_path() const;
/**
* Checks if database is read/write
* @return true if database is read/write
*/
bool IsReadWrite();
/**
* Call backup for opened DB
*/
bool Backup();
protected:
/**
* Gets connection to the SQLite database
* @return pointer to connection
*/
sqlite3* conn() const;
private:
/**
* The connection to the SQLite database
*/
sqlite3* conn_;
/**
* Lock for guarding connection to database
*/
sync_primitives::Lock conn_lock_;
/**
* The file path of database
*/
std::string path_;
/**
* The filename of database
*/
std::string databasename_;
/**
* The last error that occurred on the database
*/
int error_;
/**
* The temporary in-memory database
* @see SQLite manual
*/
static const std::string kInMemory;
/**
* The extension of filename of database
*/
static const std::string kExtension;
/**
* Execs query for internal using in this class
* @param query sql query without return results
* @return true if query was executed successfully
*/
inline bool Exec(const std::string& query);
friend class SQLQuery;
};
} // namespace dbms
} // namespace utils
#endif // SRC_COMPONENTS_UTILS_INCLUDE_UTILS_SQLITE_WRAPPER_SQL_DATABASE_H_
|
