Skip to main content

Module semantics

Module semantics 

Source
Expand description

SQL semantics shared by static analysis and runtime adapters.

Modules§

age_cypher
SQL argument rules and result-column conversions for Apache AGE Cypher calls.
aggregates
Aggregate discovery and expression equivalence for SQL grouping.
conflict
Unique-index inference, target validation, and SQL predicate implication.
constraint_catalog
Read-only relation constraint declarations.
cte_names
Enumerate the CTE names owned by a query and its sources.
cte_validation
PostgreSQL statement ownership rules for data-modifying WITH definitions.
effects
Classify SQL plans by database, session, and transaction effects.
foreign_keys
Foreign-key comparison types, null matching, and normalized key values.
graph_commands
SQL argument coercion and diagnostics for native and AGE graph commands.
graph_functions
Graph-name selection and argument rules for SQL graph table functions.
grouping_sets
PostgreSQL-compatible grouping-set preparation after input schema binding.
join_predicates
Join conjunct analysis and structural side binding.
locking
SQL row-lock restrictions, propagation, and mutation lock strength.
merge
MERGE clause scopes, target privileges, and positional RETURNING schemas.
mutation_inputs
Row-independent mutation input shapes.
mutation_patch
Constraint dependency analysis for UPDATE’s storage patch path.
mutation_privileges
Mutation target privilege analysis.
mutation_qualifiers
Relation qualifier visibility in mutation expressions.
mutation_rows
Declared and hidden column schemas shared by mutation analysis and row execution.
partition
Declarative partition validation, value comparison, and routing semantics.
period
Canonical range values used by temporal keys and references.
portals
Cursor declaration restrictions and command descriptor diagnostics.
privileges
Semantic base-column privilege analysis for query sources.
referential
Foreign-key action discovery across partition and inheritance metadata.
retrieval
Retrieval argument binding and weight semantics, independent of physical search.
returning
RETURNING target schemas, alias visibility, projection expansion, and static analysis.
row_count
SQL LIMIT and OFFSET bigint conversion and diagnostics.
rules
Rewrite-rule declaration and RETURNING contracts.
runtime_scalars
Runtime scalar argument and row-context rules.
scalar_projection
Argument validation and short-circuit semantics for score and highlight projections.
sets
Set-returning expression binding, validation, and dependency rewriting.
source_filters
Source qualifier filters and checked SQL integer carriers.
table_function_arguments
Argument contracts for analyzer and session table functions.
text_indexes
Validation of text-retrieval field references against relation and index metadata.
view_mutation
View mutation target identity, declared columns, and rewrite-rule input analysis.
view_privileges
Privilege checks at each view boundary before DML rewrite or trigger dispatch.
view_rewrite
PostgreSQL 18 automatically updatable view analysis and DML rewriting.
volatility
SQL function volatility and expression rewrite safety over catalog metadata.
windows
Window expression classification.

Structs§

ResolvedJoinUsing
ResolvedUserTableFunction
TableFunctionTypeRequest

Enums§

MultiFieldMatchShape

Constants§

DOC_ID_COLUMN
META_DOC_ID_COLUMN
META_QUALIFIER
META_SCORE_COLUMN
SCORE_COLUMN
TABLE_OID_COLUMN
XMIN_COLUMN

Functions§

alias_join_schema
apply_table_function_aliases
bound_projection_expression
bound_source_column_names
bound_source_schema
builtin_function_dispatch_name
Resolve reserved system-schema aliases only when the local name belongs to that schema’s built-in surface. Ordinary qualified names stay intact for runtime callbacks and user-defined routine lookup.
collect_expr_qualifiers
collect_frame_bound_subquery_ids
collect_from_qualifiers
collect_subquery_ids
contains_retrieval
Whether a scalar expression contains a posting-list retrieval operator. Relational executors use the same classification as access-path planning so registered retrieval calls never fall through to scalar evaluation.
cte_reference_name
Decode a source reference into a CTE identifier. Qualified relations never resolve to CTEs.
cte_references_own_name
doc_id_value
expand_bound_projection_stars
expand_from_star_columns
expect_column_name
expr_contains_function
expr_contains_subquery
expr_has_unqualified_column
expr_is_null_free
True when the expression can never evaluate to SQL NULL for any row: registered search functions, IS NULL tests, and boolean combinations thereof. Anything referencing column comparisons may yield NULL, so set-complement NOT would be unsound for it.
expr_qualifiers
flatten_and_filter_parts
from_qualifier_set
fts_query_is_jsonpath
The @@ operator doubles as a JSONPath match when the right-hand side is a $... path literal; that form evaluates row-level JSON and needs no text index.
is_builtin_aggregate
is_builtin_table_function
is_json_array_table_function
is_semantic_field_argument
Return whether a registered function consumes this argument as a relation-field identifier rather than as a scalar row value.
join_alias_columns
join_alias_input_schemas
Add a parenthesized JOIN alias to the input-side schemas for null-rejection analysis. Merged FULL JOIN columns belong to neither side exclusively because their value is a coalesce of both inputs.
join_using_layout
join_using_output_schema
Bind the visible and hidden output identities of a qualified join without constructing or executing the join. Static source-schema binding and the physical operator share this layout so an empty or correlated right side cannot lose its declared types.
join_using_predicate
merge_action_attribute
Executor-only carrier for PostgreSQL 18’s merge_action() value. The attribute has no SQL name and therefore cannot collide with a target or source column named _merge_action.
multi_field_match_shape
order_cte_plans
ordered_cte_plans
ordered_plan_ctes
outer_join_nullable_qualifiers
Qualifiers whose rows can be synthesized as NULLs by an outer join cannot receive an arbitrary WHERE predicate before that join. A predicate such as right.id IS NULL accepts the synthesized row; pushing it into the right scan first can remove a real match, manufacture a NULL-extended row, and turn a non-result into a result. Keep predicates on these qualifiers above the outer join unless a separate rewrite has first reduced it to an inner join.
projection_columns
projection_label_at
Compute a projection’s PostgreSQL output column name. Standalone expressions use ?column?; repeated labels remain repeated until the final named-map compatibility boundary.
qualify_unqualified_columns
query_plan_output_columns
reachable_plan_cte_names
resolve_join_using
resolve_table_function_binding
resolve_user_table_function
retrieval_function
returning_context_schema
returning_expression_schema
scalar_table_function_default_column
select_execution_stmt
should_defer_distinct_limit
single_reference_plan_cte_names
Return reachable CTEs with exactly one syntactic reference in the owning query tree. Counting references outside their lexical visibility can only make this set more conservative, never cause a multiply referenced CTE to be streamed as a single-consumer input.
table_function_column_types
table_function_empty_schema
user_function_output_columns_for
validate_table_function_alias_count
validate_table_function_column_definition
virtual_relation_mutation_error
visible_projection_source_position

Type Aliases§

JoinUsingLayout