radixdb-storage 1.1.0

Storage contracts and physical persistence engine for RadixDB
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

use std::path::PathBuf;

use radixdb_catalog::ObjectId;

use crate::v6::{
    catalog_path, database_manifest_path, table_manifest_path, ArtifactId, ArtifactRef,
    CatalogGeneration, CatalogRef, DatabaseManifestRootRef, FormatResult, ManifestGeneration,
    ManifestKind, ManifestRef, TableManifestRef,
};

/// Exact immutable member of one published physical generation.
///
/// The enum is deliberately private to the lifecycle owner: callers continue
/// to use typed catalog/manifest/artifact references, while cleanup reasons
/// about their complete canonical locator and exact persisted identity.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub(crate) enum ImmutableMemberRef {
    DatabaseManifest(ManifestRef),
    Catalog(CatalogRef),
    TableManifest(TableManifestRef),
    Artifact(ArtifactRef),
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub(crate) enum ImmutableMemberLocator {
    DatabaseManifest(ManifestGeneration),
    Catalog(CatalogGeneration),
    TableManifest(ObjectId, ManifestGeneration),
    Artifact(ArtifactId),
}

impl ImmutableMemberRef {
    pub(crate) fn database_manifest(
        reference: DatabaseManifestRootRef,
        byte_length: u64,
    ) -> FormatResult<Self> {
        Ok(Self::DatabaseManifest(ManifestRef::new(
            reference.id(),
            ManifestKind::Database,
            reference.generation(),
            byte_length,
            *reference.body_sha256(),
        )?))
    }

    pub(crate) const fn locator(self) -> ImmutableMemberLocator {
        match self {
            Self::DatabaseManifest(reference) => {
                ImmutableMemberLocator::DatabaseManifest(reference.generation())
            }
            Self::Catalog(reference) => ImmutableMemberLocator::Catalog(reference.generation()),
            Self::TableManifest(reference) => ImmutableMemberLocator::TableManifest(
                reference.table_id(),
                reference.manifest().generation(),
            ),
            Self::Artifact(reference) => ImmutableMemberLocator::Artifact(reference.id()),
        }
    }

    pub(crate) fn relative_path(self) -> PathBuf {
        match self {
            Self::DatabaseManifest(reference) => {
                database_manifest_path(DatabaseManifestRootRef::new(
                    reference.id(),
                    reference.generation(),
                    *reference.body_sha256(),
                ))
            }
            Self::Catalog(reference) => catalog_path(reference),
            Self::TableManifest(reference) => table_manifest_path(reference),
            Self::Artifact(reference) => reference.relative_path(),
        }
    }

    pub(crate) const fn byte_length(self) -> u64 {
        match self {
            Self::DatabaseManifest(reference) => reference.byte_length(),
            Self::Catalog(reference) => reference.byte_length(),
            Self::TableManifest(reference) => reference.manifest().byte_length(),
            Self::Artifact(reference) => reference.byte_length(),
        }
    }
}