radixdb-catalog 1.1.0

Generational logical catalog owner 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
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

use crate::{CatalogError, CatalogName, CatalogPayload, CatalogResult, ObjectId, ObjectKind};

/// Fully decoded catalog object before global graph admission.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CatalogObject {
    id: ObjectId,
    kind: ObjectKind,
    namespace_id: Option<ObjectId>,
    parent_id: Option<ObjectId>,
    owner_principal_id: ObjectId,
    name: CatalogName,
    definition_revision: u64,
    payload: CatalogPayload,
}

impl CatalogObject {
    #[allow(clippy::too_many_arguments)]
    pub fn new(
        id: ObjectId,
        namespace_id: Option<ObjectId>,
        parent_id: Option<ObjectId>,
        owner_principal_id: ObjectId,
        name: CatalogName,
        definition_revision: u64,
        payload: CatalogPayload,
    ) -> CatalogResult<Self> {
        Self::from_fields(
            id,
            payload.kind(),
            0,
            namespace_id,
            parent_id,
            owner_principal_id,
            name,
            definition_revision,
            payload,
        )
    }

    #[allow(clippy::too_many_arguments)]
    pub fn from_fields(
        id: ObjectId,
        kind: ObjectKind,
        flags: u32,
        namespace_id: Option<ObjectId>,
        parent_id: Option<ObjectId>,
        owner_principal_id: ObjectId,
        name: CatalogName,
        definition_revision: u64,
        payload: CatalogPayload,
    ) -> CatalogResult<Self> {
        if flags != 0 {
            return Err(CatalogError::InvalidCatalogObject {
                id: id.to_string(),
                detail: "unknown object flags",
            });
        }
        if definition_revision == 0 {
            return Err(CatalogError::InvalidCatalogObject {
                id: id.to_string(),
                detail: "definition revision must be non-zero",
            });
        }
        if kind != payload.kind() {
            return Err(CatalogError::PayloadKindMismatch {
                id: id.to_string(),
                header: object_kind_name(kind),
                payload: object_kind_name(payload.kind()),
            });
        }
        Ok(Self {
            id,
            kind,
            namespace_id,
            parent_id,
            owner_principal_id,
            name,
            definition_revision,
            payload,
        })
    }

    pub const fn id(&self) -> ObjectId {
        self.id
    }

    pub const fn kind(&self) -> ObjectKind {
        self.kind
    }

    pub const fn namespace_id(&self) -> Option<ObjectId> {
        self.namespace_id
    }

    pub const fn parent_id(&self) -> Option<ObjectId> {
        self.parent_id
    }

    pub const fn owner_principal_id(&self) -> ObjectId {
        self.owner_principal_id
    }

    pub const fn flags(&self) -> u32 {
        0
    }

    pub fn name(&self) -> &CatalogName {
        &self.name
    }

    pub const fn definition_revision(&self) -> u64 {
        self.definition_revision
    }

    pub const fn payload_version(&self) -> u16 {
        self.payload.version()
    }

    pub const fn payload(&self) -> &CatalogPayload {
        &self.payload
    }
}

pub(crate) const fn object_kind_name(kind: ObjectKind) -> &'static str {
    kind.name()
}