version_info.h

Go to the documentation of this file.

#pragma once
 
#include <array>
 
#include "constants.h"
#include "copy_constructors.h"
#include "sel_vector.h"
#include "types.h"
 
namespace kuzu {
namespace transaction {
class Transaction;
} // namespace transaction
 
namespace storage {
 
struct VectorVersionInfo {
 enum class InsertionStatus : uint8_t { NO_INSERTED, CHECK_VERSION, ALWAYS_INSERTED };
 // TODO(Guodong): ALWAYS_INSERTED is not added for now, but it may be useful as an optimization
 // to mark the vector data after checkpoint is all deleted.
 enum class DeletionStatus : uint8_t { NO_DELETED, CHECK_VERSION };
 
 // TODO: Keep an additional same insertion/deletion field as an optimization to avoid the need
 // of `array` if all are inserted/deleted in the same transaction.
 // Also, avoid allocate `array` when status are NO_INSERTED and NO_DELETED.
 // We can even consider separating the insertion and deletion into two separate Vectors.
 std::array<common::transaction_t, common::DEFAULT_VECTOR_CAPACITY> insertedVersions;
 std::array<common::transaction_t, common::DEFAULT_VECTOR_CAPACITY> deletedVersions;
 InsertionStatus insertionStatus;
 DeletionStatus deletionStatus;
 
 VectorVersionInfo()
 : insertedVersions{}, deletedVersions{}, insertionStatus{InsertionStatus::NO_INSERTED},
 deletionStatus{DeletionStatus::NO_DELETED} {
 insertedVersions.fill(common::INVALID_TRANSACTION);
 deletedVersions.fill(common::INVALID_TRANSACTION);
 }
 DELETE_COPY_DEFAULT_MOVE(VectorVersionInfo);
 
 bool anyVersions() const {
 return insertionStatus == InsertionStatus::CHECK_VERSION ||
 deletionStatus == DeletionStatus::CHECK_VERSION;
 }
 common::row_idx_t append(common::transaction_t transactionID, common::row_idx_t startRow,
 common::row_idx_t numRows);
 bool delete_(common::transaction_t transactionID, common::row_idx_t rowIdx);
 
 void getSelVectorForScan(common::transaction_t startTS, common::transaction_t transactionID,
 common::SelectionVector& selVector, common::row_idx_t startRow, common::row_idx_t numRows,
 common::sel_t startOutputPos) const;
 
 void rollbackInsertions(common::row_idx_t startRowInVector, common::row_idx_t numRows);
 void rollbackDeletions(common::row_idx_t startRowInVector, common::row_idx_t numRows);
 
 void serialize(common::Serializer& serializer) const;
 static std::unique_ptr<VectorVersionInfo> deSerialize(common::Deserializer& deSer);
 
 common::row_idx_t numCommittedDeletions(const transaction::Transaction* transaction) const;
 
 // Given startTS and transactionID, if the row is deleted to the transaction, return true.
 bool isDeleted(common::transaction_t startTS, common::transaction_t transactionID,
 common::row_idx_t rowIdx) const;
 // Given startTS and transactionID, if the row is readable to the transaction, return true.
 bool isInserted(common::transaction_t startTS, common::transaction_t transactionID,
 common::row_idx_t rowIdx) const;
 
 common::row_idx_t getNumDeletions(common::transaction_t startTS,
 common::transaction_t transactionID, common::row_idx_t startRow,
 common::length_t numRows) const;
 
 // Return true if this vectorInfo needs to be kept after finalize.
 bool finalizeStatusFromVersions();
};
 
class VersionInfo {
public:
 VersionInfo() {}
 
 common::row_idx_t append(const transaction::Transaction* transaction,
 common::row_idx_t startRow, common::row_idx_t numRows);
 bool delete_(const transaction::Transaction* transaction, common::row_idx_t rowIdx);
 
 void getSelVectorToScan(common::transaction_t startTS, common::transaction_t transactionID,
 common::SelectionVector& selVector, common::row_idx_t startRow,
 common::row_idx_t numRows) const;
 
 void clearVectorInfo(common::idx_t vectorIdx);
 
 bool hasDeletions() const;
 common::row_idx_t getNumDeletions(const transaction::Transaction* transaction,
 common::row_idx_t startRow, common::length_t numRows) const;
 bool hasInsertions() const;
 bool isDeleted(const transaction::Transaction* transaction, common::row_idx_t rowInChunk) const;
 bool isInserted(const transaction::Transaction* transaction,
 common::row_idx_t rowInChunk) const;
 
 common::row_idx_t getNumDeletions(const transaction::Transaction* transaction) const;
 
 // Return nullptr when vectorIdx is out of range or when the vector is not created.
 VectorVersionInfo* getVectorVersionInfo(common::idx_t vectorIdx) const;
 common::idx_t getNumVectors() const { return vectorsInfo.size(); }
 VectorVersionInfo& getOrCreateVersionInfo(common::idx_t vectorIdx);
 
 bool finalizeStatusFromVersions();
 
 void serialize(common::Serializer& serializer) const;
 static std::unique_ptr<VersionInfo> deserialize(common::Deserializer& deSer);
 
private:
 std::vector<std::unique_ptr<VectorVersionInfo>> vectorsInfo;
};
 
} // namespace storage
} // namespace kuzu