Struct massa_db_worker::RawMassaDB

pub struct RawMassaDB<ChangeID: PartialOrd + Ord + PartialEq + Eq + Clone + Debug, ChangeIDSerializer: Serializer<ChangeID>, ChangeIDDeserializer: Deserializer<ChangeID>> {
    pub db: DB,
    pub config: MassaDBConfig,
    pub change_history: BTreeMap<ChangeID, BTreeMap<Key, Option<Value>>>,
    pub change_history_versioning: BTreeMap<ChangeID, BTreeMap<Key, Option<Value>>>,
    pub change_id_serializer: ChangeIDSerializer,
    pub change_id_deserializer: ChangeIDDeserializer,
    pub current_batch: Arc<Mutex<WriteBatch>>,
    pub change_history_sizes: BTreeMap<ChangeID, (usize, usize)>,
}

A generic wrapped RocksDB database.

The added features are:

• Hash tracking with Xor
• Streaming the database while it is being actively updated

Fields

db: DB

The rocksdb instance

config: MassaDBConfig

configuration for the RawMassaDB

change_history: BTreeMap<ChangeID, BTreeMap<Key, Option<Value>>>

In change_history, we keep the latest changes made to the database, useful for streaming them to a client.

change_history_versioning: BTreeMap<ChangeID, BTreeMap<Key, Option<Value>>>

same as change_history but for versioning

change_id_serializer: ChangeIDSerializer

A serializer for the ChangeID type

change_id_deserializer: ChangeIDDeserializer

A deserializer for the ChangeID type

current_batch: Arc<Mutex<WriteBatch>>

The current RocksDB batch of the database, in a Mutex to share it

change_history_sizes: BTreeMap<ChangeID, (usize, usize)>

If metrics are enabled, we keep track of the size of the changes associated to each change_id

Implementations

impl<ChangeID, ChangeIDSerializer, ChangeIDDeserializer> RawMassaDB<ChangeID, ChangeIDSerializer, ChangeIDDeserializer>

where ChangeID: PartialOrd + Ord + PartialEq + Eq + Clone + Debug, ChangeIDSerializer: Serializer<ChangeID>, ChangeIDDeserializer: Deserializer<ChangeID>,

pub fn read_opts_for_full_db_traversal() -> ReadOptions

If we read the db with these options, cache will be disabled (useful for scanning the whole db)

pub fn get_batch_to_stream( &self, last_state_step: &StreamingStep<Vec<u8>>, last_change_id: Option<ChangeID>, ) -> Result<StreamBatch<ChangeID>, MassaDBError>

Used for bootstrap servers (get a new batch of data from STATE_CF to stream to the client)

Returns a StreamBatch

pub fn get_versioning_batch_to_stream( &self, last_versioning_step: &StreamingStep<Vec<u8>>, last_change_id: Option<ChangeID>, ) -> Result<StreamBatch<ChangeID>, MassaDBError>

Used for bootstrap servers (get a new batch of data from VERSIONING_CF to stream to the client)

Returns a StreamBatch

pub fn write_changes( &mut self, changes: BTreeMap<Key, Option<Value>>, versioning_changes: BTreeMap<Key, Option<Value>>, change_id: Option<ChangeID>, reset_history: bool, ) -> Result<(), MassaDBError>

Used for:

• Bootstrap clients, to write on disk a new received Stream (reset_history: true)
• Normal operations, to write changes associated to a given change_id (reset_history: false)

pub fn get_change_id(&self) -> Result<ChangeID, ModelsError>

Get the current change_id attached to the database.

pub fn set_initial_change_id(&self, change_id: ChangeID)

Set the initial change_id. This function should only be called at startup/reset, as it does not batch this set with other changes.

pub fn set_change_id_to_batch(&self, change_id: ChangeID)

Set the current change_id in the batch

pub fn write_batch_bootstrap_client( &mut self, stream_changes: StreamBatch<ChangeID>, stream_changes_versioning: StreamBatch<ChangeID>, ) -> Result<(StreamingStep<Key>, StreamingStep<Key>), MassaDBError>

Write a stream_batch of database entries received from a bootstrap server

pub fn get_xof_db_hash(&self) -> HashXof<HASH_XOF_SIZE_BYTES>

Get the current XOF state hash of the database

fn get_xof_db_hash_opt(&self) -> Option<HashXof<HASH_XOF_SIZE_BYTES>>

Get the current XOF state hash of the database

