uqa-sql 0.6.3

PostgreSQL-compatible SQL compiler built on libpg_query
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
//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! Read retained physical scalar bytes only when a SQL operation observes the value. Type inspection, copying and NULL tests do not invoke this decoder.

use crate::SQLError;
use uqa_core::{
    memory::{Produced, ProductionControl, ProductionVec},
    DatumValue, DecimalValue, Value,
};

mod arrays;
mod bit_string;
mod compression;
pub(crate) mod encoding;
mod fixed;
pub(in crate::expr) mod inline;
mod malformed;
mod records;

pub use arrays::ArrayShape;

/// Whether catalog-free constant evaluation could reach an admitted physical value.
pub fn contains_datum(value: &Value) -> bool {
    super::observations::any_nested_value(value, &mut |value| matches!(value, Value::Datum(_)))
}

/// Read only the actual tuple type of a value already selected as a composite by SQL analysis.
pub(in crate::expr) fn record_type_oid(
    datum: &DatumValue,
    control: &ProductionControl<'_>,
) -> Result<u32, SQLError> {
    let payload = payload(datum, control)?;
    word(payload.bytes().get(4..).unwrap_or_default())
        .ok_or_else(|| corrupt("invalid record header"))
}

/// Shape functions inspect only the detoasted array header, without resolving or observing its elements.
pub fn array_shape(
    datum: &DatumValue,
    control: &ProductionControl<'_>,
) -> Result<ArrayShape, SQLError> {
    control.check()?;
    let payload = payload(datum, control)?;
    arrays::ArrayShape::read(payload.bytes())
}

/// A polymorphic array operation selects the physical array header even when its declared input is an atomic catalog vector. Vector-specific output and scalar comparison checks belong to those operations, not this array observation.
pub(in crate::expr) fn read_array_input_with_catalog_and_control(
    datum: &DatumValue,
    catalog: Option<&dyn super::SQLValueCatalog>,
    control: &ProductionControl<'_>,
) -> Result<Produced<Value>, SQLError> {
    control.check()?;
    let payload = payload(datum, control)?;
    arrays::read(payload.bytes(), catalog, control)
}

#[cfg(test)]
mod tests;

pub fn type_name(datum: &DatumValue) -> &'static str {
    match datum.type_oid() {
        18 => "\"char\"",
        19 => "name",
        700 => "real",
        1042 => "character",
        1043 => "character varying",
        oid => crate::catalog::type_metadata::catalog_type_name(i64::from(oid)),
    }
}

pub fn read(datum: &DatumValue) -> Result<Value, SQLError> {
    read_with_catalog(datum, None)
}

/// Read an admitted physical value through the current statement's catalog, without invoking type input or domain checks.
pub fn read_with_catalog(
    datum: &DatumValue,
    engine: Option<&dyn super::EngineHook>,
) -> Result<Value, SQLError> {
    read_with_catalog_and_control(datum, engine, &ProductionControl::uncontrolled())
        .map(|value| value.into_uncontrolled().expect("ordinary datum read"))
}

/// Copy a selected constant field at planning time, detoasting variable-width storage without interpreting its scalar contents. Whole records remain deferred.
pub fn copy_constant_field(value: &Value, ty: &crate::ColumnType) -> Result<Value, SQLError> {
    copy_constant_field_with_control(value, ty, &ProductionControl::uncontrolled()).map(|value| {
        value
            .into_uncontrolled()
            .expect("ordinary constant field copy")
    })
}

/// Admit the selected field's detoasting workspace, physical destination and retained backing before allocation. Copying preserves bytes without interpreting scalar contents or reading other fields.
pub fn copy_constant_field_with_control(
    value: &Value,
    ty: &crate::ColumnType,
    control: &ProductionControl<'_>,
) -> Result<Produced<Value>, SQLError> {
    control.check()?;
    let Value::Datum(datum) = value else {
        return control.copy_value(value).map_err(Into::into);
    };
    if crate::catalog::type_metadata::pg_type_len(ty) != -1 {
        return control.copy_value(value).map_err(Into::into);
    }
    let payload = payload(datum, control)?;
    let size = payload
        .bytes()
        .len()
        .checked_add(4)
        .and_then(|size| u32::try_from(size).ok())
        .and_then(|size| size.checked_mul(4))
        .ok_or_else(|| corrupt("invalid datum length"))?;
    let mut bytes = ProductionVec::new(*control);
    bytes.reserve(payload.bytes().len() + 4)?;
    bytes.extend_from_slice(&size.to_le_bytes())?;
    bytes.extend_from_slice(payload.bytes())?;
    let (datum, memory) =
        DatumValue::with_control(datum.type_oid(), 0, bytes.finish()?, control)?.into_parts();
    Ok(control.finish(Value::Datum(datum), memory)?)
}

