write.hh

Go to the documentation of this file.

/* ========================================================================== *
 *
 * @file flox/pkgdb/write.hh
 *
 * @brief Interfaces for writing to a SQLite3 package set database.
 *
 *
 * -------------------------------------------------------------------------- */
 
#pragma once
 
#include <tuple>
 
#include "flox/pkgdb/read.hh"
 
 
/* -------------------------------------------------------------------------- */
 
namespace flox::pkgdb {
 
/* -------------------------------------------------------------------------- */
 
using Target = std::tuple<flox::AttrPath, flox::Cursor, row_id>;
 
using Todos = std::queue<Target, std::list<Target>>;
 
 
/* -------------------------------------------------------------------------- */
 
class PkgDb : public PkgDbReadOnly
{
 
  /* --------------------------------------------------------------------------
   */
 
  /* Internal Helpers */
 
protected:
 
  void
  initTables();
 
 
  void
  initViews();
 
  void
  updateViews();
 
 
  void
  initVersions();
 
 
  void
  init();
 
 
  void
  writeInput();
 
 
  /* --------------------------------------------------------------------------
   */
 
  /* Constructors */
 
public:
 
  explicit PkgDb( std::string_view dbPath )
  {
    this->dbPath = dbPath;
    if ( ! std::filesystem::exists( this->dbPath ) )
      {
        throw PkgDbReadOnly::NoSuchDatabase(
          *dynamic_cast<PkgDbReadOnly *>( this ) );
      }
    this->db.connect( this->dbPath.c_str(),
                      SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE );
    this->init();
    this->loadLockedFlake();
  }
 
  PkgDb( const Fingerprint & fingerprint, std::string_view dbPath )
  {
    this->dbPath      = dbPath;
    this->fingerprint = fingerprint;
    if ( ! std::filesystem::exists( this->dbPath ) )
      {
        throw PkgDbReadOnly::NoSuchDatabase(
          *dynamic_cast<PkgDbReadOnly *>( this ) );
      }
    this->db.connect( this->dbPath.c_str(),
                      SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE );
    this->init();
    this->loadLockedFlake();
  }
 
  explicit PkgDb( const Fingerprint & fingerprint )
    : PkgDb( fingerprint, genPkgDbName( fingerprint ).string() )
  {}
 
  PkgDb( const nix::flake::LockedFlake & flake, std::string_view dbPath )
  {
    this->dbPath      = dbPath;
    this->fingerprint = flake.getFingerprint();
    this->db.connect( this->dbPath.c_str(),
                      SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE );
    init();
    this->lockedRef
      = { flake.flake.lockedRef.to_string(),
          nix::fetchers::attrsToJSON( flake.flake.lockedRef.toAttrs() ) };
    writeInput();
  }
 
  explicit PkgDb( const nix::flake::LockedFlake & flake )
    : PkgDb( flake, genPkgDbName( flake.getFingerprint() ).string() )
  {}
 
 
  /* --------------------------------------------------------------------------
   */
 
  /* Basic Operations */
 
  // public:
 
  inline sql_rc
  execute( const char * stmt )
  {
    sqlite3pp::command cmd( this->db, stmt );
    return cmd.execute();
  }
 
  inline sql_rc
  execute_all( const char * stmt )
  {
    sqlite3pp::command cmd( this->db, stmt );
    return cmd.execute_all();
  }
 
 
  /* --------------------------------------------------------------------------
   */
 
  /* Insert */
 
  // public:
 
  row_id
  addOrGetAttrSetId( const std::string & attrName, row_id parent = 0 );
 
  row_id
  addOrGetAttrSetId( const flox::AttrPath & path );
 
  row_id
  addOrGetDescriptionId( const std::string & description );
 
  row_id
  addPackage( row_id               parentId,
              std::string_view     attrName,
              const flox::Cursor & cursor,
              bool                 replace  = false,
              bool                 checkDrv = true );
 
 
  /* --------------------------------------------------------------------------
   */
 
  /* Updates */
 
  void
  setPrefixDone( row_id prefixId, bool done );
 
  void
  setPrefixDone( const flox::AttrPath & prefix, bool done );
 
 
  /* --------------------------------------------------------------------------
   */
 
  void
  scrape( nix::SymbolTable & syms, const Target & target, Todos & todo );
 
 
  /* --------------------------------------------------------------------------
   */
 
}; /* End class `PkgDb' */
 
 
/* -------------------------------------------------------------------------- */
 
}  // namespace flox::pkgdb
 
 
/* -------------------------------------------------------------------------- *
 *
 *
 *
 * ========================================================================== */