sqlite_chunk_store.h

Go to the documentation of this file.

/*
 * Copyright 2026 The A11 Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef A11_STORES_SQLITE_CHUNK_STORE_H_
#define A11_STORES_SQLITE_CHUNK_STORE_H_
 
#include <cstddef>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#include <absl/status/status.h>
#include <absl/status/statusor.h>
#include <absl/time/time.h>
 
#include "a11/concurrency/future.h"
#include "a11/data/types.h"
#include "a11/stores/chunk_store.h"
#include "a11/stores/internal/sqlite_database.h"
 
namespace a11::stores {
 
struct SQLiteChunkStoreOptions {
  size_t inline_data_threshold = 128 * 1024;
 
  std::string owner_id;
 
  internal::SqliteSynchronous synchronous =
      internal::SqliteSynchronous::kNormal;
 
  absl::Duration cross_process_poll_interval = absl::ZeroDuration();
 
  absl::Duration blob_grace_period = absl::Hours(1);
 
  absl::Status Validate() const;
  static absl::StatusOr<SQLiteChunkStoreOptions> FromEnvironment();
 
  friend bool operator==(const SQLiteChunkStoreOptions&,
                         const SQLiteChunkStoreOptions&) = default;
};
 
struct SQLiteChunkStoreMetadata {
  std::string id;                          
  std::string owner_id;                    
  bool closed = false;                     
  std::optional<absl::Status> status;      
  std::optional<std::uint32_t> final_seq;  
  size_t size = 0;                     
  std::uint64_t total_chunks_put = 0;  
  std::uint64_t next_cursor = 0;  
  std::uint64_t data_bytes = 0;   
  std::optional<std::uint32_t> max_seq;  
  std::uint64_t revision = 0;            
  absl::Time created_at = absl::InfinitePast();  
  absl::Time updated_at = absl::InfinitePast();  
};
 
class SQLiteChunkStoreFactory;
 
class SQLiteChunkStore final : public ChunkStore {
 private:
  struct ConstructorToken {};
 
 public:
  static absl::StatusOr<std::shared_ptr<SQLiteChunkStore>> Create(
      std::string node_id);
 
  static absl::StatusOr<std::shared_ptr<SQLiteChunkStore>> Create(
      std::string node_id, std::string root);
 
  static absl::StatusOr<std::shared_ptr<SQLiteChunkStore>> Create(
      std::string node_id, const std::string& root,
      SQLiteChunkStoreOptions options);
 
  ~SQLiteChunkStore() override = default;
 
  using ChunkStore::CloseWritesWithStatus;
  using ChunkStore::Get;
  using ChunkStore::GetByArrivalOrder;
  using ChunkStore::Next;
 
  a11::Future<data::NodeFragment> Get(std::uint32_t seq,
                                      absl::Time deadline) override;
  a11::Future<data::NodeFragment> GetByArrivalOrder(
      std::uint64_t arrival_order, absl::Time deadline) override;
  a11::Future<std::vector<std::optional<data::NodeFragment>>> Next(
      absl::Time deadline, size_t limit) override;
  a11::Future<std::uint32_t> Put(data::NodeFragment fragment) override;
  a11::Future<std::vector<std::uint32_t>> PutMany(
      std::vector<data::NodeFragment> fragments) override;
  a11::Future<data::NodeFragment> ClearData(std::uint32_t seq) override;
  a11::Future<std::uint32_t> GetSeqForArrivalOrder(
      std::uint64_t arrival_order) override;
  a11::Future<std::optional<std::uint32_t>> GetFinalSeq() override;
  a11::Future<absl::Status> CloseWritesWithStatus(
      absl::Status status, bool return_status_if_already_closed) override;
  a11::Future<size_t> Size() override;
  absl::StatusOr<std::string> GetId() const override;
 
  a11::Future<SQLiteChunkStoreMetadata> GetMetadata();
 
  a11::Future<std::vector<data::NodeFragment>> FindReferrers(size_t limit);
 
  a11::Future<size_t> SweepOrphanBlobs();
 
  [[nodiscard]] const SQLiteChunkStoreOptions& options() const {
    return options_;
  }
 
  [[nodiscard]] std::string root() const;
 
  SQLiteChunkStore(ConstructorToken, std::string node_id,
                   std::shared_ptr<internal::SqliteDatabase> database,
                   SQLiteChunkStoreOptions options)
      : node_id_(std::move(node_id)),
        database_(std::move(database)),
        options_(std::move(options)) {}
 
 private:
  friend class SQLiteChunkStoreFactory;
 
  enum class ReadKind { kSequence, kArrivalOrder };
 
  a11::Future<data::NodeFragment> Read(ReadKind kind, std::uint64_t value,
                                       absl::Time deadline);
 
  const std::string node_id_;
  const std::shared_ptr<internal::SqliteDatabase> database_;
  const SQLiteChunkStoreOptions options_;
};
 
class SQLiteChunkStoreFactory {
 private:
  struct ConstructorToken {};
 
 public:
  static absl::StatusOr<std::shared_ptr<SQLiteChunkStoreFactory>> Create(
      const std::string& root, SQLiteChunkStoreOptions options);
 
  static absl::StatusOr<std::shared_ptr<SQLiteChunkStoreFactory>> Create(
      const std::string& root);
 
  static absl::StatusOr<std::shared_ptr<SQLiteChunkStoreFactory>> Create();
 
  static std::string DefaultRoot();
 
  absl::StatusOr<std::shared_ptr<SQLiteChunkStore>> Open(std::string node_id);
 
  [[nodiscard]] std::string root() const;
 
  [[nodiscard]] const SQLiteChunkStoreOptions& options() const {
    return options_;
  }
 
  a11::Future<size_t> SweepOrphanBlobs();
 
  SQLiteChunkStoreFactory(ConstructorToken,
                          std::shared_ptr<internal::SqliteDatabase> database,
                          SQLiteChunkStoreOptions options)
      : database_(std::move(database)), options_(std::move(options)) {}
 
 private:
  const std::shared_ptr<internal::SqliteDatabase> database_;
  const SQLiteChunkStoreOptions options_;
};
 
}  // namespace a11::stores
 
#endif  // A11_STORES_SQLITE_CHUNK_STORE_H_