ducklake 0.0.17

Rust SDK for DuckLake.
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

use std::ops::Deref;

use super::TryIntoRef;
use crate::DucklakeError;
use crate::catalog::{ArenaIdx, Catalog, CatalogView, ViewRef};

pub(crate) struct ViewView<'a, C = &'a Catalog> {
    pub(super) catalog: C,
    pub(super) arena_idx: ArenaIdx,
    _marker: std::marker::PhantomData<&'a ()>,
}

pub(crate) type ViewViewMut<'a> = ViewView<'a, &'a mut Catalog>;

/* --------------------------------------------------------------------------------------------- */
/*                                              INIT                                             */
/* --------------------------------------------------------------------------------------------- */

impl<'a, C: Deref<Target = Catalog>> ViewView<'a, C> {
    pub(super) fn new(catalog: C, view_ref: ViewRef) -> Self {
        Self {
            catalog,
            arena_idx: view_ref.0,
            _marker: std::marker::PhantomData,
        }
    }
}

impl Catalog {
    pub(crate) fn view<R: TryIntoRef<ViewRef>>(
        &self,
        view_ref: R,
    ) -> Result<ViewView<'_>, R::Error> {
        let view_ref = view_ref.try_into_ref(self)?;
        Ok(ViewView::new(self, view_ref))
    }

    pub(crate) fn view_mut<R: TryIntoRef<ViewRef>>(
        &mut self,
        view_ref: R,
    ) -> Result<ViewViewMut<'_>, R::Error> {
        let view_ref = view_ref.try_into_ref(self)?;
        Ok(ViewViewMut::new(self, view_ref))
    }
}

/* ------------------------------------------ INTO REF ----------------------------------------- */

impl TryIntoRef<ViewRef> for &crate::TableName {
    type Error = DucklakeError;

    fn try_into_ref(self, catalog: &Catalog) -> Result<ViewRef, Self::Error> {
        let idx = *catalog
            .schema(&self.schema)?
            .inner()
            .views
            .get(&self.name)
            .ok_or(DucklakeError::view_not_found(self))?;
        Ok(idx.into())
    }
}

impl TryIntoRef<ViewRef> for i64 {
    type Error = DucklakeError;

    fn try_into_ref(self, catalog: &Catalog) -> Result<ViewRef, Self::Error> {
        let idx = catalog
            .view_arena
            .map_id(self)
            .ok_or(DucklakeError::EntityNotFound { id: self })?;
        Ok(idx.into())
    }
}

/* --------------------------------------------------------------------------------------------- */
/*                                          READ & WRITE                                         */
/* --------------------------------------------------------------------------------------------- */

impl<'a, C: Deref<Target = Catalog>> ViewView<'a, C> {
    pub(in crate::catalog) fn inner(&self) -> &CatalogView {
        self.catalog.view_by_idx(self.arena_idx)
    }
}

impl<'a> ViewViewMut<'a> {
    pub(in crate::catalog) fn inner_mut(&mut self) -> &mut CatalogView {
        self.catalog.view_by_idx_mut(self.arena_idx)
    }

    pub(crate) fn parent_schema_mut(&mut self) -> super::schema::SchemaViewMut<'_> {
        let schema_view = self.catalog.schema(&self.name().schema).unwrap();
        self.catalog.schema_mut(schema_view.ref_()).unwrap()
    }
}

impl Catalog {
    pub(super) fn view_by_idx(&self, arena_idx: ArenaIdx) -> &CatalogView {
        self.view_arena.get(arena_idx)
    }

    pub(super) fn view_by_idx_mut(&mut self, arena_idx: ArenaIdx) -> &mut CatalogView {
        self.view_arena.get_mut(arena_idx)
    }
}

/* ----------------------------------------- ACCESSORS ----------------------------------------- */

impl<'a, C: Deref<Target = Catalog>> ViewView<'a, C> {
    pub(crate) fn ref_(&self) -> ViewRef {
        self.arena_idx.into()
    }

    pub(crate) fn id(&self) -> Option<i64> {
        self.inner().id
    }

    pub(crate) fn name(&self) -> &crate::TableName {
        &self.inner().name
    }

    pub(crate) fn sql(&self) -> &str {
        &self.inner().sql
    }

    pub(crate) fn dialect(&self) -> &str {
        &self.inner().dialect
    }

    pub(crate) fn column_aliases(&self) -> Option<Vec<String>> {
        self.inner().column_aliases.clone()
    }

    pub(crate) fn tags(&self) -> Vec<crate::Tag> {
        self.inner().tags.clone()
    }
}

/* ------------------------------------------ MUTATION ----------------------------------------- */

impl<'a> ViewViewMut<'a> {
    pub(crate) fn resolve_id(&mut self, id: i64) {
        let view = self.inner_mut();
        match view.id {
            None => {
                view.id = Some(id);
                self.catalog.view_arena.register_id(self.arena_idx, id);
            }
            _ => panic!("view ID must not be overwritten"),
        }
    }

    /// Delete the view.
    pub(crate) fn delete(&mut self) {
        let view = self.inner_mut();
        let name = view.name.name.clone();
        self.parent_schema_mut().inner_mut().views.remove(&name);
    }
}