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
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you 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 crate::error::{_plan_datafusion_err, _plan_err};
use crate::metadata::{check_metadata_with_storage_equal, ScalarAndMetadata};
use crate::{Result, ScalarValue};
use arrow::datatypes::{DataType, Field, FieldRef};
use std::collections::HashMap;
/// The parameter value corresponding to the placeholder
#[derive(Debug, Clone)]
pub enum ParamValues {
/// For positional query parameters, like `SELECT * FROM test WHERE a > $1 AND b = $2`
List(Vec<ScalarAndMetadata>),
/// For named query parameters, like `SELECT * FROM test WHERE a > $foo AND b = $goo`
Map(HashMap<String, ScalarAndMetadata>),
}
impl ParamValues {
/// Verify parameter list length and DataType
///
/// Use [`ParamValues::verify_fields`] to ensure field metadata is considered when
/// computing type equality.
#[deprecated(since = "51.0.0", note = "Use verify_fields instead")]
pub fn verify(&self, expect: &[DataType]) -> Result<()> {
// make dummy Fields
let expect = expect
.iter()
.map(|dt| Field::new("", dt.clone(), true).into())
.collect::<Vec<_>>();
self.verify_fields(&expect)
}
/// Verify parameter list length and type
pub fn verify_fields(&self, expect: &[FieldRef]) -> Result<()> {
match self {
ParamValues::List(list) => {
// Verify if the number of params matches the number of values
if expect.len() != list.len() {
return _plan_err!(
"Expected {} parameters, got {}",
expect.len(),
list.len()
);
}
// Verify if the types of the params matches the types of the values
let iter = expect.iter().zip(list.iter());
for (i, (param_type, lit)) in iter.enumerate() {
check_metadata_with_storage_equal(
(
&lit.value.data_type(),
lit.metadata.as_ref().map(|m| m.to_hashmap()).as_ref(),
),
(param_type.data_type(), Some(param_type.metadata())),
"parameter",
&format!(" at index {i}"),
)?;
}
Ok(())
}
ParamValues::Map(_) => {
// If it is a named query, variables can be reused,
// but the lengths are not necessarily equal
Ok(())
}
}
}
pub fn get_placeholders_with_values(&self, id: &str) -> Result<ScalarAndMetadata> {
match self {
ParamValues::List(list) => {
if id.is_empty() {
return _plan_err!("Empty placeholder id");
}
// convert id (in format $1, $2, ..) to idx (0, 1, ..)
let idx = id[1..]
.parse::<usize>()
.map_err(|e| {
_plan_datafusion_err!("Failed to parse placeholder id: {e}")
})?
.checked_sub(1);
// value at the idx-th position in param_values should be the value for the placeholder
let value = idx.and_then(|idx| list.get(idx)).ok_or_else(|| {
_plan_datafusion_err!("No value found for placeholder with id {id}")
})?;
Ok(value.clone())
}
ParamValues::Map(map) => {
// convert name (in format $a, $b, ..) to mapped values (a, b, ..)
let name = &id[1..];
// value at the name position in param_values should be the value for the placeholder
let value = map.get(name).ok_or_else(|| {
_plan_datafusion_err!("No value found for placeholder with name {id}")
})?;
Ok(value.clone())
}
}
}
}
impl From<Vec<ScalarValue>> for ParamValues {
fn from(value: Vec<ScalarValue>) -> Self {
Self::List(value.into_iter().map(ScalarAndMetadata::from).collect())
}
}
impl<K> From<Vec<(K, ScalarValue)>> for ParamValues
where
K: Into<String>,
{
fn from(value: Vec<(K, ScalarValue)>) -> Self {
let value: HashMap<String, ScalarAndMetadata> = value
.into_iter()
.map(|(k, v)| (k.into(), ScalarAndMetadata::from(v)))
.collect();
Self::Map(value)
}
}
impl<K> From<HashMap<K, ScalarValue>> for ParamValues
where
K: Into<String>,
{
fn from(value: HashMap<K, ScalarValue>) -> Self {
let value: HashMap<String, ScalarAndMetadata> = value
.into_iter()
.map(|(k, v)| (k.into(), ScalarAndMetadata::from(v)))
.collect();
Self::Map(value)
}
}