Skip to main content

uqa_sql/catalog/
collations.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7//! Built-in collation identities shared by declarations and OID alias input/output.
8
9mod ctype;
10pub mod declarations;
11pub(crate) mod derivation;
12pub mod expression;
13mod selection;
14
15pub use ctype::BuiltinCollationCtype;
16pub use selection::CollationSelection;
17
18/// The database-default collation's predefined `PostgreSQL` catalog identity.
19pub const DEFAULT_COLLATION_OID: i64 = 100;
20pub const C_COLLATION_OID: u32 = 950;
21
22/// Predefined `PostgreSQL` 18 collation names and OIDs with their ordering and character semantics.
23const BUILTIN_COLLATIONS: [(&str, i64, BuiltinCollationOrder, BuiltinCollationCtype); 7] = [
24    (
25        "default",
26        DEFAULT_COLLATION_OID,
27        BuiltinCollationOrder::Bytes,
28        BuiltinCollationCtype::UnicodeFull,
29    ),
30    (
31        "pg_c_utf8",
32        811,
33        BuiltinCollationOrder::Bytes,
34        BuiltinCollationCtype::UnicodeSimple,
35    ),
36    (
37        "C",
38        C_COLLATION_OID as i64,
39        BuiltinCollationOrder::Bytes,
40        BuiltinCollationCtype::Ascii,
41    ),
42    (
43        "POSIX",
44        951,
45        BuiltinCollationOrder::Bytes,
46        BuiltinCollationCtype::Ascii,
47    ),
48    (
49        "ucs_basic",
50        962,
51        BuiltinCollationOrder::Bytes,
52        BuiltinCollationCtype::Ascii,
53    ),
54    (
55        "unicode",
56        963,
57        BuiltinCollationOrder::Unicode,
58        BuiltinCollationCtype::IcuRoot,
59    ),
60    (
61        "pg_unicode_fast",
62        6411,
63        BuiltinCollationOrder::Bytes,
64        BuiltinCollationCtype::UnicodeFull,
65    ),
66];
67
68/// The `pg_collation` OID of a built-in collation name.
69#[must_use]
70pub fn builtin_collation_oid(name: &str) -> Option<i64> {
71    BUILTIN_COLLATIONS
72        .iter()
73        .find(|(collation, ..)| *collation == name)
74        .map(|(_, oid, ..)| *oid)
75}
76
77/// The name of a built-in collation selected by its catalog OID.
78#[must_use]
79pub fn builtin_collation_name(oid: i64) -> Option<&'static str> {
80    BUILTIN_COLLATIONS
81        .iter()
82        .find_map(|(name, candidate, ..)| (*candidate == oid).then_some(*name))
83}
84
85/// Executable ordering of the fixed deterministic built-ins. The database default is UQA's builtin `PG_UNICODE_FAST`; selecting `unicode` chooses root ICU instead.
86#[derive(Debug, Clone, Copy, PartialEq, Eq)]
87pub enum BuiltinCollationOrder {
88    Bytes,
89    Unicode,
90}
91
92pub fn builtin_collation_order(oid: u32) -> Option<BuiltinCollationOrder> {
93    BUILTIN_COLLATIONS
94        .iter()
95        .find_map(|(_, candidate, order, _)| (*candidate == i64::from(oid)).then_some(*order))
96}
97
98/// The character semantics of a built-in collation selected by its catalog OID.
99pub fn builtin_collation_ctype(oid: u32) -> Option<BuiltinCollationCtype> {
100    BUILTIN_COLLATIONS
101        .iter()
102        .find_map(|(_, candidate, _, ctype)| (*candidate == i64::from(oid)).then_some(*ctype))
103}