Skip to main content

uqa_sql/catalog/
mod.rs

1//
2// Unified Query Algebra
3//
4// Copyright (c) 2023-2026 Cognica, Inc.
5//
6
7//! `PostgreSQL` 18 row types for the virtual system-catalog relations implemented by the engine.
8
9use crate::ast::ColumnType;
10mod schema_production;
11use schema_production::CatalogColumnType::{self, Array, Domain, Inline};
12
13pub mod access_methods;
14pub mod collations;
15pub mod expression_text;
16pub mod foreign_relations;
17pub mod languages;
18pub mod node_tree;
19pub mod oids;
20pub mod resolution;
21pub mod result_type;
22pub mod type_metadata;
23mod type_production;
24pub use type_production::system_catalog_domain_with_control;
25
26/// Namespace of the Apache AGE catalog relations, types, and functions.
27pub const AG_CATALOG_SCHEMA: &str = "ag_catalog";
28
29mod virtual_relations;
30pub use virtual_relations::{resolve_virtual_relation, VirtualRelation};
31mod system_relations;
32pub use system_relations::SystemRelation;
33
34impl VirtualRelation {
35    pub const fn accepts_row_lock(self) -> bool {
36        matches!(
37            self,
38            Self::PgNamespace
39                | Self::PgClass
40                | Self::PgInherits
41                | Self::PgPartitionedTable
42                | Self::PgAttribute
43                | Self::PgAttrdef
44                | Self::PgConstraint
45                | Self::PgIndex
46                | Self::PgTrigger
47                | Self::PgRewrite
48                | Self::PgType
49                | Self::PgRange
50                | Self::PgEnum
51                | Self::PgProc
52                | Self::PgLanguage
53                | Self::PgExtension
54                | Self::PgForeignDataWrapper
55                | Self::PgForeignServer
56                | Self::PgForeignTable
57                | Self::PgDatabase
58                | Self::PgAuthid
59                | Self::PgAuthMembers
60                | Self::PgDescription
61                | Self::PgDepend
62                | Self::PgShdepend
63                | Self::AgGraph
64                | Self::AgLabel
65        )
66    }
67
68    pub fn schema(self) -> Vec<(String, ColumnType)> {
69        self.schema_with_control(&uqa_core::memory::ProductionControl::uncontrolled())
70            .expect("ordinary catalog schema")
71            .into_uncontrolled()
72            .expect("ordinary catalog owner")
73    }
74
75    pub fn column_names_with_control(
76        self,
77        control: &uqa_core::memory::ProductionControl<'_>,
78    ) -> Result<uqa_core::memory::Produced<Vec<String>>, crate::SQLError> {
79        control.check()?;
80        let mut names = uqa_core::memory::ProductionVec::new(*control);
81        let mut status = Ok(());
82        self.visit_columns(&mut |name, _| {
83            if status.is_ok() {
84                status = control
85                    .copy_text(name)
86                    .and_then(|name| names.push_produced(name));
87            }
88        });
89        status?;
90        Ok(names.finish()?)
91    }
92
93    #[expect(
94        clippy::too_many_lines,
95        reason = "preserves catalog column and OID order"
96    )]
97    fn visit_columns(self, visit: &mut dyn FnMut(&'static str, CatalogColumnType)) {
98        // Each relation owns its construction frame, keeping unoptimized WASM locals bounded.
99        macro_rules! columns {
100            ($($name:literal => $ty:expr),* $(,)?) => {{
101                fn relation_columns(visit: &mut dyn FnMut(&'static str, CatalogColumnType)) {
102                    $(visit($name, $ty);)*
103                }
104                relation_columns(visit)
105            }};
106        }
107
108        match self {
109            Self::PgForeignDataWrapper | Self::PgForeignServer | Self::PgForeignTable => {
110                foreign_relations::visit_columns(self, visit);
111            }
112            Self::InformationSchemaCatalogName => columns![
113                "catalog_name" => Domain(13312),
114            ],
115            Self::InformationSchemata => columns![
116                "catalog_name" => Domain(13312),
117                "schema_name" => Domain(13312),
118                "schema_owner" => Domain(13312),
119                "default_character_set_catalog" => Domain(13312),
120                "default_character_set_schema" => Domain(13312),
121                "default_character_set_name" => Domain(13312),
122                "sql_path" => Domain(13310),
123            ],
124            Self::InformationTables => columns![
125                "table_catalog" => Domain(13312),
126                "table_schema" => Domain(13312),
127                "table_name" => Domain(13312),
128                "table_type" => Domain(13310),
129                "self_referencing_column_name" => Domain(13312),
130                "reference_generation" => Domain(13310),
131                "user_defined_type_catalog" => Domain(13312),
132                "user_defined_type_schema" => Domain(13312),
133                "user_defined_type_name" => Domain(13312),
134                "is_insertable_into" => Domain(13320),
135                "is_typed" => Domain(13320),
136                "commit_action" => Domain(13310),
137            ],
138            Self::InformationColumns => columns![
139                "table_catalog" => Domain(13312),
140                "table_schema" => Domain(13312),
141                "table_name" => Domain(13312),
142                "column_name" => Domain(13312),
143                "ordinal_position" => Domain(13307),
144                "column_default" => Domain(13310),
145                "is_nullable" => Domain(13320),
146                "data_type" => Domain(13310),
147                "character_maximum_length" => Domain(13307),
148                "character_octet_length" => Domain(13307),
149                "numeric_precision" => Domain(13307),
150                "numeric_precision_radix" => Domain(13307),
151                "numeric_scale" => Domain(13307),
152                "datetime_precision" => Domain(13307),
153                "interval_type" => Domain(13310),
154                "interval_precision" => Domain(13307),
155                "character_set_catalog" => Domain(13312),
156                "character_set_schema" => Domain(13312),
157                "character_set_name" => Domain(13312),
158                "collation_catalog" => Domain(13312),
159                "collation_schema" => Domain(13312),
160                "collation_name" => Domain(13312),
161                "domain_catalog" => Domain(13312),
162                "domain_schema" => Domain(13312),
163                "domain_name" => Domain(13312),
164                "udt_catalog" => Domain(13312),
165                "udt_schema" => Domain(13312),
166                "udt_name" => Domain(13312),
167                "scope_catalog" => Domain(13312),
168                "scope_schema" => Domain(13312),
169                "scope_name" => Domain(13312),
170                "maximum_cardinality" => Domain(13307),
171                "dtd_identifier" => Domain(13312),
172                "is_self_referencing" => Domain(13320),
173                "is_identity" => Domain(13320),
174                "identity_generation" => Domain(13310),
175                "identity_start" => Domain(13310),
176                "identity_increment" => Domain(13310),
177                "identity_maximum" => Domain(13310),
178                "identity_minimum" => Domain(13310),
179                "identity_cycle" => Domain(13320),
180                "is_generated" => Domain(13310),
181                "generation_expression" => Domain(13310),
182                "is_updatable" => Domain(13320),
183            ],
184            Self::InformationColumnPrivileges | Self::InformationRoleColumnGrants => columns![
185                "grantor" => Domain(13312),
186                "grantee" => Domain(13312),
187                "table_catalog" => Domain(13312),
188                "table_schema" => Domain(13312),
189                "table_name" => Domain(13312),
190                "column_name" => Domain(13312),
191                "privilege_type" => Domain(13310),
192                "is_grantable" => Domain(13320),
193            ],
194            Self::InformationViews => columns![
195                "table_catalog" => Domain(13312),
196                "table_schema" => Domain(13312),
197                "table_name" => Domain(13312),
198                "view_definition" => Domain(13310),
199                "check_option" => Domain(13310),
200                "is_updatable" => Domain(13320),
201                "is_insertable_into" => Domain(13320),
202                "is_trigger_updatable" => Domain(13320),
203                "is_trigger_deletable" => Domain(13320),
204                "is_trigger_insertable_into" => Domain(13320),
205            ],
206            Self::InformationRoutines => information_routines_columns(visit),
207            Self::InformationSequences => columns![
208                "sequence_catalog" => Domain(13312),
209                "sequence_schema" => Domain(13312),
210                "sequence_name" => Domain(13312),
211                "data_type" => Domain(13310),
212                "numeric_precision" => Domain(13307),
213                "numeric_precision_radix" => Domain(13307),
214                "numeric_scale" => Domain(13307),
215                "start_value" => Domain(13310),
216                "minimum_value" => Domain(13310),
217                "maximum_value" => Domain(13310),
218                "increment" => Domain(13310),
219                "cycle_option" => Domain(13320),
220            ],
221            Self::InformationTableConstraints => columns![
222                "constraint_catalog" => Domain(13312),
223                "constraint_schema" => Domain(13312),
224                "constraint_name" => Domain(13312),
225                "table_catalog" => Domain(13312),
226                "table_schema" => Domain(13312),
227                "table_name" => Domain(13312),
228                "constraint_type" => Domain(13310),
229                "is_deferrable" => Domain(13320),
230                "initially_deferred" => Domain(13320),
231                "enforced" => Domain(13320),
232                "nulls_distinct" => Domain(13320),
233            ],
234            Self::InformationCheckConstraints => columns![
235                "constraint_catalog" => Domain(13312),
236                "constraint_schema" => Domain(13312),
237                "constraint_name" => Domain(13312),
238                "check_clause" => Domain(13310),
239            ],
240            Self::InformationDomainConstraints => columns![
241                "constraint_catalog" => Domain(13312),
242                "constraint_schema" => Domain(13312),
243                "constraint_name" => Domain(13312),
244                "domain_catalog" => Domain(13312),
245                "domain_schema" => Domain(13312),
246                "domain_name" => Domain(13312),
247                "is_deferrable" => Domain(13320),
248                "initially_deferred" => Domain(13320),
249            ],
250            Self::InformationKeyColumnUsage => columns![
251                "constraint_catalog" => Domain(13312),
252                "constraint_schema" => Domain(13312),
253                "constraint_name" => Domain(13312),
254                "table_catalog" => Domain(13312),
255                "table_schema" => Domain(13312),
256                "table_name" => Domain(13312),
257                "column_name" => Domain(13312),
258                "ordinal_position" => Domain(13307),
259                "position_in_unique_constraint" => Domain(13307),
260            ],
261            Self::InformationConstraintColumnUsage => columns![
262                "table_catalog" => Domain(13312),
263                "table_schema" => Domain(13312),
264                "table_name" => Domain(13312),
265                "column_name" => Domain(13312),
266                "constraint_catalog" => Domain(13312),
267                "constraint_schema" => Domain(13312),
268                "constraint_name" => Domain(13312),
269            ],
270            Self::InformationConstraintTableUsage => columns![
271                "table_catalog" => Domain(13312),
272                "table_schema" => Domain(13312),
273                "table_name" => Domain(13312),
274                "constraint_catalog" => Domain(13312),
275                "constraint_schema" => Domain(13312),
276                "constraint_name" => Domain(13312),
277            ],
278            Self::PgNamespace => columns![
279                "oid" => Inline(ColumnType::Oid),
280                "nspname" => Inline(ColumnType::Name),
281                "nspowner" => Inline(ColumnType::Oid),
282                "nspacl" => Array(ColumnType::AclItem),
283            ],
284            Self::PgClass => columns![
285                "oid" => Inline(ColumnType::Oid),
286                "relname" => Inline(ColumnType::Name),
287                "relnamespace" => Inline(ColumnType::Oid),
288                "reltype" => Inline(ColumnType::Oid),
289                "reloftype" => Inline(ColumnType::Oid),
290                "relowner" => Inline(ColumnType::Oid),
291                "relam" => Inline(ColumnType::Oid),
292                "relfilenode" => Inline(ColumnType::Oid),
293                "reltablespace" => Inline(ColumnType::Oid),
294                "relpages" => Inline(ColumnType::Integer),
295                "reltuples" => Inline(ColumnType::Real),
296                "relallvisible" => Inline(ColumnType::Integer),
297                "relallfrozen" => Inline(ColumnType::Integer),
298                "reltoastrelid" => Inline(ColumnType::Oid),
299                "relhasindex" => Inline(ColumnType::Boolean),
300                "relisshared" => Inline(ColumnType::Boolean),
301                "relpersistence" => Inline(ColumnType::InternalChar),
302                "relkind" => Inline(ColumnType::InternalChar),
303                "relnatts" => Inline(ColumnType::SmallInteger),
304                "relchecks" => Inline(ColumnType::SmallInteger),
305                "relhasrules" => Inline(ColumnType::Boolean),
306                "relhastriggers" => Inline(ColumnType::Boolean),
307                "relhassubclass" => Inline(ColumnType::Boolean),
308                "relrowsecurity" => Inline(ColumnType::Boolean),
309                "relforcerowsecurity" => Inline(ColumnType::Boolean),
310                "relispopulated" => Inline(ColumnType::Boolean),
311                "relreplident" => Inline(ColumnType::InternalChar),
312                "relispartition" => Inline(ColumnType::Boolean),
313                "relrewrite" => Inline(ColumnType::Oid),
314                "relfrozenxid" => Inline(ColumnType::Xid),
315                "relminmxid" => Inline(ColumnType::Xid),
316                "relacl" => Array(ColumnType::AclItem),
317                "reloptions" => Array(ColumnType::Text),
318                "relpartbound" => Inline(ColumnType::PgNodeTree),
319            ],
320            Self::PgInherits => columns![
321                "inhrelid" => Inline(ColumnType::Oid),
322                "inhparent" => Inline(ColumnType::Oid),
323                "inhseqno" => Inline(ColumnType::Integer),
324                "inhdetachpending" => Inline(ColumnType::Boolean),
325            ],
326            Self::PgPartitionedTable => columns![
327                "partrelid" => Inline(ColumnType::Oid),
328                "partstrat" => Inline(ColumnType::InternalChar),
329                "partnatts" => Inline(ColumnType::SmallInteger),
330                "partdefid" => Inline(ColumnType::Oid),
331                "partattrs" => Inline(ColumnType::Int2Vector),
332                "partclass" => Inline(ColumnType::OidVector),
333                "partcollation" => Inline(ColumnType::OidVector),
334                "partexprs" => Inline(ColumnType::PgNodeTree),
335            ],
336            Self::PgAttribute => columns![
337                "attrelid" => Inline(ColumnType::Oid),
338                "attname" => Inline(ColumnType::Name),
339                "atttypid" => Inline(ColumnType::Oid),
340                "attlen" => Inline(ColumnType::SmallInteger),
341                "attnum" => Inline(ColumnType::SmallInteger),
342                "atttypmod" => Inline(ColumnType::Integer),
343                "attndims" => Inline(ColumnType::SmallInteger),
344                "attbyval" => Inline(ColumnType::Boolean),
345                "attalign" => Inline(ColumnType::InternalChar),
346                "attstorage" => Inline(ColumnType::InternalChar),
347                "attcompression" => Inline(ColumnType::InternalChar),
348                "attnotnull" => Inline(ColumnType::Boolean),
349                "atthasdef" => Inline(ColumnType::Boolean),
350                "atthasmissing" => Inline(ColumnType::Boolean),
351                "attidentity" => Inline(ColumnType::InternalChar),
352                "attgenerated" => Inline(ColumnType::InternalChar),
353                "attisdropped" => Inline(ColumnType::Boolean),
354                "attislocal" => Inline(ColumnType::Boolean),
355                "attinhcount" => Inline(ColumnType::SmallInteger),
356                "attcollation" => Inline(ColumnType::Oid),
357                "attstattarget" => Inline(ColumnType::SmallInteger),
358                "attacl" => Array(ColumnType::AclItem),
359                "attoptions" => Array(ColumnType::Text),
360                "attfdwoptions" => Array(ColumnType::Text),
361                "attmissingval" => Inline(ColumnType::AnyArray),
362            ],
363            Self::PgAttrdef => columns![
364                "oid" => Inline(ColumnType::Oid),
365                "adrelid" => Inline(ColumnType::Oid),
366                "adnum" => Inline(ColumnType::SmallInteger),
367                "adbin" => Inline(ColumnType::PgNodeTree),
368            ],
369            Self::PgConstraint => columns![
370                "oid" => Inline(ColumnType::Oid),
371                "conname" => Inline(ColumnType::Name),
372                "connamespace" => Inline(ColumnType::Oid),
373                "contype" => Inline(ColumnType::InternalChar),
374                "condeferrable" => Inline(ColumnType::Boolean),
375                "condeferred" => Inline(ColumnType::Boolean),
376                "conenforced" => Inline(ColumnType::Boolean),
377                "convalidated" => Inline(ColumnType::Boolean),
378                "conrelid" => Inline(ColumnType::Oid),
379                "contypid" => Inline(ColumnType::Oid),
380                "conindid" => Inline(ColumnType::Oid),
381                "conparentid" => Inline(ColumnType::Oid),
382                "confrelid" => Inline(ColumnType::Oid),
383                "confupdtype" => Inline(ColumnType::InternalChar),
384                "confdeltype" => Inline(ColumnType::InternalChar),
385                "confmatchtype" => Inline(ColumnType::InternalChar),
386                "conislocal" => Inline(ColumnType::Boolean),
387                "coninhcount" => Inline(ColumnType::SmallInteger),
388                "connoinherit" => Inline(ColumnType::Boolean),
389                "conperiod" => Inline(ColumnType::Boolean),
390                "conkey" => Array(ColumnType::SmallInteger),
391                "confkey" => Array(ColumnType::SmallInteger),
392                "conpfeqop" => Array(ColumnType::Oid),
393                "conppeqop" => Array(ColumnType::Oid),
394                "conffeqop" => Array(ColumnType::Oid),
395                "confdelsetcols" => Array(ColumnType::SmallInteger),
396                "conexclop" => Array(ColumnType::Oid),
397                "conbin" => Inline(ColumnType::PgNodeTree),
398            ],
399            Self::PgIndex => columns![
400                "indexrelid" => Inline(ColumnType::Oid),
401                "indrelid" => Inline(ColumnType::Oid),
402                "indnatts" => Inline(ColumnType::SmallInteger),
403                "indnkeyatts" => Inline(ColumnType::SmallInteger),
404                "indisunique" => Inline(ColumnType::Boolean),
405                "indnullsnotdistinct" => Inline(ColumnType::Boolean),
406                "indisprimary" => Inline(ColumnType::Boolean),
407                "indisexclusion" => Inline(ColumnType::Boolean),
408                "indimmediate" => Inline(ColumnType::Boolean),
409                "indisclustered" => Inline(ColumnType::Boolean),
410                "indisvalid" => Inline(ColumnType::Boolean),
411                "indcheckxmin" => Inline(ColumnType::Boolean),
412                "indisready" => Inline(ColumnType::Boolean),
413                "indislive" => Inline(ColumnType::Boolean),
414                "indisreplident" => Inline(ColumnType::Boolean),
415                "indkey" => Inline(ColumnType::Int2Vector),
416                "indcollation" => Inline(ColumnType::OidVector),
417                "indclass" => Inline(ColumnType::OidVector),
418                "indoption" => Inline(ColumnType::Int2Vector),
419                "indexprs" => Inline(ColumnType::PgNodeTree),
420                "indpred" => Inline(ColumnType::PgNodeTree),
421            ],
422            Self::PgTrigger => columns![
423                "oid" => Inline(ColumnType::Oid),
424                "tgrelid" => Inline(ColumnType::Oid),
425                "tgparentid" => Inline(ColumnType::Oid),
426                "tgname" => Inline(ColumnType::Name),
427                "tgfoid" => Inline(ColumnType::Oid),
428                "tgtype" => Inline(ColumnType::SmallInteger),
429                "tgenabled" => Inline(ColumnType::InternalChar),
430                "tgisinternal" => Inline(ColumnType::Boolean),
431                "tgconstrrelid" => Inline(ColumnType::Oid),
432                "tgconstrindid" => Inline(ColumnType::Oid),
433                "tgconstraint" => Inline(ColumnType::Oid),
434                "tgdeferrable" => Inline(ColumnType::Boolean),
435                "tginitdeferred" => Inline(ColumnType::Boolean),
436                "tgnargs" => Inline(ColumnType::SmallInteger),
437                "tgattr" => Inline(ColumnType::Int2Vector),
438                "tgargs" => Inline(ColumnType::Bytea),
439                "tgqual" => Inline(ColumnType::PgNodeTree),
440                "tgoldtable" => Inline(ColumnType::Name),
441                "tgnewtable" => Inline(ColumnType::Name),
442            ],
443            Self::PgRewrite => columns![
444                "oid" => Inline(ColumnType::Oid),
445                "rulename" => Inline(ColumnType::Name),
446                "ev_class" => Inline(ColumnType::Oid),
447                "ev_type" => Inline(ColumnType::InternalChar),
448                "ev_enabled" => Inline(ColumnType::InternalChar),
449                "is_instead" => Inline(ColumnType::Boolean),
450                "ev_qual" => Inline(ColumnType::PgNodeTree),
451                "ev_action" => Inline(ColumnType::PgNodeTree),
452            ],
453            Self::PgRules => columns![
454                "schemaname" => Inline(ColumnType::Name),
455                "tablename" => Inline(ColumnType::Name),
456                "rulename" => Inline(ColumnType::Name),
457                "definition" => Inline(ColumnType::Text),
458            ],
459            Self::PgTables => columns![
460                "schemaname" => Inline(ColumnType::Name),
461                "tablename" => Inline(ColumnType::Name),
462                "tableowner" => Inline(ColumnType::Name),
463                "tablespace" => Inline(ColumnType::Name),
464                "hasindexes" => Inline(ColumnType::Boolean),
465                "hasrules" => Inline(ColumnType::Boolean),
466                "hastriggers" => Inline(ColumnType::Boolean),
467                "rowsecurity" => Inline(ColumnType::Boolean),
468            ],
469            Self::PgViews => columns![
470                "schemaname" => Inline(ColumnType::Name),
471                "viewname" => Inline(ColumnType::Name),
472                "viewowner" => Inline(ColumnType::Name),
473                "definition" => Inline(ColumnType::Text),
474            ],
475            Self::PgIndexes => columns![
476                "schemaname" => Inline(ColumnType::Name),
477                "tablename" => Inline(ColumnType::Name),
478                "indexname" => Inline(ColumnType::Name),
479                "tablespace" => Inline(ColumnType::Name),
480                "indexdef" => Inline(ColumnType::Text),
481            ],
482            Self::PgType => columns![
483                "oid" => Inline(ColumnType::Oid),
484                "typname" => Inline(ColumnType::Name),
485                "typnamespace" => Inline(ColumnType::Oid),
486                "typowner" => Inline(ColumnType::Oid),
487                "typlen" => Inline(ColumnType::SmallInteger),
488                "typbyval" => Inline(ColumnType::Boolean),
489                "typtype" => Inline(ColumnType::InternalChar),
490                "typcategory" => Inline(ColumnType::InternalChar),
491                "typispreferred" => Inline(ColumnType::Boolean),
492                "typisdefined" => Inline(ColumnType::Boolean),
493                "typdelim" => Inline(ColumnType::InternalChar),
494                "typrelid" => Inline(ColumnType::Oid),
495                "typsubscript" => Inline(ColumnType::Regproc),
496                "typelem" => Inline(ColumnType::Oid),
497                "typarray" => Inline(ColumnType::Oid),
498                "typinput" => Inline(ColumnType::Regproc),
499                "typoutput" => Inline(ColumnType::Regproc),
500                "typreceive" => Inline(ColumnType::Regproc),
501                "typsend" => Inline(ColumnType::Regproc),
502                "typmodin" => Inline(ColumnType::Regproc),
503                "typmodout" => Inline(ColumnType::Regproc),
504                "typanalyze" => Inline(ColumnType::Regproc),
505                "typalign" => Inline(ColumnType::InternalChar),
506                "typstorage" => Inline(ColumnType::InternalChar),
507                "typnotnull" => Inline(ColumnType::Boolean),
508                "typbasetype" => Inline(ColumnType::Oid),
509                "typtypmod" => Inline(ColumnType::Integer),
510                "typndims" => Inline(ColumnType::Integer),
511                "typcollation" => Inline(ColumnType::Oid),
512                "typdefaultbin" => Inline(ColumnType::PgNodeTree),
513                "typdefault" => Inline(ColumnType::Text),
514                "typacl" => Array(ColumnType::AclItem),
515            ],
516            Self::PgEnum => columns![
517                "oid" => Inline(ColumnType::Oid),
518                "enumtypid" => Inline(ColumnType::Oid),
519                "enumsortorder" => Inline(ColumnType::Real),
520                "enumlabel" => Inline(ColumnType::Name),
521            ],
522            Self::PgRange => columns![
523                "rngtypid" => Inline(ColumnType::Oid),
524                "rngsubtype" => Inline(ColumnType::Oid),
525                "rngmultitypid" => Inline(ColumnType::Oid),
526                "rngcollation" => Inline(ColumnType::Oid),
527                "rngsubopc" => Inline(ColumnType::Oid),
528                "rngcanonical" => Inline(ColumnType::Regproc),
529                "rngsubdiff" => Inline(ColumnType::Regproc),
530            ],
531            Self::PgProc => columns![
532                "oid" => Inline(ColumnType::Oid),
533                "proname" => Inline(ColumnType::Name),
534                "pronamespace" => Inline(ColumnType::Oid),
535                "proowner" => Inline(ColumnType::Oid),
536                "prolang" => Inline(ColumnType::Oid),
537                "procost" => Inline(ColumnType::Real),
538                "prorows" => Inline(ColumnType::Real),
539                "provariadic" => Inline(ColumnType::Oid),
540                "prosupport" => Inline(ColumnType::Regproc),
541                "prokind" => Inline(ColumnType::InternalChar),
542                "prosecdef" => Inline(ColumnType::Boolean),
543                "proleakproof" => Inline(ColumnType::Boolean),
544                "proisstrict" => Inline(ColumnType::Boolean),
545                "proretset" => Inline(ColumnType::Boolean),
546                "provolatile" => Inline(ColumnType::InternalChar),
547                "proparallel" => Inline(ColumnType::InternalChar),
548                "pronargs" => Inline(ColumnType::SmallInteger),
549                "pronargdefaults" => Inline(ColumnType::SmallInteger),
550                "prorettype" => Inline(ColumnType::Oid),
551                "proargtypes" => Inline(ColumnType::OidVector),
552                "proallargtypes" => Array(ColumnType::Oid),
553                "proargmodes" => Array(ColumnType::InternalChar),
554                "proargnames" => Array(ColumnType::Text),
555                "proargdefaults" => Inline(ColumnType::PgNodeTree),
556                "protrftypes" => Array(ColumnType::Oid),
557                "prosrc" => Inline(ColumnType::Text),
558                "probin" => Inline(ColumnType::Text),
559                "prosqlbody" => Inline(ColumnType::PgNodeTree),
560                "proconfig" => Array(ColumnType::Text),
561                "proacl" => Array(ColumnType::AclItem),
562            ],
563            Self::PgLanguage => columns![
564                "oid" => Inline(ColumnType::Oid),
565                "lanname" => Inline(ColumnType::Name),
566                "lanowner" => Inline(ColumnType::Oid),
567                "lanispl" => Inline(ColumnType::Boolean),
568                "lanpltrusted" => Inline(ColumnType::Boolean),
569                "lanplcallfoid" => Inline(ColumnType::Oid),
570                "laninline" => Inline(ColumnType::Oid),
571                "lanvalidator" => Inline(ColumnType::Oid),
572                "lanacl" => Array(ColumnType::AclItem),
573            ],
574            Self::PgExtension => columns![
575                "oid" => Inline(ColumnType::Oid),
576                "extname" => Inline(ColumnType::Name),
577                "extowner" => Inline(ColumnType::Oid),
578                "extnamespace" => Inline(ColumnType::Oid),
579                "extrelocatable" => Inline(ColumnType::Boolean),
580                "extversion" => Inline(ColumnType::Text),
581                "extconfig" => Array(ColumnType::Oid),
582                "extcondition" => Array(ColumnType::Text),
583            ],
584            Self::PgDatabase => columns![
585                "oid" => Inline(ColumnType::Oid),
586                "datname" => Inline(ColumnType::Name),
587                "datdba" => Inline(ColumnType::Oid),
588                "encoding" => Inline(ColumnType::Integer),
589                "datlocprovider" => Inline(ColumnType::InternalChar),
590                "datistemplate" => Inline(ColumnType::Boolean),
591                "datallowconn" => Inline(ColumnType::Boolean),
592                "dathasloginevt" => Inline(ColumnType::Boolean),
593                "datconnlimit" => Inline(ColumnType::Integer),
594                "datfrozenxid" => Inline(ColumnType::Xid),
595                "datminmxid" => Inline(ColumnType::Xid),
596                "dattablespace" => Inline(ColumnType::Oid),
597                "datcollate" => Inline(ColumnType::Text),
598                "datctype" => Inline(ColumnType::Text),
599                "datlocale" => Inline(ColumnType::Text),
600                "daticurules" => Inline(ColumnType::Text),
601                "datcollversion" => Inline(ColumnType::Text),
602                "datacl" => Array(ColumnType::AclItem),
603            ],
604            Self::PgAuthid => columns![
605                "oid" => Inline(ColumnType::Oid),
606                "rolname" => Inline(ColumnType::Name),
607                "rolsuper" => Inline(ColumnType::Boolean),
608                "rolinherit" => Inline(ColumnType::Boolean),
609                "rolcreaterole" => Inline(ColumnType::Boolean),
610                "rolcreatedb" => Inline(ColumnType::Boolean),
611                "rolcanlogin" => Inline(ColumnType::Boolean),
612                "rolreplication" => Inline(ColumnType::Boolean),
613                "rolbypassrls" => Inline(ColumnType::Boolean),
614                "rolconnlimit" => Inline(ColumnType::Integer),
615                "rolpassword" => Inline(ColumnType::Text),
616                "rolvaliduntil" => Inline(ColumnType::TimestampTz),
617            ],
618            Self::PgAuthMembers => columns![
619                "oid" => Inline(ColumnType::Oid),
620                "roleid" => Inline(ColumnType::Oid),
621                "member" => Inline(ColumnType::Oid),
622                "grantor" => Inline(ColumnType::Oid),
623                "admin_option" => Inline(ColumnType::Boolean),
624                "inherit_option" => Inline(ColumnType::Boolean),
625                "set_option" => Inline(ColumnType::Boolean),
626            ],
627            Self::PgRoles => columns![
628                "rolname" => Inline(ColumnType::Name),
629                "rolsuper" => Inline(ColumnType::Boolean),
630                "rolinherit" => Inline(ColumnType::Boolean),
631                "rolcreaterole" => Inline(ColumnType::Boolean),
632                "rolcreatedb" => Inline(ColumnType::Boolean),
633                "rolcanlogin" => Inline(ColumnType::Boolean),
634                "rolreplication" => Inline(ColumnType::Boolean),
635                "rolconnlimit" => Inline(ColumnType::Integer),
636                "rolpassword" => Inline(ColumnType::Text),
637                "rolvaliduntil" => Inline(ColumnType::TimestampTz),
638                "rolbypassrls" => Inline(ColumnType::Boolean),
639                "rolconfig" => Array(ColumnType::Text),
640                "oid" => Inline(ColumnType::Oid),
641            ],
642            Self::PgUser => columns![
643                "usename" => Inline(ColumnType::Name),
644                "usesysid" => Inline(ColumnType::Oid),
645                "usecreatedb" => Inline(ColumnType::Boolean),
646                "usesuper" => Inline(ColumnType::Boolean),
647                "userepl" => Inline(ColumnType::Boolean),
648                "usebypassrls" => Inline(ColumnType::Boolean),
649                "passwd" => Inline(ColumnType::Text),
650                "valuntil" => Inline(ColumnType::TimestampTz),
651                "useconfig" => Array(ColumnType::Text),
652            ],
653            Self::PgCursors => columns![
654                "name" => Inline(ColumnType::Text),
655                "statement" => Inline(ColumnType::Text),
656                "is_holdable" => Inline(ColumnType::Boolean),
657                "is_binary" => Inline(ColumnType::Boolean),
658                "is_scrollable" => Inline(ColumnType::Boolean),
659                "creation_time" => Inline(ColumnType::TimestampTz),
660            ],
661            Self::PgPreparedStatements => columns![
662                "name" => Inline(ColumnType::Text),
663                "statement" => Inline(ColumnType::Text),
664                "prepare_time" => Inline(ColumnType::TimestampTz),
665                "parameter_types" => Array(ColumnType::Regtype),
666                "result_types" => Array(ColumnType::Regtype),
667                "from_sql" => Inline(ColumnType::Boolean),
668                "generic_plans" => Inline(ColumnType::BigInteger),
669                "custom_plans" => Inline(ColumnType::BigInteger),
670            ],
671            Self::PgSettings => columns![
672                "name" => Inline(ColumnType::Text),
673                "setting" => Inline(ColumnType::Text),
674                "unit" => Inline(ColumnType::Text),
675                "category" => Inline(ColumnType::Text),
676                "short_desc" => Inline(ColumnType::Text),
677                "extra_desc" => Inline(ColumnType::Text),
678                "context" => Inline(ColumnType::Text),
679                "vartype" => Inline(ColumnType::Text),
680                "source" => Inline(ColumnType::Text),
681                "min_val" => Inline(ColumnType::Text),
682                "max_val" => Inline(ColumnType::Text),
683                "enumvals" => Array(ColumnType::Text),
684                "boot_val" => Inline(ColumnType::Text),
685                "reset_val" => Inline(ColumnType::Text),
686                "sourcefile" => Inline(ColumnType::Text),
687                "sourceline" => Inline(ColumnType::Integer),
688                "pending_restart" => Inline(ColumnType::Boolean),
689            ],
690            Self::PgDescription => columns![
691                "objoid" => Inline(ColumnType::Oid),
692                "classoid" => Inline(ColumnType::Oid),
693                "objsubid" => Inline(ColumnType::Integer),
694                "description" => Inline(ColumnType::Text),
695            ],
696            Self::PgDepend => columns![
697                "classid" => Inline(ColumnType::Oid),
698                "objid" => Inline(ColumnType::Oid),
699                "objsubid" => Inline(ColumnType::Integer),
700                "refclassid" => Inline(ColumnType::Oid),
701                "refobjid" => Inline(ColumnType::Oid),
702                "refobjsubid" => Inline(ColumnType::Integer),
703                "deptype" => Inline(ColumnType::InternalChar),
704            ],
705            Self::PgShdepend => columns![
706                "dbid" => Inline(ColumnType::Oid),
707                "classid" => Inline(ColumnType::Oid),
708                "objid" => Inline(ColumnType::Oid),
709                "objsubid" => Inline(ColumnType::Integer),
710                "refclassid" => Inline(ColumnType::Oid),
711                "refobjid" => Inline(ColumnType::Oid),
712                "deptype" => Inline(ColumnType::InternalChar),
713            ],
714            Self::PgMatviews => columns![
715                "schemaname" => Inline(ColumnType::Name),
716                "matviewname" => Inline(ColumnType::Name),
717                "matviewowner" => Inline(ColumnType::Name),
718                "tablespace" => Inline(ColumnType::Name),
719                "hasindexes" => Inline(ColumnType::Boolean),
720                "ispopulated" => Inline(ColumnType::Boolean),
721                "definition" => Inline(ColumnType::Text),
722            ],
723            Self::PgSequences => columns![
724                "schemaname" => Inline(ColumnType::Name),
725                "sequencename" => Inline(ColumnType::Name),
726                "sequenceowner" => Inline(ColumnType::Name),
727                "data_type" => Inline(ColumnType::Regtype),
728                "start_value" => Inline(ColumnType::BigInteger),
729                "min_value" => Inline(ColumnType::BigInteger),
730                "max_value" => Inline(ColumnType::BigInteger),
731                "increment_by" => Inline(ColumnType::BigInteger),
732                "cycle" => Inline(ColumnType::Boolean),
733                "cache_size" => Inline(ColumnType::BigInteger),
734                "last_value" => Inline(ColumnType::BigInteger),
735            ],
736            Self::AgGraph => columns![
737                "graphid" => Inline(ColumnType::Oid),
738                "name" => Inline(ColumnType::Name),
739                "namespace" => Inline(ColumnType::Regnamespace),
740            ],
741            Self::AgLabel => columns![
742                "name" => Inline(ColumnType::Name),
743                "graph" => Inline(ColumnType::Oid),
744                "id" => Domain(u32::try_from(oids::stable_oid("type", "ag_catalog.label_id")).expect("AGE type OID")),
745                "kind" => Domain(u32::try_from(oids::stable_oid("type", "ag_catalog.label_kind")).expect("AGE type OID")),
746                "relation" => Inline(ColumnType::Regclass),
747                "seq_name" => Inline(ColumnType::Name),
748            ],
749        }
750    }
751}
752
753fn ag_catalog_domain(name: &str) -> ColumnType {
754    system_catalog_domain(ag_catalog_type_oid(name)).expect("AGE catalog type declaration")
755}
756
757/// Stable OID of an `ag_catalog` type; the extension assigns these from
758/// the OID counter, so any collision-free assignment is faithful.
759pub fn ag_catalog_type_oid(name: &str) -> u32 {
760    let oid = oids::stable_oid("type", &format!("{AG_CATALOG_SCHEMA}.{name}"));
761    u32::try_from(oid).unwrap_or(0)
762}
763
764/// AGE `label_id`: `int NOT NULL CHECK (VALUE > 0 AND VALUE <= 65535)`.
765pub fn ag_label_id() -> ColumnType {
766    ag_catalog_domain("label_id")
767}
768
769/// AGE `label_kind`: `"char" NOT NULL CHECK (VALUE = 'v' OR VALUE = 'e')`.
770pub fn ag_label_kind() -> ColumnType {
771    ag_catalog_domain("label_kind")
772}
773
774/// Internal type carrier for AGE's fixed-width `graphid` base type.
775pub fn age_graphid() -> ColumnType {
776    ag_catalog_domain("graphid")
777}
778
779/// Internal type carrier for AGE's JSONB-shaped `agtype` base type.
780pub fn age_agtype() -> ColumnType {
781    ag_catalog_domain("agtype")
782}
783
784pub fn ag_catalog_domains() -> Vec<ColumnType> {
785    vec![ag_label_id(), ag_label_kind()]
786}
787
788/// The fixed system catalog domain with this OID: the `information_schema` domains and the AGE catalog types.
789#[must_use]
790pub fn system_catalog_domain(oid: u32) -> Option<ColumnType> {
791    system_catalog_domain_with_control(oid, &uqa_core::memory::ProductionControl::uncontrolled())
792        .expect("ordinary system domain projection cannot be cancelled or limited")
793        .map(|ty| {
794            ty.into_uncontrolled()
795                .expect("ordinary system domain projection")
796        })
797}
798
799fn cardinal_number() -> ColumnType {
800    system_catalog_domain(13_307).expect("cardinal_number catalog declaration")
801}
802
803fn character_data() -> ColumnType {
804    system_catalog_domain(13_310).expect("character_data catalog declaration")
805}
806
807fn sql_identifier() -> ColumnType {
808    system_catalog_domain(13_312).expect("sql_identifier catalog declaration")
809}
810
811fn time_stamp() -> ColumnType {
812    system_catalog_domain(13_318).expect("time_stamp catalog declaration")
813}
814
815fn yes_or_no() -> ColumnType {
816    system_catalog_domain(13_320).expect("yes_or_no catalog declaration")
817}
818
819pub fn information_schema_domains() -> Vec<ColumnType> {
820    vec![
821        cardinal_number(),
822        character_data(),
823        sql_identifier(),
824        time_stamp(),
825        yes_or_no(),
826    ]
827}
828
829fn information_routines_columns(visit: &mut dyn FnMut(&'static str, CatalogColumnType)) {
830    macro_rules! columns {
831        ($($name:literal => $ty:expr),* $(,)?) => {
832            { $(visit($name, $ty);)* }
833        };
834    }
835
836    columns![
837        "specific_catalog" => Domain(13312),
838        "specific_schema" => Domain(13312),
839        "specific_name" => Domain(13312),
840        "routine_catalog" => Domain(13312),
841        "routine_schema" => Domain(13312),
842        "routine_name" => Domain(13312),
843        "routine_type" => Domain(13310),
844        "module_catalog" => Domain(13312),
845        "module_schema" => Domain(13312),
846        "module_name" => Domain(13312),
847        "udt_catalog" => Domain(13312),
848        "udt_schema" => Domain(13312),
849        "udt_name" => Domain(13312),
850        "data_type" => Domain(13310),
851        "character_maximum_length" => Domain(13307),
852        "character_octet_length" => Domain(13307),
853        "character_set_catalog" => Domain(13312),
854        "character_set_schema" => Domain(13312),
855        "character_set_name" => Domain(13312),
856        "collation_catalog" => Domain(13312),
857        "collation_schema" => Domain(13312),
858        "collation_name" => Domain(13312),
859        "numeric_precision" => Domain(13307),
860        "numeric_precision_radix" => Domain(13307),
861        "numeric_scale" => Domain(13307),
862        "datetime_precision" => Domain(13307),
863        "interval_type" => Domain(13310),
864        "interval_precision" => Domain(13307),
865        "type_udt_catalog" => Domain(13312),
866        "type_udt_schema" => Domain(13312),
867        "type_udt_name" => Domain(13312),
868        "scope_catalog" => Domain(13312),
869        "scope_schema" => Domain(13312),
870        "scope_name" => Domain(13312),
871        "maximum_cardinality" => Domain(13307),
872        "dtd_identifier" => Domain(13312),
873        "routine_body" => Domain(13310),
874        "routine_definition" => Domain(13310),
875        "external_name" => Domain(13310),
876        "external_language" => Domain(13310),
877        "parameter_style" => Domain(13310),
878        "is_deterministic" => Domain(13320),
879        "sql_data_access" => Domain(13310),
880        "is_null_call" => Domain(13320),
881        "sql_path" => Domain(13310),
882        "schema_level_routine" => Domain(13320),
883        "max_dynamic_result_sets" => Domain(13307),
884        "is_user_defined_cast" => Domain(13320),
885        "is_implicitly_invocable" => Domain(13320),
886        "security_type" => Domain(13310),
887        "to_sql_specific_catalog" => Domain(13312),
888        "to_sql_specific_schema" => Domain(13312),
889        "to_sql_specific_name" => Domain(13312),
890        "as_locator" => Domain(13320),
891        "created" => Domain(13318),
892        "last_altered" => Domain(13318),
893        "new_savepoint_level" => Domain(13320),
894        "is_udt_dependent" => Domain(13320),
895        "result_cast_from_data_type" => Domain(13310),
896        "result_cast_as_locator" => Domain(13320),
897        "result_cast_char_max_length" => Domain(13307),
898        "result_cast_char_octet_length" => Domain(13307),
899        "result_cast_char_set_catalog" => Domain(13312),
900        "result_cast_char_set_schema" => Domain(13312),
901        "result_cast_char_set_name" => Domain(13312),
902        "result_cast_collation_catalog" => Domain(13312),
903        "result_cast_collation_schema" => Domain(13312),
904        "result_cast_collation_name" => Domain(13312),
905        "result_cast_numeric_precision" => Domain(13307),
906        "result_cast_numeric_precision_radix" => Domain(13307),
907        "result_cast_numeric_scale" => Domain(13307),
908        "result_cast_datetime_precision" => Domain(13307),
909        "result_cast_interval_type" => Domain(13310),
910        "result_cast_interval_precision" => Domain(13307),
911        "result_cast_type_udt_catalog" => Domain(13312),
912        "result_cast_type_udt_schema" => Domain(13312),
913        "result_cast_type_udt_name" => Domain(13312),
914        "result_cast_scope_catalog" => Domain(13312),
915        "result_cast_scope_schema" => Domain(13312),
916        "result_cast_scope_name" => Domain(13312),
917        "result_cast_maximum_cardinality" => Domain(13307),
918        "result_cast_dtd_identifier" => Domain(13312),
919    ];
920}
921
922#[cfg(test)]
923mod tests;
924
925pub mod analysis;
926
927pub mod array_type_names;
928
929pub mod composite_type;
930pub mod domain;
931pub mod enum_type;
932pub mod events;
933pub mod foreign_server;
934pub mod foreign_wrapper;
935pub mod index;
936pub mod range_type;
937pub mod roles;
938pub mod shell_type;
939
940/// Namespaces the engine implements without a durable schema row: the
941/// `PostgreSQL` system schemas and the Apache AGE catalog schema.
942pub fn is_virtual_system_schema(name: &str) -> bool {
943    matches!(name, "pg_catalog" | "information_schema" | "ag_catalog")
944}
945
946pub mod view;
947
948pub mod session;
949
950pub mod constraints;
951
952pub mod dependencies;
953
954pub const DATABASE_NAME: &str = "uqa";
955pub const DATABASE_OID: i64 = 5;
956
957pub mod stored_ast;
958
959pub mod regrole_dependencies;
960
961pub mod graph_oids;
962pub mod relation_attributes;
963pub mod relation_oids;
964pub mod temporary_namespace;
965
966pub mod security;
967
968pub mod stored_view;
969
970pub mod errors;
971
972pub mod sequence_functions;
973
974pub mod json_path;