pub fn read_with_control(
    datum: &DatumValue,
    control: &ProductionControl<'_>,
) -> Result<Produced<Value>, SQLError> {
    read_with_catalog_and_control(datum, None, control)
}

/// Select one field of a resolved composite. Unreached fields remain unread, including their variable-width headers; binding and planning need only the tuple descriptor catalog.
pub fn read_composite_field_with_control(
    datum: &DatumValue,
    field: &str,
    catalog: Option<&dyn super::composites::CompositeTypeCatalog>,
    control: &ProductionControl<'_>,
) -> Result<Produced<Value>, SQLError> {
    let payload = payload(datum, control)?;
    records::read_with_lookup(payload.bytes(), Some(field), control, |oid| {
        super::composites::descriptor(catalog, oid).map(Some)
    })
}

pub(in crate::expr) fn read_composite_field_in_descriptor(
    datum: &DatumValue,
    field: &str,
    descriptor: &std::sync::Arc<super::composites::CompositeTypeDescriptor>,
    control: &ProductionControl<'_>,
) -> Result<Produced<Value>, SQLError> {
    let payload = payload(datum, control)?;
    records::read_with_lookup(payload.bytes(), Some(field), control, |_| {
        Ok(Some(descriptor.clone()))
    })
}

pub(super) fn range_comparison(
    datum: &DatumValue,
    ty: &crate::ColumnType,
    catalog: Option<&dyn super::SQLValueCatalog>,
    control: &ProductionControl<'_>,
) -> Result<super::range::RangeComparisonValue, SQLError> {
    let payload = payload(datum, control)?;
    super::range::datum::comparison(payload.bytes(), ty, catalog, control)
}

/// A selected range output function uses its declared class even after the physical type has been dropped from the catalog.
pub(crate) fn read_range_with_type(
    datum: &DatumValue,
    ty: &crate::ColumnType,
    catalog: Option<&dyn super::SQLValueCatalog>,
    control: &ProductionControl<'_>,
) -> Result<Produced<Value>, SQLError> {
    let payload = payload(datum, control)?;
    super::range::datum::read(payload.bytes(), ty, catalog, control)
}

/// Preserve the caller's output allowance and cancellation boundary during catalog-dependent physical reads.
pub fn read_with_catalog_and_control(
    datum: &DatumValue,
    engine: Option<&dyn super::EngineHook>,
    control: &ProductionControl<'_>,
) -> Result<Produced<Value>, SQLError> {
    let catalog = engine.map(super::value_catalog::EngineValueCatalog);
    read_with_value_catalog_and_control(
        datum,
        catalog
            .as_ref()
            .map(|catalog| catalog as &dyn super::SQLValueCatalog),
        control,
    )
}

/// Decode a reached value through the same borrowed catalog used by SQL comparison, hashing and output.
pub fn read_with_value_catalog_and_control(
    datum: &DatumValue,
    catalog: Option<&dyn super::SQLValueCatalog>,
    control: &ProductionControl<'_>,
) -> Result<Produced<Value>, SQLError> {
    control.check()?;
    if let Some(value) = fixed::read(datum, control) {
        return value;
    }
    if crate::catalog::type_metadata::builtin_scalar_type(datum.type_oid()).is_none()
        && crate::catalog::type_metadata::builtin_array_element(datum.type_oid()).is_none()
    {
        if let Some(enums) = catalog {
            if enums.enum_type_labels(datum.type_oid())?.is_some() {
                let oid = enum_label_oid(datum)?;
                return Ok(
                    control.retain_external_value(super::enums::enum_value_from_oid(
                        Some(enums),
                        oid,
                    )?)?,
                );
            }
        }
    }
    let payload = payload(datum, control)?;
    read_payload(datum.type_oid(), payload.bytes(), catalog, control)
}

/// Inspect a named row's live field NULL flags without reading its field payloads. Non-composite datums retain scalar NULL semantics and are not decoded.
pub fn record_null_test_with_control(
    datum: &DatumValue,
    negated: bool,
    catalog: Option<&dyn super::SQLValueCatalog>,
    control: &ProductionControl<'_>,
) -> Result<Option<bool>, SQLError> {
    control.check()?;
    let Some(catalog) = catalog else {
        return Ok(None);
    };
    let Some(descriptor) = catalog.value_composite_type(datum.type_oid())? else {
        return Ok(None);
    };
    let payload = payload(datum, control)?;
    records::null_test(payload.bytes(), descriptor, catalog, negated, control).map(Some)
}

