coordinode-lsm-tree 5.6.0

Embedded LSM-tree storage engine: BuRR filters, zstd dictionary compression, MVCC, range tombstones, merge operators, K/V separation, AES-256-GCM at rest.
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

use super::*;
use crate::{CompressionType, SequenceNumberCounter, compression::ZstdDictionary};
use alloc::sync::Arc;

#[test]
fn blob_zstd_dict_no_dict_is_rejected() {
    // ZstdDict compression for blobs without providing a dictionary must fail.
    let folder = tempfile::tempdir().unwrap_or_else(|err| panic!("tempdir failed: {err}"));
    let cfg = Config::new(
        folder.path(),
        SequenceNumberCounter::default(),
        SequenceNumberCounter::default(),
    )
    .with_kv_separation(Some(KvSeparationOptions::default().compression(
        CompressionType::ZstdDict {
            level: 3,
            dict_id: 7,
        },
    )));

    assert!(
        matches!(
            cfg.validate_zstd_dictionary(),
            Err(crate::Error::ZstdDictMismatch {
                expected: 7,
                got: None
            })
        ),
        "expected ZstdDictMismatch when no dictionary is supplied",
    );
}

#[test]
fn blob_zstd_dict_id_mismatch_is_rejected() {
    // ZstdDict compression with a dictionary whose id doesn't match the
    // compression type's dict_id must fail.
    let folder = tempfile::tempdir().unwrap_or_else(|err| panic!("tempdir failed: {err}"));
    let dict = Arc::new(ZstdDictionary::new(b"sample training data for test"));
    let wrong_dict_id = dict.id().wrapping_add(1);
    let cfg = Config::new(
        folder.path(),
        SequenceNumberCounter::default(),
        SequenceNumberCounter::default(),
    )
    .with_kv_separation(Some(
        KvSeparationOptions::default()
            .compression(CompressionType::ZstdDict {
                level: 3,
                dict_id: wrong_dict_id,
            })
            .dict(Arc::clone(&dict)),
    ));

    assert!(
        matches!(
            cfg.validate_zstd_dictionary(),
            Err(crate::Error::ZstdDictMismatch { .. })
        ),
        "expected ZstdDictMismatch when dict_id doesn't match dictionary",
    );
}

#[test]
fn blob_zstd_dict_matching_dict_is_accepted() {
    // ZstdDict compression with a correctly matching dictionary must succeed.
    let folder = tempfile::tempdir().unwrap_or_else(|err| panic!("tempdir failed: {err}"));
    let dict = Arc::new(ZstdDictionary::new(b"sample training data for test"));
    let cfg = Config::new(
        folder.path(),
        SequenceNumberCounter::default(),
        SequenceNumberCounter::default(),
    )
    .with_kv_separation(Some(
        KvSeparationOptions::default()
            .compression(CompressionType::ZstdDict {
                level: 3,
                dict_id: dict.id(),
            })
            .dict(Arc::clone(&dict)),
    ));

    assert!(
        cfg.validate_zstd_dictionary().is_ok(),
        "matching dictionary must be accepted",
    );
}