vantage-surrealdb 0.5.9

Vantage extension for SurrealDB
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

use crate::identifier::Identifier;
use crate::{AnySurrealType, Expr};
use vantage_expressions::ExpressiveOr;
use vantage_expressions::result::QueryResult;

use super::SurrealSelect;
use super::select_field::SelectField;
use super::select_target::SelectTarget;
use vantage_core::IntoVec;
use vantage_expressions::{Expressive, Order};

impl SurrealSelect {
    /// Creates a new SELECT query builder
    pub fn new() -> Self {
        Self::default()
    }

    /// Sets the fields for the SELECT clause
    pub fn fields(mut self, fields: Vec<SelectField>) -> Self {
        self.fields = fields;
        self
    }
}

impl<T: QueryResult> SurrealSelect<T> {
    pub fn without_fields(mut self) -> Self {
        self.fields = vec![];
        self
    }

    pub fn with_value(mut self) -> Self {
        self.single_value = true;
        self
    }

    pub fn with_only(mut self) -> Self {
        self.from_only = true;
        self
    }

    pub fn with_expression(mut self, expression: Expr, alias: Option<String>) -> Self {
        let mut field = SelectField::new(expression);
        if let Some(alias) = alias {
            field = field.with_alias(alias);
        }
        self.fields.push(field);
        self
    }

    pub fn field(mut self, field: impl ExpressiveOr<AnySurrealType, Identifier>) -> Self {
        self.fields.push(SelectField::new(field.field_expr()));
        self
    }

    pub fn with_where(mut self, condition: impl Expressive<AnySurrealType>) -> Self {
        self.where_conditions.push(condition.expr());
        self
    }

    pub fn with_order_by(
        mut self,
        field: impl ExpressiveOr<AnySurrealType, Identifier>,
        order: Order,
    ) -> Self {
        self.order_by.push((field.field_expr(), order.ascending));
        self
    }

    pub fn with_group_by(mut self, field: impl ExpressiveOr<AnySurrealType, Identifier>) -> Self {
        self.group_by.push(field.field_expr());
        self
    }

    /// `GROUP ALL` — aggregate the entire result into a single row.
    pub fn with_group_all(mut self) -> Self {
        self.group_all = true;
        self
    }

    /// `SPLIT field` — unnest an array field into one row per element.
    pub fn with_split(mut self, field: impl ExpressiveOr<AnySurrealType, Identifier>) -> Self {
        self.split.push(field.field_expr());
        self
    }

    pub fn with_limit(mut self, limit: i64) -> Self {
        self.limit = Some(limit);
        self
    }

    pub fn with_skip(mut self, skip: i64) -> Self {
        self.skip = Some(skip);
        self
    }

    pub fn with_distinct(mut self) -> Self {
        self.distinct = true;
        self
    }

    /// Adds targets to the FROM clause
    pub fn add_from(&mut self, targets: impl IntoVec<SelectTarget>) {
        self.from.extend(targets.into_vec());
    }

    /// Builder-style FROM clause
    pub fn from(mut self, targets: impl IntoVec<SelectTarget>) -> Self {
        self.add_from(targets);
        self
    }
}