Skip to main content

uqa_sql/catalog/index/operator_classes/
btree.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7//! Built-in B-tree class identities and default selection for resolved SQL types.
8
9use crate::ColumnType;
10
11mod binding;
12pub use binding::BoundBTreeOperatorClass;
13
14#[derive(Debug, Clone, Copy, PartialEq, Eq)]
15pub struct BuiltinBTreeOperatorClass {
16    pub oid: u32,
17    pub name: &'static str,
18    pub default: bool,
19    pub family_oid: u32,
20    pub input_type_oid: u32,
21    pub comparison_oid: u32,
22}
23
24/// Interpretation of the selected built-in support procedure, independently of the declared subtype.
25#[derive(Debug, Clone, Copy, PartialEq, Eq)]
26pub enum BuiltinBTreeComparison {
27    Native,
28    Pattern,
29    RecordImage,
30}
31
32impl BuiltinBTreeOperatorClass {
33    pub fn comparison_kind(&self) -> BuiltinBTreeComparison {
34        match self.comparison_oid {
35            2166 | 2180 => BuiltinBTreeComparison::Pattern,
36            3187 => BuiltinBTreeComparison::RecordImage,
37            _ => BuiltinBTreeComparison::Native,
38        }
39    }
40}
41
42/// Built-in catalog metadata, not an assertion that an arbitrary class has an executable UQA comparator or exact-key implementation.
43pub fn builtin_btree_operator_classes() -> &'static [BuiltinBTreeOperatorClass] {
44    &CLASSES
45}
46
47pub fn builtin_btree_operator_class(oid: u32) -> Option<&'static BuiltinBTreeOperatorClass> {
48    CLASSES.iter().find(|class| class.oid == oid)
49}
50
51/// Select `PostgreSQL`'s built-in default class for the resolved type. Alias and generic-class binding preserve their declared type separately. UQA vector/tensor ordering has no `PostgreSQL` class identity.
52pub fn default_btree_operator_class(ty: &ColumnType) -> Option<&'static BuiltinBTreeOperatorClass> {
53    let input_type_oid = match ty {
54        ColumnType::Domain { base, .. } => return default_btree_operator_class(base),
55        ColumnType::Named(_)
56        | ColumnType::Xid
57        | ColumnType::Void
58        | ColumnType::RefCursor
59        | ColumnType::Json
60        | ColumnType::PgNodeTree
61        | ColumnType::AclItem
62        | ColumnType::Vector(_)
63        | ColumnType::Tensor(_) => return None,
64        ColumnType::Varchar(_) => 25,
65        ColumnType::Array(_) | ColumnType::AnyArray | ColumnType::Int2Vector => 2277,
66        ColumnType::Record | ColumnType::Composite(_) => 2249,
67        ColumnType::Enum(_) => 3500,
68        ColumnType::Range(_) | ColumnType::DeclaredRange(_) => 3831,
69        ColumnType::Multirange(_) | ColumnType::DeclaredMultirange(_) => 4537,
70        ColumnType::Regproc
71        | ColumnType::Regprocedure
72        | ColumnType::Regclass
73        | ColumnType::Regnamespace
74        | ColumnType::Regcollation
75        | ColumnType::Regrole
76        | ColumnType::Regtype => 26,
77        _ => u32::try_from(crate::catalog::type_metadata::pg_type_oid(ty)).ok()?,
78    };
79    CLASSES
80        .iter()
81        .find(|class| class.default && class.input_type_oid == input_type_oid)
82}
83
84const CLASSES: [BuiltinBTreeOperatorClass; 44] = [
85    BuiltinBTreeOperatorClass {
86        oid: 1978,
87        name: "int4_ops",
88        default: true,
89        family_oid: 1976,
90        input_type_oid: 23,
91        comparison_oid: 351,
92    },
93    BuiltinBTreeOperatorClass {
94        oid: 1979,
95        name: "int2_ops",
96        default: true,
97        family_oid: 1976,
98        input_type_oid: 21,
99        comparison_oid: 350,
100    },
101    BuiltinBTreeOperatorClass {
102        oid: 1981,
103        name: "oid_ops",
104        default: true,
105        family_oid: 1989,
106        input_type_oid: 26,
107        comparison_oid: 356,
108    },
109    BuiltinBTreeOperatorClass {
110        oid: 3122,
111        name: "date_ops",
112        default: true,
113        family_oid: 434,
114        input_type_oid: 1082,
115        comparison_oid: 1092,
116    },
117    BuiltinBTreeOperatorClass {
118        oid: 3123,
119        name: "float8_ops",
120        default: true,
121        family_oid: 1970,
122        input_type_oid: 701,
123        comparison_oid: 355,
124    },
125    BuiltinBTreeOperatorClass {
126        oid: 3124,
127        name: "int8_ops",
128        default: true,
129        family_oid: 1976,
130        input_type_oid: 20,
131        comparison_oid: 842,
132    },
133    BuiltinBTreeOperatorClass {
134        oid: 3125,
135        name: "numeric_ops",
136        default: true,
137        family_oid: 1988,
138        input_type_oid: 1700,
139        comparison_oid: 1769,
140    },
141    BuiltinBTreeOperatorClass {
142        oid: 3126,
143        name: "text_ops",
144        default: true,
145        family_oid: 1994,
146        input_type_oid: 25,
147        comparison_oid: 360,
148    },
149    BuiltinBTreeOperatorClass {
150        oid: 3127,
151        name: "timestamptz_ops",
152        default: true,
153        family_oid: 434,
154        input_type_oid: 1184,
155        comparison_oid: 1314,
156    },
157    BuiltinBTreeOperatorClass {
158        oid: 3128,
159        name: "timestamp_ops",
160        default: true,
161        family_oid: 434,
162        input_type_oid: 1114,
163        comparison_oid: 2045,
164    },
165    BuiltinBTreeOperatorClass {
166        oid: 4217,
167        name: "text_pattern_ops",
168        default: false,
169        family_oid: 2095,
170        input_type_oid: 25,
171        comparison_oid: 2166,
172    },
173    BuiltinBTreeOperatorClass {
174        oid: 4218,
175        name: "varchar_pattern_ops",
176        default: false,
177        family_oid: 2095,
178        input_type_oid: 25,
179        comparison_oid: 2166,
180    },
181    BuiltinBTreeOperatorClass {
182        oid: 4219,
183        name: "bpchar_pattern_ops",
184        default: false,
185        family_oid: 2097,
186        input_type_oid: 1042,
187        comparison_oid: 2180,
188    },
189    BuiltinBTreeOperatorClass {
190        oid: 10000,
191        name: "array_ops",
192        default: true,
193        family_oid: 397,
194        input_type_oid: 2277,
195        comparison_oid: 382,
196    },
197    BuiltinBTreeOperatorClass {
198        oid: 10002,
199        name: "bit_ops",
200        default: true,
201        family_oid: 423,
202        input_type_oid: 1560,
203        comparison_oid: 1596,
204    },
205    BuiltinBTreeOperatorClass {
206        oid: 10003,
207        name: "bool_ops",
208        default: true,
209        family_oid: 424,
210        input_type_oid: 16,
211        comparison_oid: 1693,
212    },
213    BuiltinBTreeOperatorClass {
214        oid: 10004,
215        name: "bpchar_ops",
216        default: true,
217        family_oid: 426,
218        input_type_oid: 1042,
219        comparison_oid: 1078,
220    },
221    BuiltinBTreeOperatorClass {
222        oid: 10006,
223        name: "bytea_ops",
224        default: true,
225        family_oid: 428,
226        input_type_oid: 17,
227        comparison_oid: 1954,
228    },
229    BuiltinBTreeOperatorClass {
230        oid: 10007,
231        name: "char_ops",
232        default: true,
233        family_oid: 429,
234        input_type_oid: 18,
235        comparison_oid: 358,
236    },
237    BuiltinBTreeOperatorClass {
238        oid: 10009,
239        name: "cidr_ops",
240        default: false,
241        family_oid: 1974,
242        input_type_oid: 869,
243        comparison_oid: 926,
244    },
245    BuiltinBTreeOperatorClass {
246        oid: 10012,
247        name: "float4_ops",
248        default: true,
249        family_oid: 1970,
250        input_type_oid: 700,
251        comparison_oid: 354,
252    },
253    BuiltinBTreeOperatorClass {
254        oid: 10015,
255        name: "inet_ops",
256        default: true,
257        family_oid: 1974,
258        input_type_oid: 869,
259        comparison_oid: 926,
260    },
261    BuiltinBTreeOperatorClass {
262        oid: 10022,
263        name: "interval_ops",
264        default: true,
265        family_oid: 1982,
266        input_type_oid: 1186,
267        comparison_oid: 1315,
268    },
269    BuiltinBTreeOperatorClass {
270        oid: 10024,
271        name: "macaddr_ops",
272        default: true,
273        family_oid: 1984,
274        input_type_oid: 829,
275        comparison_oid: 836,
276    },
277    BuiltinBTreeOperatorClass {
278        oid: 10026,
279        name: "macaddr8_ops",
280        default: true,
281        family_oid: 3371,
282        input_type_oid: 774,
283        comparison_oid: 4119,
284    },
285    BuiltinBTreeOperatorClass {
286        oid: 10028,
287        name: "name_ops",
288        default: true,
289        family_oid: 1994,
290        input_type_oid: 19,
291        comparison_oid: 359,
292    },
293    BuiltinBTreeOperatorClass {
294        oid: 10032,
295        name: "oidvector_ops",
296        default: true,
297        family_oid: 1991,
298        input_type_oid: 30,
299        comparison_oid: 404,
300    },
301    BuiltinBTreeOperatorClass {
302        oid: 10034,
303        name: "record_ops",
304        default: true,
305        family_oid: 2994,
306        input_type_oid: 2249,
307        comparison_oid: 2987,
308    },
309    BuiltinBTreeOperatorClass {
310        oid: 10036,
311        name: "record_image_ops",
312        default: false,
313        family_oid: 3194,
314        input_type_oid: 2249,
315        comparison_oid: 3187,
316    },
317    BuiltinBTreeOperatorClass {
318        oid: 10038,
319        name: "time_ops",
320        default: true,
321        family_oid: 1996,
322        input_type_oid: 1083,
323        comparison_oid: 1107,
324    },
325    BuiltinBTreeOperatorClass {
326        oid: 10041,
327        name: "timetz_ops",
328        default: true,
329        family_oid: 2000,
330        input_type_oid: 1266,
331        comparison_oid: 1358,
332    },
333    BuiltinBTreeOperatorClass {
334        oid: 10043,
335        name: "varbit_ops",
336        default: true,
337        family_oid: 2002,
338        input_type_oid: 1562,
339        comparison_oid: 1672,
340    },
341    BuiltinBTreeOperatorClass {
342        oid: 10044,
343        name: "varchar_ops",
344        default: false,
345        family_oid: 1994,
346        input_type_oid: 25,
347        comparison_oid: 360,
348    },
349    BuiltinBTreeOperatorClass {
350        oid: 10047,
351        name: "money_ops",
352        default: true,
353        family_oid: 2099,
354        input_type_oid: 790,
355        comparison_oid: 377,
356    },
357    BuiltinBTreeOperatorClass {
358        oid: 10050,
359        name: "tid_ops",
360        default: true,
361        family_oid: 2789,
362        input_type_oid: 27,
363        comparison_oid: 2794,
364    },
365    BuiltinBTreeOperatorClass {
366        oid: 10053,
367        name: "xid8_ops",
368        default: true,
369        family_oid: 5067,
370        input_type_oid: 5069,
371        comparison_oid: 5096,
372    },
373    BuiltinBTreeOperatorClass {
374        oid: 10065,
375        name: "uuid_ops",
376        default: true,
377        family_oid: 2968,
378        input_type_oid: 2950,
379        comparison_oid: 2960,
380    },
381    BuiltinBTreeOperatorClass {
382        oid: 10067,
383        name: "pg_lsn_ops",
384        default: true,
385        family_oid: 3253,
386        input_type_oid: 3220,
387        comparison_oid: 3251,
388    },
389    BuiltinBTreeOperatorClass {
390        oid: 10069,
391        name: "enum_ops",
392        default: true,
393        family_oid: 3522,
394        input_type_oid: 3500,
395        comparison_oid: 3514,
396    },
397    BuiltinBTreeOperatorClass {
398        oid: 10071,
399        name: "tsvector_ops",
400        default: true,
401        family_oid: 3626,
402        input_type_oid: 3614,
403        comparison_oid: 3622,
404    },
405    BuiltinBTreeOperatorClass {
406        oid: 10074,
407        name: "tsquery_ops",
408        default: true,
409        family_oid: 3683,
410        input_type_oid: 3615,
411        comparison_oid: 3668,
412    },
413    BuiltinBTreeOperatorClass {
414        oid: 10076,
415        name: "range_ops",
416        default: true,
417        family_oid: 3901,
418        input_type_oid: 3831,
419        comparison_oid: 3870,
420    },
421    BuiltinBTreeOperatorClass {
422        oid: 10080,
423        name: "multirange_ops",
424        default: true,
425        family_oid: 4199,
426        input_type_oid: 4537,
427        comparison_oid: 4273,
428    },
429    BuiltinBTreeOperatorClass {
430        oid: 10088,
431        name: "jsonb_ops",
432        default: true,
433        family_oid: 4033,
434        input_type_oid: 3802,
435        comparison_oid: 4044,
436    },
437];
438
439#[cfg(test)]
440mod tests;