hamelin_lib 0.9.3

Core library for Hamelin query language
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
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
//! Membership operators: In, NotIn for arrays, maps, ranges, tuples, timestamps, intervals

use std::any::TypeId;
use std::iter::once;

use anyhow::bail;

use crate::func::def::{FunctionDef, ParameterBindingProvider, Parameters};
use crate::func::utils::must_be_same_type;
use crate::operator::Operator;
use crate::types::matcher::{
    AnyMatcher, ArrayMatcher, ExactMatcher, IntervalMatcher, MapMatcher, NumericMatcher, OrMatcher,
    RangeMatcher, UnboundedTupleMatcher,
};
use crate::types::range::Range;
use crate::types::{Type, BOOLEAN, CALENDAR_INTERVAL, INTERVAL, TIMESTAMP};

/// IN operator for array membership: `left IN right` where right is an array.
#[derive(Default, Clone)]
pub struct InArray;

impl FunctionDef for InArray {
    fn name(&self) -> &'static str {
        Operator::In.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", AnyMatcher::default())
            .with("right", ArrayMatcher::default())
    }

    fn return_type(&self, bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        let left = bindings.get_by_index(0)?.typ();
        let inner = match bindings.get_by_index(1)?.typ() {
            Type::Array(a) => a.element_type.as_ref().clone(),
            _ => bail!("right should be an array, checked by matcher"),
        };

        must_be_same_type(vec![left, &inner].into_iter()).map(|_| BOOLEAN)
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// NOT IN operator for array membership: `left NOT IN right` where right is an array.
#[derive(Default, Clone)]
pub struct NotInArray;

impl FunctionDef for NotInArray {
    fn name(&self) -> &'static str {
        Operator::NotIn.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", AnyMatcher::default())
            .with("right", ArrayMatcher::default())
    }

    fn return_type(&self, bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        let left = bindings.get_by_index(0)?.typ();
        let inner = match bindings.get_by_index(1)?.typ() {
            Type::Array(a) => a.element_type.as_ref().clone(),
            _ => bail!("right should be an array, checked by matcher"),
        };

        must_be_same_type(vec![left, &inner].into_iter()).map(|_| BOOLEAN)
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// IN operator for map key membership: `left IN right` where right is a map.
#[derive(Default, Clone)]
pub struct InMap;

impl FunctionDef for InMap {
    fn name(&self) -> &'static str {
        Operator::In.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", AnyMatcher::default())
            .with("right", MapMatcher::default())
    }

    fn return_type(&self, bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        let left = bindings.get_by_index(0)?.typ();
        let key_type = match bindings.get_by_index(1)?.typ() {
            Type::Map(map) => map.key_type.as_ref().clone(),
            _ => bail!("right should be a map, checked by matcher"),
        };

        must_be_same_type(vec![left, &key_type].into_iter()).map(|_| BOOLEAN)
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// NOT IN operator for map key membership: `left NOT IN right` where right is a map.
#[derive(Default, Clone)]
pub struct NotInMap;

impl FunctionDef for NotInMap {
    fn name(&self) -> &'static str {
        Operator::NotIn.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", AnyMatcher::default())
            .with("right", MapMatcher::default())
    }

    fn return_type(&self, bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        let left = bindings.get_by_index(0)?.typ();
        let key_type = match bindings.get_by_index(1)?.typ() {
            Type::Map(map) => map.key_type.as_ref().clone(),
            _ => bail!("right should be a map, checked by matcher"),
        };

        must_be_same_type(vec![left, &key_type].into_iter()).map(|_| BOOLEAN)
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// Range operator for numeric types: `left..right` creates a numeric range.
#[derive(Default, Clone)]
pub struct NumericRange;

impl FunctionDef for NumericRange {
    fn name(&self) -> &'static str {
        Operator::Range.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", NumericMatcher::default())
            .with("right", NumericMatcher::default())
    }

    fn return_type(&self, bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        let left = bindings.get_by_index(0)?.typ().clone();
        let right = bindings.get_by_index(1)?.typ().clone();
        let inner = left.merge(right)?;
        Ok(Range::new(inner).into())
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// Range operator for timestamp/interval types: `left..right` creates a timestamp range.
#[derive(Default, Clone)]
pub struct TimestampRange;

impl FunctionDef for TimestampRange {
    fn name(&self) -> &'static str {
        Operator::Range.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with(
                "left",
                OrMatcher::default()
                    .with(ExactMatcher::of(INTERVAL))
                    .with(ExactMatcher::of(CALENDAR_INTERVAL))
                    .with(ExactMatcher::of(TIMESTAMP)),
            )
            .with(
                "right",
                OrMatcher::default()
                    .with(ExactMatcher::of(INTERVAL))
                    .with(ExactMatcher::of(CALENDAR_INTERVAL))
                    .with(ExactMatcher::of(TIMESTAMP)),
            )
    }

    fn return_type(&self, bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        let left = bindings.get_by_index(0)?.typ();
        let right = bindings.get_by_index(1)?.typ();

        if *left == TIMESTAMP || *right == TIMESTAMP {
            Ok(Range::new(TIMESTAMP).into())
        } else {
            must_be_same_type(vec![left, right].into_iter()).map(|inner| Range::new(inner).into())
        }
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// Inclusive range operator for numeric types: `left..=right` creates an inclusive numeric range.
#[derive(Default, Clone)]
pub struct NumericRangeInclusive;

impl FunctionDef for NumericRangeInclusive {
    fn name(&self) -> &'static str {
        Operator::RangeInclusive.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", NumericMatcher::default())
            .with("right", NumericMatcher::default())
    }

    fn return_type(&self, bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        let left = bindings.get_by_index(0)?.typ().clone();
        let right = bindings.get_by_index(1)?.typ().clone();
        let inner = left.merge(right)?;
        Ok(Type::RangeInclusive(Range::new(inner)))
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// Inclusive range operator for timestamp/interval types: `left..=right` creates an inclusive timestamp range.
#[derive(Default, Clone)]
pub struct TimestampRangeInclusive;

impl FunctionDef for TimestampRangeInclusive {
    fn name(&self) -> &'static str {
        Operator::RangeInclusive.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with(
                "left",
                OrMatcher::default()
                    .with(ExactMatcher::of(INTERVAL))
                    .with(ExactMatcher::of(CALENDAR_INTERVAL))
                    .with(ExactMatcher::of(TIMESTAMP)),
            )
            .with(
                "right",
                OrMatcher::default()
                    .with(ExactMatcher::of(INTERVAL))
                    .with(ExactMatcher::of(CALENDAR_INTERVAL))
                    .with(ExactMatcher::of(TIMESTAMP)),
            )
    }

    fn return_type(&self, bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        let left = bindings.get_by_index(0)?.typ();
        let right = bindings.get_by_index(1)?.typ();

        if *left == TIMESTAMP || *right == TIMESTAMP {
            Ok(Type::RangeInclusive(Range::new(TIMESTAMP)))
        } else {
            must_be_same_type(vec![left, right].into_iter())
                .map(|inner| Type::RangeInclusive(Range::new(inner)))
        }
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// IN operator for range membership: `left IN right` where right is a range.
#[derive(Default, Clone)]
pub struct InRange;

impl FunctionDef for InRange {
    fn name(&self) -> &'static str {
        Operator::In.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", AnyMatcher::default())
            .with("right", RangeMatcher::default())
    }

    fn return_type(&self, bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        let left = bindings.get_by_index(0)?.typ();
        let right = match bindings.get_by_index(1)?.typ() {
            Type::Range(range) | Type::RangeInclusive(range) => range.of.as_ref().clone(),
            _ => bail!("right should be a range, checked by matcher"),
        };
        match (left, &right) {
            (Type::Timestamp, Type::Interval) => Ok(BOOLEAN),
            (left, right) => must_be_same_type(vec![left, right].into_iter()).map(|_| BOOLEAN),
        }
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// NOT IN operator for range membership: `left NOT IN right` where right is a range.
#[derive(Default, Clone)]
pub struct NotInRange;

impl FunctionDef for NotInRange {
    fn name(&self) -> &'static str {
        Operator::NotIn.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", AnyMatcher::default())
            .with("right", RangeMatcher::default())
    }

    fn return_type(&self, bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        let left = bindings.get_by_index(0)?.typ();
        let right = match bindings.get_by_index(1)?.typ() {
            Type::Range(range) | Type::RangeInclusive(range) => range.of.as_ref().clone(),
            _ => bail!("right should be a range, checked by matcher"),
        };
        match (left, &right) {
            (Type::Timestamp, Type::Interval) => Ok(BOOLEAN),
            (left, right) => must_be_same_type(vec![left, right].into_iter()).map(|_| BOOLEAN),
        }
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// IN operator for timestamp in interval: `timestamp IN interval`.
#[derive(Default, Clone)]
pub struct InTimestampInterval;

impl FunctionDef for InTimestampInterval {
    fn name(&self) -> &'static str {
        Operator::In.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", ExactMatcher::of(TIMESTAMP))
            .with("right", IntervalMatcher::default())
    }

    fn return_type(&self, _bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        Ok(BOOLEAN)
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// NOT IN operator for timestamp in interval: `timestamp NOT IN interval`.
#[derive(Default, Clone)]
pub struct NotInTimestampInterval;

impl FunctionDef for NotInTimestampInterval {
    fn name(&self) -> &'static str {
        Operator::NotIn.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", ExactMatcher::of(TIMESTAMP))
            .with("right", IntervalMatcher::default())
    }

    fn return_type(&self, _bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        Ok(BOOLEAN)
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// IN operator for timestamp in timestamp (day): `timestamp IN timestamp`.
#[derive(Default, Clone)]
pub struct InTimestampTimestamp;

impl FunctionDef for InTimestampTimestamp {
    fn name(&self) -> &'static str {
        Operator::In.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", ExactMatcher::of(TIMESTAMP))
            .with("right", ExactMatcher::of(TIMESTAMP))
    }

    fn return_type(&self, _bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        Ok(BOOLEAN)
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// NOT IN operator for timestamp in timestamp (day): `timestamp NOT IN timestamp`.
#[derive(Default, Clone)]
pub struct NotInTimestampTimestamp;

impl FunctionDef for NotInTimestampTimestamp {
    fn name(&self) -> &'static str {
        Operator::NotIn.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", ExactMatcher::of(TIMESTAMP))
            .with("right", ExactMatcher::of(TIMESTAMP))
    }

    fn return_type(&self, _bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        Ok(BOOLEAN)
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// IN operator for tuple membership: `left IN (a, b, c)`.
#[derive(Default, Clone)]
pub struct InTuple;

impl FunctionDef for InTuple {
    fn name(&self) -> &'static str {
        Operator::In.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", AnyMatcher::default())
            .with("right", UnboundedTupleMatcher::default())
    }

    fn return_type(&self, bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        let left = bindings.get_by_index(0)?.typ();
        match bindings.get_by_index(1)?.typ() {
            Type::Tuple(tuple) => {
                if tuple.elements.is_empty() {
                    bail!("right should be a tuple with at least one element")
                }
                // Validate left and ALL tuple elements are type-compatible
                must_be_same_type(once(left).chain(tuple.elements.iter().map(|t| t.as_ref())))
                    .map(|_| BOOLEAN)
            }
            _ => bail!("right should be a tuple, checked by matcher"),
        }
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}

/// NOT IN operator for tuple membership: `left NOT IN (a, b, c)`.
#[derive(Default, Clone)]
pub struct NotInTuple;

impl FunctionDef for NotInTuple {
    fn name(&self) -> &'static str {
        Operator::NotIn.str()
    }

    fn parameters(&self) -> Parameters {
        Parameters::new()
            .with("left", AnyMatcher::default())
            .with("right", UnboundedTupleMatcher::default())
    }

    fn return_type(&self, bindings: &dyn ParameterBindingProvider) -> anyhow::Result<Type> {
        let left = bindings.get_by_index(0)?.typ();
        match bindings.get_by_index(1)?.typ() {
            Type::Tuple(tuple) => {
                if tuple.elements.is_empty() {
                    bail!("right should be a tuple with at least one element")
                }
                // Validate left and ALL tuple elements are type-compatible
                must_be_same_type(once(left).chain(tuple.elements.iter().map(|t| t.as_ref())))
                    .map(|_| BOOLEAN)
            }
            _ => bail!("right should be a tuple, checked by matcher"),
        }
    }

    fn type_id(&self) -> TypeId {
        TypeId::of::<Self>()
    }
}