sea-query 1.0.0

🔱 A dynamic query builder for MySQL, Postgres and SQLite
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

use std::borrow::Cow;

use crate::extension::postgres::json_fn::{QuotesClause, WrapperClause};
use crate::*;

use super::types::{JsonTableColumn, OnClause};

/// Column definition in a `JSON_TABLE` `COLUMNS` clause.
#[derive(Debug, Clone)]
pub struct Column {
    name: Cow<'static, str>,
    column_type: TypeRef,
    format_json: bool,
    encoding_utf8: bool,
    path: Option<Cow<'static, str>>,
    wrapper: Option<WrapperClause>,
    quotes: Option<QuotesClause>,
    on_empty: Option<OnClause>,
    on_error: Option<OnClause>,
}

impl Column {
    pub fn new(name: impl Into<Cow<'static, str>>, column_type: impl Into<TypeRef>) -> Self {
        Self {
            name: name.into(),
            column_type: column_type.into(),
            format_json: false,
            encoding_utf8: false,
            path: None,
            wrapper: None,
            quotes: None,
            on_empty: None,
            on_error: None,
        }
    }

    /// Set `FORMAT JSON`.
    pub fn format_json(mut self) -> Self {
        self.format_json = true;
        self
    }

    /// Set `ENCODING UTF8`.
    pub fn encoding_utf8(mut self) -> Self {
        self.format_json = true;
        self.encoding_utf8 = true;
        self
    }

    /// Set `PATH`.
    pub fn path(mut self, path: impl Into<Cow<'static, str>>) -> Self {
        self.path = Some(path.into());
        self
    }

    /// Set `WRAPPER`.
    pub fn wrapper(mut self, wrapper: impl Into<WrapperClause>) -> Self {
        self.wrapper = Some(wrapper.into());
        self
    }

    /// Set `QUOTES`.
    pub fn quotes(mut self, quotes: impl Into<QuotesClause>) -> Self {
        self.quotes = Some(quotes.into());
        self
    }

    pub fn error_on_empty(mut self) -> Self {
        self.on_empty = Some(OnClause::Error);
        self
    }

    pub fn null_on_empty(mut self) -> Self {
        self.on_empty = Some(OnClause::Null);
        self
    }

    pub fn empty_array_on_empty(mut self) -> Self {
        self.on_empty = Some(OnClause::EmptyArray);
        self
    }

    pub fn empty_object_on_empty(mut self) -> Self {
        self.on_empty = Some(OnClause::EmptyObject);
        self
    }

    pub fn default_on_empty(mut self, expr: impl Into<Expr>) -> Self {
        self.on_empty = Some(OnClause::Default(expr.into()));
        self
    }

    pub fn error_on_error(mut self) -> Self {
        self.on_error = Some(OnClause::Error);
        self
    }

    pub fn null_on_error(mut self) -> Self {
        self.on_error = Some(OnClause::Null);
        self
    }

    pub fn empty_array_on_error(mut self) -> Self {
        self.on_error = Some(OnClause::EmptyArray);
        self
    }

    pub fn empty_object_on_error(mut self) -> Self {
        self.on_error = Some(OnClause::EmptyObject);
        self
    }

    pub fn default_on_error(mut self, expr: impl Into<Expr>) -> Self {
        self.on_error = Some(OnClause::Default(expr.into()));
        self
    }

    pub(super) fn into_column(self) -> JsonTableColumn {
        JsonTableColumn::Regular {
            name: self.name,
            column_type: self.column_type,
            format_json: self.format_json,
            encoding_utf8: self.encoding_utf8,
            path: self.path,
            wrapper: self.wrapper,
            quotes: self.quotes,
            on_empty: self.on_empty,
            on_error: self.on_error,
        }
    }
}