Bitcoin Core  21.99.0
P2P Digital Currency
sqlite.h
Go to the documentation of this file.
1 // Copyright (c) 2020 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #ifndef BITCOIN_WALLET_SQLITE_H
6 #define BITCOIN_WALLET_SQLITE_H
7 
8 #include <wallet/db.h>
9 
10 #include <sqlite3.h>
11 
12 struct bilingual_str;
13 class SQLiteDatabase;
14 
16 class SQLiteBatch : public DatabaseBatch
17 {
18 private:
20 
21  bool m_cursor_init = false;
22 
23  sqlite3_stmt* m_read_stmt{nullptr};
24  sqlite3_stmt* m_insert_stmt{nullptr};
25  sqlite3_stmt* m_overwrite_stmt{nullptr};
26  sqlite3_stmt* m_delete_stmt{nullptr};
27  sqlite3_stmt* m_cursor_stmt{nullptr};
28 
29  void SetupSQLStatements();
30 
31  bool ReadKey(CDataStream&& key, CDataStream& value) override;
32  bool WriteKey(CDataStream&& key, CDataStream&& value, bool overwrite = true) override;
33  bool EraseKey(CDataStream&& key) override;
34  bool HasKey(CDataStream&& key) override;
35 
36 public:
37  explicit SQLiteBatch(SQLiteDatabase& database);
38  ~SQLiteBatch() override { Close(); }
39 
40  /* No-op. See comment on SQLiteDatabase::Flush */
41  void Flush() override {}
42 
43  void Close() override;
44 
45  bool StartCursor() override;
46  bool ReadAtCursor(CDataStream& key, CDataStream& value, bool& complete) override;
47  void CloseCursor() override;
48  bool TxnBegin() override;
49  bool TxnCommit() override;
50  bool TxnAbort() override;
51 };
52 
56 {
57 private:
58  const bool m_mock{false};
59 
60  const std::string m_dir_path;
61 
62  const std::string m_file_path;
63 
64  void Cleanup() noexcept;
65 
66 public:
67  SQLiteDatabase() = delete;
68 
70  SQLiteDatabase(const fs::path& dir_path, const fs::path& file_path, bool mock = false);
71 
72  ~SQLiteDatabase();
73 
74  bool Verify(bilingual_str& error);
75 
77  void Open() override;
78 
80  void Close() override;
81 
82  /* These functions are unused */
83  void AddRef() override { assert(false); }
84  void RemoveRef() override { assert(false); }
85 
87  bool Rewrite(const char* skip = nullptr) override;
88 
91  bool Backup(const std::string& dest) const override;
92 
101  void Flush() override {}
102  bool PeriodicFlush() override { return false; }
103  void ReloadDbEnv() override {}
104 
105  void IncrementUpdateCounter() override { ++nUpdateCounter; }
106 
107  std::string Filename() override { return m_file_path; }
108  std::string Format() override { return "sqlite"; }
109 
111  std::unique_ptr<DatabaseBatch> MakeBatch(bool flush_on_close = true) override;
112 
113  sqlite3* m_db{nullptr};
114 };
115 
116 std::unique_ptr<SQLiteDatabase> MakeSQLiteDatabase(const fs::path& path, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error);
117 
118 std::string SQLiteDatabaseVersion();
119 
120 #endif // BITCOIN_WALLET_SQLITE_H
DatabaseOptions
Definition: db.h:203
SQLiteDatabase::Rewrite
bool Rewrite(const char *skip=nullptr) override
Rewrite the entire database on disk.
Definition: sqlite.cpp:280
SQLiteBatch::ReadKey
bool ReadKey(CDataStream &&key, CDataStream &value) override
Definition: sqlite.cpp:368
SQLiteBatch::~SQLiteBatch
~SQLiteBatch() override
Definition: sqlite.h:38
DatabaseStatus
DatabaseStatus
Definition: db.h:212
SQLiteBatch::m_read_stmt
sqlite3_stmt * m_read_stmt
Definition: sqlite.h:23
SQLiteDatabase::MakeBatch
std::unique_ptr< DatabaseBatch > MakeBatch(bool flush_on_close=true) override
Make a SQLiteBatch connected to this database.
Definition: sqlite.cpp:323
SQLiteBatch::m_cursor_init
bool m_cursor_init
Definition: sqlite.h:21
SQLiteDatabase::Open
void Open() override
Open the database if it is not already opened.
Definition: sqlite.cpp:193
bilingual_str
Bilingual messages:
Definition: translation.h:16
SQLiteBatch::SetupSQLStatements
void SetupSQLStatements()
Definition: sqlite.cpp:73
SQLiteBatch::m_overwrite_stmt
sqlite3_stmt * m_overwrite_stmt
Definition: sqlite.h:25
SQLiteBatch::TxnCommit
bool TxnCommit() override
Definition: sqlite.cpp:534
SQLiteDatabase::m_db
sqlite3 * m_db
Definition: sqlite.h:113
SQLiteBatch::Close
void Close() override
Definition: sqlite.cpp:338
WalletDatabase
An instance of this class represents one database.
Definition: db.h:103
SQLiteDatabase::ReloadDbEnv
void ReloadDbEnv() override
Definition: sqlite.h:103
SQLiteBatch::StartCursor
bool StartCursor() override
Definition: sqlite.cpp:484
SQLiteDatabase::Backup
bool Backup(const std::string &dest) const override
Back up the entire database to a file.
Definition: sqlite.cpp:287
SQLiteDatabase::m_mock
const bool m_mock
Definition: sqlite.h:58
SQLiteBatch::m_cursor_stmt
sqlite3_stmt * m_cursor_stmt
Definition: sqlite.h:27
SQLiteDatabase::m_dir_path
const std::string m_dir_path
Definition: sqlite.h:60
db.h
SQLiteBatch::SQLiteBatch
SQLiteBatch(SQLiteDatabase &database)
Definition: sqlite.cpp:329
SQLiteDatabase::AddRef
void AddRef() override
Indicate the a new database user has began using the database.
Definition: sqlite.h:83
SQLiteBatch::WriteKey
bool WriteKey(CDataStream &&key, CDataStream &&value, bool overwrite=true) override
Definition: sqlite.cpp:401
WalletDatabase::nUpdateCounter
std::atomic< unsigned int > nUpdateCounter
Definition: db.h:148
SQLiteBatch::ReadAtCursor
bool ReadAtCursor(CDataStream &key, CDataStream &value, bool &complete) override
Definition: sqlite.cpp:492
SQLiteDatabase
An instance of this class represents one SQLite3 database.
Definition: sqlite.h:55
SQLiteBatch::m_delete_stmt
sqlite3_stmt * m_delete_stmt
Definition: sqlite.h:26
DatabaseBatch
RAII class that provides access to a WalletDatabase.
Definition: db.h:24
SQLiteBatch::EraseKey
bool EraseKey(CDataStream &&key) override
Definition: sqlite.cpp:440
SQLiteBatch::TxnBegin
bool TxnBegin() override
Definition: sqlite.cpp:524
SQLiteDatabase::IncrementUpdateCounter
void IncrementUpdateCounter() override
Definition: sqlite.h:105
SQLiteDatabase::Format
std::string Format() override
Definition: sqlite.h:108
MakeSQLiteDatabase
std::unique_ptr< SQLiteDatabase > MakeSQLiteDatabase(const fs::path &path, const DatabaseOptions &options, DatabaseStatus &status, bilingual_str &error)
Definition: sqlite.cpp:554
SQLiteBatch::m_insert_stmt
sqlite3_stmt * m_insert_stmt
Definition: sqlite.h:24
SQLiteDatabase::Close
void Close() override
Close the database.
Definition: sqlite.cpp:314
SQLiteDatabaseVersion
std::string SQLiteDatabaseVersion()
Definition: sqlite.cpp:572
SQLiteBatch::TxnAbort
bool TxnAbort() override
Definition: sqlite.cpp:544
SQLiteBatch::CloseCursor
void CloseCursor() override
Definition: sqlite.cpp:518
SQLiteBatch::HasKey
bool HasKey(CDataStream &&key) override
Definition: sqlite.cpp:464
SQLiteDatabase::RemoveRef
void RemoveRef() override
Indicate that database user has stopped using the database and that it could be flushed or closed.
Definition: sqlite.h:84
CDataStream
Double ended buffer combining vector and stream-like interfaces.
Definition: streams.h:204
SQLiteDatabase::m_file_path
const std::string m_file_path
Definition: sqlite.h:62
SQLiteDatabase::PeriodicFlush
bool PeriodicFlush() override
Definition: sqlite.h:102
SQLiteBatch
RAII class that provides access to a WalletDatabase.
Definition: sqlite.h:16
SQLiteBatch::Flush
void Flush() override
Definition: sqlite.h:41
error
bool error(const char *fmt, const Args &... args)
Definition: system.h:50
SQLiteDatabase::Verify
bool Verify(bilingual_str &error)
Definition: sqlite.cpp:112
SQLiteBatch::m_database
SQLiteDatabase & m_database
Definition: sqlite.h:19
SQLiteDatabase::Filename
std::string Filename() override
Return path to main database file for logs and error messages.
Definition: sqlite.h:107
assert
assert(std::addressof(::ChainstateActive().CoinsTip())==std::addressof(coins_cache))
SQLiteDatabase::Cleanup
void Cleanup() noexcept
Definition: sqlite.cpp:99
SQLiteDatabase::Flush
void Flush() override
No-ops.
Definition: sqlite.h:101