rust-rocksdb 0.47.0

Rust wrapper for Facebook's RocksDB embeddable database
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

use std::ptr::NonNull;
use std::sync::Arc;

use crate::env::Env;
use crate::ffi;

pub(crate) struct SstFileManagerWrapper {
    pub(crate) inner: NonNull<ffi::rocksdb_sst_file_manager_t>,
    pub(crate) _env: Env,
}

unsafe impl Send for SstFileManagerWrapper {}
unsafe impl Sync for SstFileManagerWrapper {}

impl Drop for SstFileManagerWrapper {
    fn drop(&mut self) {
        unsafe {
            ffi::rocksdb_sst_file_manager_destroy(self.inner.as_ptr());
        }
    }
}

#[derive(Clone)]
pub struct SstFileManager(pub(crate) Arc<SstFileManagerWrapper>);

impl SstFileManager {
    /// Creates a new `SstFileManager` using the default `Env`.
    ///
    /// SstFileManager tracks and controls total SST file space usage, enabling
    /// applications to cap disk utilization and throttle deletions.
    /// see [docs](https://github.com/facebook/rocksdb/wiki/SST-File-Manager) for more details.
    pub fn new() -> Self {
        let env = Env::new().expect("Could not create default Env");
        let inner = NonNull::new(unsafe { ffi::rocksdb_sst_file_manager_create(env.0.inner) })
            .expect("Could not create RocksDB sst file manager");
        SstFileManager(Arc::new(SstFileManagerWrapper { inner, _env: env }))
    }

    /// Sets the maximum allowed total SST file size in bytes.
    pub fn set_max_allowed_space_usage(&self, bytes: u64) {
        unsafe {
            ffi::rocksdb_sst_file_manager_set_max_allowed_space_usage(self.0.inner.as_ptr(), bytes);
        }
    }

    /// Sets the compaction buffer size in bytes used by the manager for space accounting.
    pub fn set_compaction_buffer_size(&self, bytes: u64) {
        unsafe {
            ffi::rocksdb_sst_file_manager_set_compaction_buffer_size(self.0.inner.as_ptr(), bytes);
        }
    }

    /// Returns true if the total SST file size has reached or exceeded the configured limit.
    pub fn is_max_allowed_space_reached(&self) -> bool {
        unsafe { ffi::rocksdb_sst_file_manager_is_max_allowed_space_reached(self.0.inner.as_ptr()) }
    }

    /// Returns true if the space limit is reached, including compaction output under accounting.
    pub fn is_max_allowed_space_reached_including_compactions(&self) -> bool {
        unsafe {
            ffi::rocksdb_sst_file_manager_is_max_allowed_space_reached_including_compactions(
                self.0.inner.as_ptr(),
            )
        }
    }

    /// Returns the total size of SST files tracked by this manager in bytes.
    pub fn get_total_size(&self) -> u64 {
        unsafe { ffi::rocksdb_sst_file_manager_get_total_size(self.0.inner.as_ptr()) }
    }

    /// Returns the configured file deletion rate in bytes per second. Negative means unlimited.
    pub fn get_delete_rate_bytes_per_second(&self) -> i64 {
        unsafe {
            ffi::rocksdb_sst_file_manager_get_delete_rate_bytes_per_second(self.0.inner.as_ptr())
        }
    }

    /// Sets the file deletion rate in bytes per second. Use a negative value to disable limiting.
    pub fn set_delete_rate_bytes_per_second(&self, rate: i64) {
        unsafe {
            ffi::rocksdb_sst_file_manager_set_delete_rate_bytes_per_second(
                self.0.inner.as_ptr(),
                rate,
            );
        }
    }

    /// Returns the maximum trash-to-DB size ratio used for trash space control.
    pub fn get_max_trash_db_ratio(&self) -> f64 {
        unsafe { ffi::rocksdb_sst_file_manager_get_max_trash_db_ratio(self.0.inner.as_ptr()) }
    }

    /// Sets the maximum trash-to-DB size ratio used for trash space control.
    pub fn set_max_trash_db_ratio(&self, ratio: f64) {
        unsafe {
            ffi::rocksdb_sst_file_manager_set_max_trash_db_ratio(self.0.inner.as_ptr(), ratio);
        }
    }

    /// Returns the total trash size tracked by this manager in bytes.
    pub fn get_total_trash_size(&self) -> u64 {
        unsafe { ffi::rocksdb_sst_file_manager_get_total_trash_size(self.0.inner.as_ptr()) }
    }
}

impl Default for SstFileManager {
    fn default() -> Self {
        Self::new()
    }
}