aboutsummaryrefslogtreecommitdiff
path: root/database/src/lib.rs
blob: 263c2fcb611be242c3ca22b211e10afc4bb79889 (plain)
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
/*
    This file is part of jellything (https://codeberg.org/metamuffin/jellything)
    which is licensed under the GNU Affero General Public License (version 3); see /COPYING.
    Copyright (C) 2026 metamuffin <metamuffin.org>
*/
#![feature(phantom_variance_markers)]
pub mod helper;
pub mod kv;
pub mod query_syntax;
#[cfg(test)]
pub mod test_shared;

use anyhow::Result;
use jellyobject::{Object, Path, Value};

pub type RowNum = u64;
pub type RowIter = Box<dyn Iterator<Item = Result<(RowNum, Vec<u8>)>>>;

pub trait Database: Send + Sync {
    fn transaction(&self, f: &mut dyn FnMut(&mut dyn Transaction) -> Result<()>) -> Result<()>;
}

pub trait Transaction {
    fn insert(&mut self, entry: Box<Object>) -> Result<RowNum>;
    fn remove(&mut self, row: RowNum) -> Result<()>;
    fn update(&mut self, row: RowNum, entry: Box<Object>) -> Result<()>;
    fn get(&self, row: RowNum) -> Result<Option<Box<Object>>>;
    fn query<'a>(
        &'a mut self,
        query: Query,
    ) -> Result<Box<dyn Iterator<Item = Result<(RowNum, Vec<u8>)>> + 'a>>;
    fn query_single(&mut self, query: Query) -> Result<Option<RowNum>>;
    fn count(&mut self, query: Query) -> Result<u64>;
    fn debug_info(&self) -> Result<String>;
}

#[derive(Debug, Default, Clone, PartialEq)]
pub struct Query<'a> {
    pub continuation: Option<Vec<u8>>,
    pub filter: Filter<'a>,
    pub sort: Sort,
}

#[derive(Debug, Default, Clone, PartialEq)]
pub enum Sort {
    #[default]
    None,
    Random(u64),
    Value(ValueSort),
    TextSearch(Path, String),
}

#[derive(Debug, Clone, PartialEq)]
pub struct ValueSort {
    pub order: SortOrder,
    pub path: Path,
    pub multi: MultiBehaviour,
    pub offset: Option<Vec<u8>>,
}

#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
pub enum MultiBehaviour {
    First,
    ForEach,
    Max,
    Min,
    Count,
}

#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
pub enum SortOrder {
    Ascending,
    Descending,
}

#[derive(Debug, Clone, Default, PartialEq)]
pub enum Filter<'a> {
    #[default]
    True,
    All(Vec<Filter<'a>>),
    Any(Vec<Filter<'a>>),
    Match(Path, Value<'a>),
    Has(Path),
}