risingwave_frontend/binder/expr/
column.rs

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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
// Copyright 2024 RisingWave Labs
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use risingwave_common::types::DataType;
use risingwave_sqlparser::ast::Ident;

use crate::binder::{Binder, Clause};
use crate::error::{ErrorCode, Result};
use crate::expr::{CorrelatedInputRef, ExprImpl, ExprType, FunctionCall, InputRef, Literal};
use crate::handler::create_sql_function::SQL_UDF_PATTERN;

impl Binder {
    pub fn bind_column(&mut self, idents: &[Ident]) -> Result<ExprImpl> {
        // TODO: check quote style of `ident`.
        let (_schema_name, table_name, column_name) = match idents {
            [column] => (None, None, column.real_value()),
            [table, column] => (None, Some(table.real_value()), column.real_value()),
            [schema, table, column] => (
                Some(schema.real_value()),
                Some(table.real_value()),
                column.real_value(),
            ),
            _ => {
                return Err(
                    ErrorCode::InternalError(format!("Too many idents: {:?}", idents)).into(),
                )
            }
        };

        // Special check for sql udf
        // Note: The check in `bind_column` is to inline the identifiers,
        // which, in the context of sql udf, will NOT be perceived as normal
        // columns, but the actual named input parameters.
        // Thus, we need to figure out if the current "column name" corresponds
        // to the name of the defined sql udf parameters stored in `udf_context`.
        // If so, we will treat this bind as an special bind, the actual expression
        // stored in `udf_context` will then be bound instead of binding the non-existing column.
        if self.udf_context.global_count() != 0 {
            if let Some(expr) = self.udf_context.get_expr(&column_name) {
                return Ok(expr.clone());
            } else {
                // The reason that we directly return error here,
                // is because during a valid sql udf binding,
                // there will not exist any column identifiers
                // And invalid cases should already be caught
                // during semantic check phase
                // Note: the error message here also help with hint display
                // when invalid definition occurs at sql udf creation time
                return Err(ErrorCode::BindError(format!(
                    "{SQL_UDF_PATTERN} failed to find named parameter {column_name}"
                ))
                .into());
            }
        }

        match self
            .context
            .get_column_binding_indices(&table_name, &column_name)
        {
            Ok(mut indices) => {
                match indices.len() {
                    0 => unreachable!(),
                    1 => {
                        let index = indices[0];
                        let column = &self.context.columns[index];
                        return Ok(
                            InputRef::new(column.index, column.field.data_type.clone()).into()
                        );
                    }
                    _ => {
                        indices.sort(); // make sure we have a consistent result
                        let inputs = indices
                            .iter()
                            .map(|index| {
                                let column = &self.context.columns[*index];
                                InputRef::new(column.index, column.field.data_type.clone()).into()
                            })
                            .collect::<Vec<_>>();
                        return Ok(FunctionCall::new(ExprType::Coalesce, inputs)?.into());
                    }
                }
            }
            Err(e) => {
                // If the error message is not that the column is not found, throw the error
                if let ErrorCode::ItemNotFound(_) = e {
                } else {
                    return Err(e.into());
                }
            }
        }

        // Try to find a correlated column in `upper_contexts`, starting from the innermost context.
        let mut err = ErrorCode::ItemNotFound(format!("Invalid column: {}", column_name));

        for (i, lateral_context) in self.lateral_contexts.iter().rev().enumerate() {
            if lateral_context.is_visible {
                let context = &lateral_context.context;
                if matches!(context.clause, Some(Clause::Insert)) {
                    continue;
                }
                // input ref from lateral context `depth` starts from 1.
                let depth = i + 1;
                match context.get_column_binding_index(&table_name, &column_name) {
                    Ok(index) => {
                        let column = &context.columns[index];
                        return Ok(CorrelatedInputRef::new(
                            column.index,
                            column.field.data_type.clone(),
                            depth,
                        )
                        .into());
                    }
                    Err(e) => {
                        err = e;
                    }
                }
            }
        }

        for (i, (context, lateral_contexts)) in
            self.upper_subquery_contexts.iter().rev().enumerate()
        {
            if matches!(context.clause, Some(Clause::Insert)) {
                continue;
            }
            // `depth` starts from 1.
            let depth = i + 1;
            match context.get_column_binding_index(&table_name, &column_name) {
                Ok(index) => {
                    let column = &context.columns[index];
                    return Ok(CorrelatedInputRef::new(
                        column.index,
                        column.field.data_type.clone(),
                        depth,
                    )
                    .into());
                }
                Err(e) => {
                    err = e;
                }
            }

            for (j, lateral_context) in lateral_contexts.iter().rev().enumerate() {
                if lateral_context.is_visible {
                    let context = &lateral_context.context;
                    if matches!(context.clause, Some(Clause::Insert)) {
                        continue;
                    }
                    // correlated input ref from lateral context `depth` starts from 1.
                    let depth = i + j + 1;
                    match context.get_column_binding_index(&table_name, &column_name) {
                        Ok(index) => {
                            let column = &context.columns[index];
                            return Ok(CorrelatedInputRef::new(
                                column.index,
                                column.field.data_type.clone(),
                                depth,
                            )
                            .into());
                        }
                        Err(e) => {
                            err = e;
                        }
                    }
                }
            }
        }
        // `CTID` is a system column in postgres.
        // https://www.postgresql.org/docs/current/ddl-system-columns.html
        //
        // We return an empty string here to support some tools such as DataGrip.
        //
        // FIXME: The type of `CTID` should be `tid`.
        // FIXME: The `CTID` column should be unique, so literal may break something.
        // FIXME: At least we should add a notice here.
        if let ErrorCode::ItemNotFound(_) = err
            && column_name == "ctid"
        {
            return Ok(Literal::new(Some("".into()), DataType::Varchar).into());
        }
        Err(err.into())
    }
}