ducklake 0.0.9

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

use std::ops::Deref;

use super::TryIntoRef;
use crate::catalog::{ArenaIdx, Catalog, CatalogSchema, SchemaRef};
use crate::{DucklakeError, DucklakeResult};

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

pub type SchemaViewMut<'a> = SchemaView<'a, &'a mut Catalog>;

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

impl<'a, C: Deref<Target = Catalog>> SchemaView<'a, C> {
    fn new(catalog: C, schema_ref: SchemaRef) -> Self {
        Self {
            catalog,
            arena_idx: schema_ref.0,
            _marker: std::marker::PhantomData,
        }
    }
}

impl Catalog {
    pub fn list_schemas(&self) -> Vec<SchemaView<'_>> {
        self.schemas
            .values()
            .map(|arena_idx| SchemaView::new(self, (*arena_idx).into()))
            .collect()
    }

    pub fn schema<R: TryIntoRef<SchemaRef>>(
        &self,
        schema_ref: R,
    ) -> Result<SchemaView<'_>, R::Error> {
        let schema_ref = schema_ref.try_into_ref(self)?;
        Ok(SchemaView::new(self, schema_ref))
    }

    pub fn schema_mut<R: TryIntoRef<SchemaRef>>(
        &mut self,
        schema_ref: R,
    ) -> Result<SchemaViewMut<'_>, R::Error> {
        let schema_ref = schema_ref.try_into_ref(self)?;
        Ok(SchemaViewMut::new(self, schema_ref))
    }
}

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

impl<S: AsRef<str> + ?Sized> TryIntoRef<SchemaRef> for &S {
    type Error = DucklakeError;

    fn try_into_ref(self, catalog: &Catalog) -> Result<SchemaRef, Self::Error> {
        let idx = *catalog
            .schemas
            .get(self.as_ref())
            .ok_or(DucklakeError::schema_not_found(self.as_ref()))?;
        Ok(idx.into())
    }
}

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

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

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

impl<'a, C: Deref<Target = Catalog>> SchemaView<'a, C> {
    pub(in crate::catalog) fn inner(&self) -> &CatalogSchema {
        self.catalog.schema_arena.get(self.arena_idx)
    }
}

impl<'a> SchemaViewMut<'a> {
    pub(in crate::catalog) fn inner_mut(&mut self) -> &mut CatalogSchema {
        self.catalog.schema_arena.get_mut(self.arena_idx)
    }
}

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

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

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

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

    pub fn list_tables(&self) -> Vec<super::TableView<'_>> {
        let catalog: &Catalog = &self.catalog;
        self.inner()
            .tables
            .values()
            .map(|arena_idx| super::TableView::new(catalog, (*arena_idx).into()))
            .collect()
    }
}

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

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

    pub fn delete(&mut self) -> DucklakeResult<()> {
        let schema = self.inner_mut();
        if !schema.tables.is_empty() {
            return Err(DucklakeError::InvalidChanges(format!(
                "cannot delete schema {} which is not empty",
                schema.name
            )));
        }
        let name = schema.name.clone();
        self.catalog.schemas.remove(&name);
        Ok(())
    }
}