impl RawMassaDB<Slot, SlotSerializer, SlotDeserializer>

pub fn new(config: MassaDBConfig) -> Self

Returns a new MassaDB instance

pub fn default_db_opts() -> Options

Sets various db options for RocksDB

fn new_with_options( config: MassaDBConfig, db_opts: Options, ) -> Result<Self, Error>

Returns a new MassaDB instance given a config and RocksDB options

Trait Implementations

impl<ChangeID, ChangeIDSerializer, ChangeIDDeserializer> Debug for RawMassaDB<ChangeID, ChangeIDSerializer, ChangeIDDeserializer>

where ChangeID: PartialOrd + Ord + PartialEq + Eq + Clone + Debug, ChangeIDSerializer: Serializer<ChangeID>, ChangeIDDeserializer: Deserializer<ChangeID>,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl MassaDBController for RawMassaDB<Slot, SlotSerializer, SlotDeserializer>

fn backup_db(&self, slot: Slot) -> PathBuf

Creates a new hard copy of the DB, for the given slot

fn write_batch( &mut self, batch: DBBatch, versioning_batch: DBBatch, change_id: Option<Slot>, )

Writes the batch to the DB

fn put_or_update_entry_value( &self, batch: &mut DBBatch, key: Vec<u8>, value: &[u8], )

Utility function to put / update a key & value in the batch

fn delete_key(&self, batch: &mut DBBatch, key: Vec<u8>)

Utility function to delete a key & value in the batch

fn delete_prefix( &mut self, prefix: &str, handle_str: &str, change_id: Option<Slot>, )

Utility function to delete all keys in a prefix

fn reset(&mut self, slot: Slot)

Reset the database, and attach it to the given slot.

This function is used in the FinalStateController::reset method which is used in the Bootstrap process when the bootstrap fails (Bootstrap slot too old). A bootstrap to another node will likely occur after this reset.

fn multi_get_cf( &self, query: Vec<(&str, Key)>, ) -> Vec<Result<Option<Value>, MassaDBError>>

Exposes RocksDB’s “multi_get_cf” function

fn iterator_cf( &self, handle_cf: &str, mode: MassaIteratorMode<'_>, ) -> Box<dyn Iterator<Item = (Key, Value)> + '_>

Exposes RocksDB’s “iterator_cf” function

fn iterator_cf_for_full_db_traversal( &self, handle_cf: &str, mode: MassaIteratorMode<'_>, ) -> Box<dyn Iterator<Item = (Key, Value)> + '_>

Exposes RocksDB’s “iterator_cf” function

fn prefix_iterator_cf( &self, handle_cf: &str, prefix: &[u8], ) -> Box<dyn Iterator<Item = (Key, Value)> + '_>

Exposes RocksDB’s “prefix_iterator_cf” function

fn get_xof_db_hash(&self) -> HashXof<HASH_XOF_SIZE_BYTES>

Get the current extended state hash of the database

fn get_change_id(&self) -> Result<Slot, ModelsError>

Get the current change_id attached to the database.

fn set_initial_change_id(&self, change_id: Slot)

Set the initial change_id. This function should only be called at startup/reset, as it does not batch this set with other changes.

fn flush(&self) -> Result<(), MassaDBError>

Flushes the underlying db.

fn write_batch_bootstrap_client( &mut self, stream_changes: StreamBatch<Slot>, stream_changes_versioning: StreamBatch<Slot>, ) -> Result<(StreamingStep<Key>, StreamingStep<Key>), MassaDBError>

Write a stream_batch of database entries received from a bootstrap server

fn get_batch_to_stream( &self, last_state_step: &StreamingStep<Vec<u8>>, last_change_id: Option<Slot>, ) -> Result<StreamBatch<Slot>, MassaDBError>

Used for bootstrap servers (get a new batch of data from STATE_CF to stream to the client)

Returns a StreamBatch

fn get_versioning_batch_to_stream( &self, last_versioning_step: &StreamingStep<Vec<u8>>, last_change_id: Option<Slot>, ) -> Result<StreamBatch<Slot>, MassaDBError>

Used for bootstrap servers (get a new batch of data from VERSIONING_CF to stream to the client)

Returns a StreamBatch

fn get_cf( &self, handle_cf: &str, key: Key, ) -> Result<Option<Value>, MassaDBError>

Exposes RocksDB’s “get_cf” function

fn get_change_history_sizes(&self) -> (usize, usize)

Get the total size of the change history and the change versioning history respectively