/// Read the fixed-width OID after the caller has selected an enum operation.
/// Label existence belongs to the particular consuming operation, not this read.
pub(crate) fn enum_label_oid(datum: &DatumValue) -> Result<u32, SQLError> {
    word(
        datum
            .bytes()
            .get(datum.offset() as usize..)
            .unwrap_or_default(),
    )
    .ok_or_else(|| corrupt("invalid datum length"))
}

pub(super) fn compare_jsonb_with_control(
    left: &Value,
    right: &Value,
    control: &ProductionControl<'_>,
) -> Result<Option<std::cmp::Ordering>, SQLError> {
    let physical = |value: &Value| matches!(value, Value::Datum(datum) if datum.type_oid() == 3802);
    let jsonb = |value: &Value| physical(value) || matches!(value, Value::JsonB(_));
    if !(jsonb(left) && jsonb(right) && (physical(left) || physical(right))) {
        return Ok(None);
    }
    let left_bytes = match left {
        Value::Datum(datum) => Some(payload(datum, control)?),
        _ => None,
    };
    let right_bytes = match right {
        Value::Datum(datum) => Some(payload(datum, control)?),
        _ => None,
    };
    let left = match left {
        Value::JsonB(text) => super::json::JsonbInput::Text(text),
        _ => super::json::JsonbInput::Bytes(left_bytes.as_ref().expect("physical JSONB").bytes()),
    };
    let right = match right {
        Value::JsonB(text) => super::json::JsonbInput::Text(text),
        _ => super::json::JsonbInput::Bytes(right_bytes.as_ref().expect("physical JSONB").bytes()),
    };
    super::json::compare_jsonb_datums_with_control(left, right, control).map(Some)
}

fn read_payload(
    oid: u32,
    bytes: &[u8],
    catalog: Option<&dyn super::SQLValueCatalog>,
    control: &ProductionControl<'_>,
) -> Result<Produced<Value>, SQLError> {
    if crate::catalog::type_metadata::builtin_array_element(oid).is_some() {
        return arrays::read(bytes, catalog, control);
    }
    if let Some(ty @ (crate::ColumnType::Range(_) | crate::ColumnType::Multirange(_))) =
        crate::catalog::type_metadata::builtin_scalar_type(oid)
    {
        return super::range::datum::read(bytes, ty, catalog, control);
    }
    if crate::catalog::type_metadata::builtin_scalar_type(oid).is_none() {
        if let Some(descriptor) = catalog
            .map(|catalog| catalog.value_range_type(oid))
            .transpose()?
            .flatten()
        {
            if oid != descriptor.range_oid && oid != descriptor.multirange_oid {
                return Err(corrupt("inconsistent range type descriptor"));
            }
            return super::range::datum::read_class(
                bytes,
                oid == descriptor.multirange_oid,
                catalog,
                control,
            );
        }
        if let Some(ty) = catalog
            .map(|catalog| catalog.value_type_by_oid(oid))
            .transpose()?
            .flatten()
        {
            match ty {
                crate::ColumnType::DeclaredRange(_) | crate::ColumnType::DeclaredMultirange(_) => {
                    return super::range::datum::read(bytes, &ty, catalog, control);
                }
                crate::ColumnType::Array(_) => return arrays::read(bytes, catalog, control),
                crate::ColumnType::Composite(_) => return records::read(bytes, catalog, control),
                crate::ColumnType::Domain { base, .. } => {
                    return read_payload(
                        crate::catalog::type_metadata::pg_type_oid(&base) as u32,
                        bytes,
                        catalog,
                        control,
                    );
                }
                _ => {}
            }
        }
    }
    match oid {
        22 => arrays::read_legacy_vector(bytes, uqa_core::LegacyVectorKind::SmallInteger, control),
        30 => arrays::read_legacy_vector(bytes, uqa_core::LegacyVectorKind::Oid, control),
        17 => {
            let mut output = ProductionVec::new(*control);
            output.reserve(bytes.len())?;
            for byte in bytes {
                output.push_copy(*byte)?;
            }
            let (bytes, memory) = output.finish()?.into_parts();
            Ok(control.finish(Value::Bytes(bytes), memory)?)
        }
        25 | 114 | 142 | 194 | 1042 | 1043 | 1790 => {
            let text = std::str::from_utf8(bytes).map_err(|error| SQLError::Routine {
                sqlstate: "22021".into(),
                message: format!(
                    "invalid byte sequence for encoding \"UTF8\": 0x{:02x}",
                    bytes[error.valid_up_to()]
                ),
            })?;
            let (text, memory) = control.copy_text(text)?.into_parts();
            let value = match oid {
                114 => Value::Json(text),
                1042 => Value::FixedChar(text),
                _ => Value::Str(text),
            };
            Ok(control.finish(value, memory)?)
        }
        1560 | 1562 => bit_string::read(bytes, control),
        3802 => {
            let (text, memory) =
                super::json::decode_jsonb_datum_with_control(bytes, control)?.into_parts();
            Ok(control.finish(Value::JsonB(text), memory)?)
        }
        1700 => {
            let text =
                crate::catalog::node_tree::decode_numeric_datum_with_control(bytes, control)?;
            let (number, memory) = DecimalValue::parse_with_control(&text, control)?
                .ok_or_else(|| corrupt("invalid numeric datum"))?
                .into_parts();
            Ok(control.finish(Value::Decimal(number), memory)?)
        }
        oid => Err(SQLError::Unsupported(format!(
            "physical datum output for type OID {oid}"
        ))),
    }
}

