StormByte-Database 3.0.0
C++26 database module of the StormByte suite
Loading...
Searching...
No Matches
sqlite3.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Database.
5 *
6 * StormByte-Database original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Database source in this
20 * repository. They do not cover other StormByte modules or any third-party
21 * material shipped with this repository (including everything under
22 * thirdparty/, and in particular the bundled StormByte-Logger tree and
23 * the PostgreSQL, MariaDB and SQLite trees), which remain under their own
24 * licenses.
25 *
26 * Neither license grants any patent rights. Any patent licenses required
27 * to use this software or third-party components must be obtained separately
28 * from the patent holders.
29 *
30 * StormByte-Database is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU Lesser General Public License for more details.
34 *
35 * You should have received a copy of the GNU Lesser General Public License
36 * version 3 along with StormByte-Database. If not, see
37 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
38 *
39 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
40 */
41
42#pragma once
43
47
48#include <filesystem>
49#include <string_view>
50
55namespace StormByte {
60 namespace Database {
65 namespace SQLite {
70 struct ConnectionHandle;
71
80 public:
84 SQLite3(const SQLite3 &db) = delete;
85
90 SQLite3(SQLite3 &&db) noexcept;
91
95 SQLite3 &operator=(const SQLite3 &db) = delete;
96
102 SQLite3 &operator=(SQLite3 &&db) noexcept;
103
107 ~SQLite3() noexcept override;
108
114 ExpectedRows Query(std::string_view query) noexcept override;
115
121 bool SilentQuery(std::string_view query) noexcept override;
122
123 protected:
128 SQLite3(const StormByte::Safe::Shared<Logger::Log>& logger);
129
135 STORMBYTE_FORCE_INLINE SQLite3(const std::filesystem::path &dbfile, const StormByte::Safe::Shared<Logger::Log>& logger)
136 : SQLite3(PathText(dbfile), logger, Utf8Path{}) {}
137
143 STORMBYTE_FORCE_INLINE SQLite3(std::filesystem::path &&dbfile, const StormByte::Safe::Shared<Logger::Log>& logger)
144 : SQLite3(PathText(dbfile), logger, Utf8Path{}) {}
145
150
156 bool DoSilentQuery(std::string_view query) noexcept override;
157
158 private:
163 struct STORMBYTE_DATABASE_PRIVATE Utf8Path {};
164
171 SQLite3(const StormByte::Safe::String& dbfile, const StormByte::Safe::Shared<Logger::Log>& logger, Utf8Path tag);
172
178 STORMBYTE_FORCE_INLINE static StormByte::Safe::String PathText(const std::filesystem::path& path) {
179 const auto text = path.u8string();
180 return StormByte::Safe::String(std::string_view{reinterpret_cast<const char*>(text.data()), text.size()});
181 }
182
183 StormByte::Safe::String m_database_file;
185
190 bool DoConnect() noexcept override;
191
195 void DoPreDisconnect() noexcept override;
196
200 void DoDisconnect() noexcept override;
201
205 void DoPostDisconnect() noexcept override;
206
213 StormByte::Safe::Unique<StormByte::Database::PreparedSTMT> CreatePreparedSTMT(std::string_view name, std::string_view query) noexcept override;
214
219 void DoBeginTransaction(IsolationLevel level) override;
220 };
221 } }}
222
Database(const StormByte::Safe::Shared< Logger::Log > &logger)
Construct with an optional logger.
SQLite3 backend.
Definition sqlite3.hxx:79
bool SilentQuery(std::string_view query) noexcept override
Execute a query that does not return rows.
SQLite3 & operator=(const SQLite3 &db)=delete
Copy assignment (deleted).
bool DoSilentQuery(std::string_view query) noexcept override
Internal silent query.
SQLite3 & operator=(SQLite3 &&db) noexcept
Move assignment that transfers the database connection.
void EnableForeignKeys()
Enable foreign keys (off by default in SQLite).
SQLite3(const SQLite3 &db)=delete
Copy constructor (deleted).
~SQLite3() noexcept override
Destructor.
ExpectedRows Query(std::string_view query) noexcept override
Execute a query that returns rows.
SQLite3(SQLite3 &&db) noexcept
Move constructor that transfers the database connection.
SQLite3(std::filesystem::path &&dbfile, const StormByte::Safe::Shared< Logger::Log > &logger)
File-backed database (moved path and logger).
Definition sqlite3.hxx:143
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Logger::Exception)
SQLite backend of the Database module.
Database module of the StormByte suite.
Expected< Rows, QueryException > ExpectedRows
Query result: Rows or QueryException.
Definition typedefs.hxx:81
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_FORCE_INLINE
Private opaque holder for the native MariaDB connection.
#define STORMBYTE_DATABASE_PRIVATE
Definition visibility.h:57
#define STORMBYTE_DATABASE_PUBLIC
Definition visibility.h:54