Bitcoin Core  0.20.99
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 commeng 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 bool ExistsSQLiteDatabase(const fs::path& path);
117 std::unique_ptr<SQLiteDatabase> MakeSQLiteDatabase(const fs::path& path, const DatabaseOptions& options, DatabaseStatus& status, bilingual_str& error);
118 
119 std::string SQLiteDatabaseVersion();
120 bool IsSQLiteFile(const fs::path& path);
121 
122 #endif // BITCOIN_WALLET_SQLITE_H
bool TxnBegin() override
Definition: sqlite.cpp:539
void CloseCursor() override
Definition: sqlite.cpp:533
bool TxnCommit() override
Definition: sqlite.cpp:549
std::string Filename() override
Return path to main database file for logs and error messages.
Definition: sqlite.h:107
void Flush() override
Definition: sqlite.h:41
bool WriteKey(CDataStream &&key, CDataStream &&value, bool overwrite=true) override
Definition: sqlite.cpp:416
void Flush() override
No-ops.
Definition: sqlite.h:101
Bilingual messages:
Definition: translation.h:16
bool IsSQLiteFile(const fs::path &path)
Definition: sqlite.cpp:597
Double ended buffer combining vector and stream-like interfaces.
Definition: streams.h:202
void SetupSQLStatements()
Definition: sqlite.cpp:72
bool EraseKey(CDataStream &&key) override
Definition: sqlite.cpp:455
std::string SQLiteDatabaseVersion()
Definition: sqlite.cpp:592
sqlite3_stmt * m_read_stmt
Definition: sqlite.h:23
void ReloadDbEnv() override
Definition: sqlite.h:103
sqlite3_stmt * m_overwrite_stmt
Definition: sqlite.h:25
void IncrementUpdateCounter() override
Definition: sqlite.h:105
std::string Format() override
Definition: sqlite.h:108
RAII class that provides access to a WalletDatabase.
Definition: db.h:25
const std::string m_dir_path
Definition: sqlite.h:60
bool HasKey(CDataStream &&key) override
Definition: sqlite.cpp:479
bool ReadAtCursor(CDataStream &key, CDataStream &value, bool &complete) override
Definition: sqlite.cpp:507
void Close() override
Definition: sqlite.cpp:344
An instance of this class represents one SQLite3 database.
Definition: sqlite.h:55
bool StartCursor() override
Definition: sqlite.cpp:499
SQLiteDatabase & m_database
Definition: sqlite.h:19
std::unique_ptr< SQLiteDatabase > MakeSQLiteDatabase(const fs::path &path, const DatabaseOptions &options, DatabaseStatus &status, bilingual_str &error)
Definition: sqlite.cpp:575
bool PeriodicFlush() override
Definition: sqlite.h:102
const std::string m_file_path
Definition: sqlite.h:62
sqlite3_stmt * m_cursor_stmt
Definition: sqlite.h:27
SQLiteBatch(SQLiteDatabase &database)
Definition: sqlite.cpp:335
sqlite3_stmt * m_delete_stmt
Definition: sqlite.h:26
bool TxnAbort() override
Definition: sqlite.cpp:559
bool ExistsSQLiteDatabase(const fs::path &path)
Definition: sqlite.cpp:569
RAII class that provides access to a WalletDatabase.
Definition: sqlite.h:16
bool m_cursor_init
Definition: sqlite.h:21
bool ReadKey(CDataStream &&key, CDataStream &value) override
Definition: sqlite.cpp:383
~SQLiteBatch() override
Definition: sqlite.h:38
DatabaseStatus
Definition: db.h:213
bool error(const char *fmt, const Args &... args)
Definition: system.h:52
void RemoveRef() override
Indicate that database user has stopped using the database and that it could be flushed or closed...
Definition: sqlite.h:84
sqlite3_stmt * m_insert_stmt
Definition: sqlite.h:24
An instance of this class represents one database.
Definition: db.h:104