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