mirror of
https://github.com/XRPLF/rippled.git
synced 2026-03-27 07:02:33 +00:00
addc1e8e25
Signed-off-by: JCW <a1q123456@users.noreply.github.com> Co-authored-by: Ed Hennis <ed@ripple.com>
121 lines
2.9 KiB
C++
121 lines
2.9 KiB
C++
#pragma once
|
|
|
|
/** An embedded database wrapper with an intuitive, type-safe interface.
|
|
|
|
This collection of classes let's you access embedded SQLite databases
|
|
using C++ syntax that is very similar to regular SQL.
|
|
|
|
This module requires the @ref beast_sqlite external module.
|
|
*/
|
|
|
|
#if defined(__clang__)
|
|
#pragma clang diagnostic push
|
|
#pragma clang diagnostic ignored "-Wdeprecated"
|
|
#endif
|
|
|
|
#include <xrpl/core/JobQueue.h>
|
|
#include <xrpl/core/ServiceRegistry.h>
|
|
|
|
#define SOCI_USE_BOOST
|
|
#include <soci/soci.h>
|
|
|
|
#include <cstdint>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
namespace sqlite_api {
|
|
struct sqlite3;
|
|
}
|
|
|
|
namespace xrpl {
|
|
|
|
class BasicConfig;
|
|
|
|
/**
|
|
DBConfig is used when a client wants to delay opening a soci::session after
|
|
parsing the config parameters. If a client want to open a session
|
|
immediately, use the free function "open" below.
|
|
*/
|
|
class DBConfig
|
|
{
|
|
std::string connectionString_;
|
|
explicit DBConfig(std::string const& dbPath);
|
|
|
|
public:
|
|
DBConfig(BasicConfig const& config, std::string const& dbName);
|
|
std::string
|
|
connectionString() const;
|
|
void
|
|
open(soci::session& s) const;
|
|
};
|
|
|
|
/**
|
|
Open a soci session.
|
|
|
|
@param s Session to open.
|
|
|
|
@param config Parameters to pick the soci backend and how to connect to that
|
|
backend.
|
|
|
|
@param dbName Name of the database. This has different meaning for different
|
|
backends. Sometimes it is part of a filename (sqlite3),
|
|
other times it is a database name (postgresql).
|
|
*/
|
|
void
|
|
open(soci::session& s, BasicConfig const& config, std::string const& dbName);
|
|
|
|
/**
|
|
* Open a soci session.
|
|
*
|
|
* @param s Session to open.
|
|
* @param beName Backend name.
|
|
* @param connectionString Connection string to forward to soci::open.
|
|
* see the soci::open documentation for how to use this.
|
|
*
|
|
*/
|
|
void
|
|
open(soci::session& s, std::string const& beName, std::string const& connectionString);
|
|
|
|
std::uint32_t
|
|
getKBUsedAll(soci::session& s);
|
|
std::uint32_t
|
|
getKBUsedDB(soci::session& s);
|
|
|
|
void
|
|
convert(soci::blob& from, std::vector<std::uint8_t>& to);
|
|
void
|
|
convert(soci::blob& from, std::string& to);
|
|
void
|
|
convert(std::vector<std::uint8_t> const& from, soci::blob& to);
|
|
void
|
|
convert(std::string const& from, soci::blob& to);
|
|
|
|
class Checkpointer : public std::enable_shared_from_this<Checkpointer>
|
|
{
|
|
public:
|
|
virtual std::uintptr_t
|
|
id() const = 0;
|
|
virtual ~Checkpointer() = default;
|
|
|
|
virtual void
|
|
schedule() = 0;
|
|
|
|
virtual void
|
|
checkpoint() = 0;
|
|
};
|
|
|
|
/** Returns a new checkpointer which makes checkpoints of a
|
|
soci database every checkpointPageCount pages, using a job on the job queue.
|
|
|
|
The checkpointer contains references to the session and job queue
|
|
and so must outlive them both.
|
|
*/
|
|
std::shared_ptr<Checkpointer>
|
|
makeCheckpointer(std::uintptr_t id, std::weak_ptr<soci::session>, JobQueue&, ServiceRegistry&);
|
|
|
|
} // namespace xrpl
|
|
|
|
#if defined(__clang__)
|
|
#pragma clang diagnostic pop
|
|
#endif
|