diff options
Diffstat (limited to 'src/components/utils/include/utils/sqlite_wrapper/sql_database.h')
-rw-r--r-- | src/components/utils/include/utils/sqlite_wrapper/sql_database.h | 164 |
1 files changed, 164 insertions, 0 deletions
diff --git a/src/components/utils/include/utils/sqlite_wrapper/sql_database.h b/src/components/utils/include/utils/sqlite_wrapper/sql_database.h new file mode 100644 index 0000000000..5fd3de5fa1 --- /dev/null +++ b/src/components/utils/include/utils/sqlite_wrapper/sql_database.h @@ -0,0 +1,164 @@ +/* + * 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/sqlite_wrapper/sql_error.h" +#include "utils/lock.h" + +struct sqlite3; + +namespace utils { +namespace dbms { + +class SQLQuery; + +/** + * Represents a connection to a database. + */ +class SQLDatabase { + public: + SQLDatabase(); + SQLDatabase(const std::string& database_path, + const std::string& connection_name); + ~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; + + /** + * @brief HasErrors Indicate the status of the last executed operation. + * + * @return true in case last operation has any errors, false otherwise. + */ + bool HasErrors() const; + + /** + * @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: +#ifndef QT_PORT + /** + * Gets connection to the SQLite database + * @return pointer to connection + */ + sqlite3* conn() const; +#endif // QT_PORT + + private: +#ifndef QT_PORT + /** + * The connection to the SQLite database + */ + sqlite3* conn_; +#endif // QT_PORT + + /** + * Lock for guarding connection to database + */ + sync_primitives::Lock conn_lock_; + + /** + * The filename of database + */ + const std::string database_path_; + + /** + * The database connection name + */ + const std::string connection_name_; + + int error_; + + /** + * 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_ |