Client.h

Go to the documentation of this file.

/////////////////////////////////////////////////////////////////////////////
//
// This code was automatically generated by the joedb compiler
// https://www.joedb.org/
//
// Path to compiler: /home/rcoulom/repos/joedb/doc/source/tutorial/build/joedbc
// Version: 9.1.4
// joedbc compilation time: Apr 15 2025 14:46:29
// Generation of this file: 2025-04-15 12:46:31 GMT
//
/////////////////////////////////////////////////////////////////////////////
#ifndef joedb_db_encoded_file_Client_declared
#define joedb_db_encoded_file_Client_declared
 
#include "Writable_Database.h"
#include "joedb/concurrency/Client.h"
 
namespace joedb::db::encoded_file
{
 namespace detail
 {
  ///////////////////////////////////////////////////////////////////////////
  class Client_Data
  ///////////////////////////////////////////////////////////////////////////
  {
   protected:
    Writable_Database db;
 
    Client_Data
    (
     joedb::Buffered_File &file,
     joedb::Readonly_Journal::Check check,
     joedb::Commit_Level commit_level
    ):
     db(file, false, check, commit_level)
    {
    }
  };
 }
 
 /// Handle concurrent access to a @ref joedb::Buffered_File using a @ref joedb::Connection
 class Client:
  protected detail::Client_Data,
  public joedb::Client
 {
  friend class Client_Lock;
 
  private:
   int64_t schema_checkpoint;
 
  protected:
   void read_journal() override
   {
    db.play_journal();
    if (schema_checkpoint)
    {
     if (db.schema_journal.get_checkpoint_position() > schema_checkpoint)
      Database::throw_exception("Can't upgrade schema during pull");
     db.check_single_row();
    }
   }
 
  public:
   Client
   (
    joedb::Buffered_File &file,
    joedb::Connection &connection,
    bool content_check = true,
    joedb::Readonly_Journal::Check check = joedb::Readonly_Journal::Check::all,
    joedb::Commit_Level commit_level = joedb::Commit_Level::no_commit
   ):
    detail::Client_Data(file, check, commit_level),
    joedb::Client(db.journal, connection, content_check),
    schema_checkpoint(0)
   {
    if (get_checkpoint_difference() > 0)
     push_unlock();
 
    db.play_journal(); // makes transaction shorter if db is big
    joedb::Client::transaction([this](){
     db.initialize();
    });
 
    schema_checkpoint = db.schema_journal.get_checkpoint_position();
   }
 
   const Database &get_database() const
   {
    return db;
   }
 
   /// Execute a write transaction
   ///
   /// This function can be called with a lambda like this:
   /// @code
   /// client.transaction([](Writable_Database &db)
   /// {
   ///  db.write_comment("Hello");
   /// });
   /// @endcode
   /// The transaction function locks and pulls the connection before
   /// executing the lambda, pushes and unlocks it after.
   template<typename F> void transaction
   (
    F transaction
   )
   {
    joedb::Client::transaction([&]()
    {
     transaction(db);
    });
   }
 };
 
 /// For more flexibility than the transaction lambda
 ///
 /// See joedb::Client_Lock for more information
 ///
 /// @include client_lock.cpp
 class Client_Lock: public joedb::Client_Lock
 {
  public:
   Client_Lock(Client &client): joedb::Client_Lock(client)
   {
   }
 
   Writable_Database &get_database()
   {
    JOEDB_ASSERT(is_locked());
    return static_cast<Client &>(client).db;
   }
 };
}
 
#endif