/// Borrow ordinary and inline physical bytea payloads; compressed input retains its admitted decompression buffer through consumption.
pub(super) fn binary_payload<'a>(
    value: &'a Value,
    control: &ProductionControl<'_>,
) -> Result<Option<Payload<'a>>, SQLError> {
    control.check()?;
    match value {
        Value::Bytes(bytes) => Ok(Some(Payload::Borrowed(bytes))),
        Value::Datum(datum) if datum.type_oid() == 17 => payload(datum, control).map(Some),
        _ => Ok(None),
    }
}

/// Binary length observes the raw-size header and does not decompress the payload.
pub(super) fn binary_length(
    value: &Value,
    control: &ProductionControl<'_>,
) -> Result<Option<i64>, SQLError> {
    control.check()?;
    let datum = match value {
        Value::Bytes(bytes) => return Ok(Some(bytes.len() as i64)),
        Value::Datum(datum) if datum.type_oid() == 17 => datum,
        _ => return Ok(None),
    };
    let bytes = datum
        .bytes()
        .get(datum.offset() as usize..)
        .ok_or_else(|| corrupt("invalid datum length"))?;
    let first = *bytes
        .first()
        .ok_or_else(|| corrupt("invalid datum length"))?;
    let size = if first == 1 && bytes.get(1) == Some(&18) {
        i64::from(
            word(bytes.get(2..).unwrap_or_default())
                .ok_or_else(|| corrupt("invalid datum length"))?,
        ) - 4
    } else if first & 1 != 0 {
        i64::from(first >> 1) - 1
    } else if first & 3 == 2 {
        i64::from(
            word(bytes.get(4..).unwrap_or_default())
                .ok_or_else(|| corrupt("invalid datum length"))?
                & 0x3fff_ffff,
        )
    } else {
        i64::from(word(bytes).ok_or_else(|| corrupt("invalid datum length"))? >> 2) - 4
    };
    Ok(Some(size))
}

pub(super) enum Payload<'a> {
    Borrowed(&'a [u8]),
    Owned(Produced<Vec<u8>>),
}

impl Payload<'_> {
    pub(super) fn bytes(&self) -> &[u8] {
        match self {
            Self::Borrowed(bytes) => bytes,
            Self::Owned(bytes) => bytes,
        }
    }
}

fn payload<'a>(
    datum: &'a DatumValue,
    control: &ProductionControl<'_>,
) -> Result<Payload<'a>, SQLError> {
    let offset = datum.offset() as usize;
    let bytes = datum
        .bytes()
        .get(offset..)
        .ok_or_else(|| corrupt("invalid datum length"))?;
    let first = *bytes
        .first()
        .ok_or_else(|| corrupt("invalid datum length"))?;
    if first == 1 {
        return Err(malformed::external(datum));
    }
    if first & 1 != 0 {
        let length = usize::from(first >> 1);
        return bytes
            .get(1..length)
            .map(Payload::Borrowed)
            .ok_or_else(|| corrupt("invalid datum length"));
    }
    let header = word(bytes).ok_or_else(|| corrupt("invalid datum length"))?;
    let length = (header >> 2) as usize;
    if header & 3 == 2 {
        let information = word(bytes.get(4..).unwrap_or_default()).unwrap_or(0);
        let method = information >> 30;
        let compressed = bytes
            .get(8..length)
            .ok_or_else(|| compression::corrupt(method))?;
        return compression::decompress(
            compressed,
            (information & 0x3fff_ffff) as usize,
            method,
            control,
        )
        .map(Payload::Owned);
    }
    bytes
        .get(4..length)
        .map(Payload::Borrowed)
        .ok_or_else(|| corrupt("invalid datum length"))
}

fn word(bytes: &[u8]) -> Option<u32> {
    Some(u32::from_le_bytes(bytes.get(..4)?.try_into().ok()?))
}

fn corrupt(message: &str) -> SQLError {
    SQLError::Routine {
        sqlstate: "XX001".into(),
        message: message.into(),
    }
}