Skip to main content

tank_core/
join.rs

1use crate::{
2    Dataset, DynQuery, Expression, TableRef,
3    writer::{Context, SqlWriter},
4};
5use proc_macro2::{TokenStream, TokenTree};
6use quote::{ToTokens, TokenStreamExt, quote};
7use syn::{
8    Ident,
9    parse::{Parse, ParseStream},
10};
11
12/// Binary join with optional ON predicate.
13#[derive(Debug)]
14pub struct Join<L: Dataset, R: Dataset, E: Expression> {
15    /// Join kind.
16    pub join: JoinType,
17    /// Left-hand data set.
18    pub lhs: L,
19    /// Right-hand data set.
20    pub rhs: R,
21    /// Optional ON expression.
22    pub on: Option<E>,
23}
24
25/// SQL join variants.
26#[derive(Default, Clone, Copy, Debug)]
27pub enum JoinType {
28    /// Plain `JOIN` (backend default semantics, often INNER).
29    #[default]
30    Default,
31    Inner,
32    Outer,
33    Left,
34    Right,
35    Cross,
36    Natural,
37}
38
39impl<L: Dataset, R: Dataset, E: Expression> Dataset for Join<L, R, E> {
40    fn qualified_columns() -> bool
41    where
42        Self: Sized,
43    {
44        true
45    }
46    fn write_query(&self, writer: &dyn SqlWriter, context: &mut Context, out: &mut DynQuery) {
47        writer.write_join(
48            context,
49            out,
50            &Join {
51                join: self.join,
52                lhs: &self.lhs,
53                rhs: &self.rhs,
54                on: self.on.as_ref().map(|v| v as &dyn Expression),
55            },
56        );
57    }
58
59    fn table_ref(&self) -> TableRef {
60        let mut result = self.lhs.table_ref();
61        let other = self.rhs.table_ref();
62        result.name = Default::default();
63        if result.schema != other.schema {
64            result.schema = Default::default();
65        }
66        result.alias = Default::default();
67        result
68    }
69}
70
71impl Parse for JoinType {
72    fn parse(input: ParseStream) -> syn::Result<Self> {
73        let tokens = input.cursor().token_stream().into_iter().map(|t| match t {
74            TokenTree::Ident(ident) => ident.to_string(),
75            _ => "".to_string(),
76        });
77        let patterns: &[(&[&str], JoinType)] = &[
78            (&["JOIN"], JoinType::Default),
79            (&["INNER", "JOIN"], JoinType::Inner),
80            (&["FULL", "OUTER", "JOIN"], JoinType::Outer),
81            (&["OUTER", "JOIN"], JoinType::Outer),
82            (&["LEFT", "OUTER", "JOIN"], JoinType::Left),
83            (&["LEFT", "JOIN"], JoinType::Left),
84            (&["RIGHT", "OUTER", "JOIN"], JoinType::Right),
85            (&["RIGHT", "JOIN"], JoinType::Right),
86            (&["CROSS", "JOIN"], JoinType::Cross),
87            (&["CROSS"], JoinType::Cross),
88            (&["NATURAL", "JOIN"], JoinType::Natural),
89        ];
90        for (keywords, join_type) in patterns {
91            let it = tokens.clone().take(keywords.len());
92            if it.eq(keywords.iter().copied()) {
93                for _ in 0..keywords.len() {
94                    input.parse::<Ident>().expect(&format!(
95                        "Unexpected error, the input should contain {:?} as next Ident tokens at this point",
96                        keywords
97                    ));
98                }
99                return Ok(*join_type);
100            }
101        }
102        Err(syn::Error::new(input.span(), "Not a join keyword"))
103    }
104}
105
106impl ToTokens for JoinType {
107    fn to_tokens(&self, tokens: &mut TokenStream) {
108        tokens.append_all(match self {
109            JoinType::Default => quote! { ::tank::JoinType::Default },
110            JoinType::Inner => quote! { ::tank::JoinType::Inner },
111            JoinType::Outer => quote! { ::tank::JoinType::Outer },
112            JoinType::Left => quote! { ::tank::JoinType::Left },
113            JoinType::Right => quote! { ::tank::JoinType::Right },
114            JoinType::Cross => quote! { ::tank::JoinType::Cross },
115            JoinType::Natural => quote! { ::tank::JoinType::Natural },
116        });
117    }
118}