Enum DatabaseWarning 

pub enum DatabaseWarning {
    MissingRelation {
        query_name: String,
        sql_source: String,
    },
    MissingFunction {
        mutation_name: String,
        sql_source: String,
    },
    MissingTypeSource {
        type_name: String,
        sql_source: String,
    },
    MissingAdditionalView {
        query_name: String,
        view_name: String,
    },
    MissingJsonColumn {
        query_name: String,
        sql_source: String,
        column_name: String,
    },
    WrongJsonColumnType {
        query_name: String,
        sql_source: String,
        column_name: String,
        actual_type: String,
    },
    MissingPaginationColumn {
        query_name: String,
        sql_source: String,
        column_name: String,
    },
    MissingIdentityColumn {
        query_name: String,
        sql_source: String,
        pk_column: String,
    },
    SelfOrderingView {
        query_name: String,
        sql_source: String,
    },
    MissingCursorColumn {
        query_name: String,
        sql_source: String,
        column_name: String,
    },
    MissingJsonKey {
        query_name: String,
        type_name: String,
        sql_source: String,
        json_column: String,
        field_name: String,
        json_key: String,
        field_required: bool,
    },
    NativeColumnFallback {
        query_name: String,
        sql_source: String,
        arg_name: String,
    },
    UnresolvableFilter {
        query_name: String,
        sql_source: String,
        filter: QueryFilter,
        key: String,
        reason: InjectMiss,
    },
    TypeConvertibility {
        query_name: String,
        sql_source: String,
        arg_name: String,
        graphql_type: String,
        column_type: String,
    },
    TemporalKeyInDocument {
        query_name: String,
        sql_source: String,
        field: String,
        column: String,
        remedy: TemporalKeyRemedy,
    },
    TviewIndexMissing {
        query_name: String,
        tview: String,
        keys: Vec<String>,
        options: Value,
    },
    NativeKeyDisagreement {
        query_name: String,
        sql_source: String,
        column: String,
        json_column: String,
        sampled: u64,
        disagreeing: u64,
    },
}

A single database validation warning.

Variants

MissingRelation

L1: sql_source relation does not exist.

Fields

query_name: String

Name of the query or mutation.

sql_source: String

The sql_source value that was not found.

MissingFunction

L1: a mutation’s sql_source function does not exist.

Distinct from MissingRelation: a mutation’s sql_source names a SQL function (the runtime calls SELECT * FROM fn(...)), not a view/table, so it is probed via pg_proc rather than the relation catalog.

Fields

mutation_name: String

Name of the mutation.

sql_source: String

The sql_source function that was not found.

MissingTypeSource

L1: a @fraiseql.type’s declared sql_source view does not exist (#653).

Most often an embedded value object the SDK gave a synthesized v_<name> source by naming convention (a view that was never authored). Advisory only — it never fails the compile; the hard FRAISEQL_VALIDATE_SQL_SOURCES gate deliberately does not probe type sources (it would drown in synthesized-source noise), so this warn-grade path under --database is the only place phantom type sources surface.

Fields

type_name: String

Name of the type.

sql_source: String

The sql_source view that was not found.

MissingAdditionalView

L1: additional_view does not exist.

Fields

query_name: String

Name of the query.

view_name: String

The view name that was not found.

MissingJsonColumn

L2: jsonb_column does not exist on the relation.

Fields

query_name: String

Name of the query.

sql_source: String

The sql_source relation.

column_name: String

The missing column name.

WrongJsonColumnType

L2: jsonb_column exists but is not a JSON/JSONB type.

Fields

query_name: String

Name of the query.

sql_source: String

The sql_source relation.

column_name: String

The column name.

actual_type: String

The actual SQL data type.

MissingPaginationColumn

L2: an authored pagination_order column does not exist on the relation (#1303).

The same shape as MissingCursorColumn and error-grade for the same reason: the column is rendered into ORDER BY, so a name the relation does not carry is a query that fails at request time, on a route that compiled cleanly.

Fields

query_name: String

Name of the query.

sql_source: String

The sql_source relation.

column_name: String

The missing column name.

MissingIdentityColumn

L2: the query’s pages are ordered by the type’s identity, and its relation exposes neither pk_<type> nor an id column to order them by (#1569).

An error: ADR-0017 makes id a base column of every read table and view, and the identity is never read out of the document, so the compiled ORDER BY would fail at the first paged read.

Fields

query_name: String

Name of the query.

sql_source: String

The sql_source relation.

pk_column: String

The pk_<type> column that would have been used had it existed.

SelfOrderingView

L2: the view carries its own ORDER BY and the query did not declare pagination_order = "none" (#1303).

The one case where ordering pages by the entity identity is a regression: a self-ordering view is the compiler’s own documented remedy for order_by = false, and a default ordering replaces the author’s order rather than adding to it. Advisory rather than error-grade because pg_get_viewdef cannot tell a top-level ORDER BY from one inside a subquery or window frame, where imposing a page order is entirely correct — so this reports a suspicion, and the author resolves it by declaring either way.

Fields

query_name: String

Name of the query.

sql_source: String

The sql_source view.

MissingCursorColumn

L2: relay_cursor_column does not exist on the relation.

Fields

query_name: String

Name of the query.

sql_source: String

The sql_source relation.

column_name: String

The missing cursor column name.

MissingJsonKey

L3: a JSON key path is declared but not found in sampled data.

Fields

query_name: String

Name of the query.

type_name: String

The GraphQL type that declares the field (where to fix it).

sql_source: String

The sql_source relation.

json_column: String

The JSON column being sampled.

field_name: String

The GraphQL field name.

json_key: String

The snake_case key looked up in the JSON.

field_required: bool

Whether the field is declared non-nullable. A required field’s key cannot legitimately be absent from every sampled row, so this drives the finding’s Severity: required → error, nullable → warning.

NativeColumnFallback

L2: a direct query argument has no matching native column — will fall back to JSONB extraction.

For best performance, consider adding a native column with the same name and an index on the sql_source table/view.

Fields

query_name: String

Name of the query.

sql_source: String

The sql_source relation.

arg_name: String

The argument name that has no matching native column.

UnresolvableFilter

A filter the query’s relation cannot provide — an inject_params key (#1382) or a direct argument (#1394): no column of that name, and no sampled data row carrying it — so the predicate is false for every row and every caller gets an empty, successful answer.

Fields

query_name: String

Name of the query.

sql_source: String

The sql_source relation.

filter: QueryFilter

What filters the relation.

key: String

The column / JSON key the runtime reads for it.

reason: InjectMiss

Why the relation cannot provide it.

TypeConvertibility

L2: a direct query argument resolves to a native column whose SQL type cannot cleanly drive the predicate for the argument’s GraphQL scalar type (e.g. an Int argument filtering a uuid column — WHERE col = $N errors or never matches).

Fields

query_name: String

Name of the query.

sql_source: String

The sql_source relation.

arg_name: String

The argument name.

graphql_type: String

The argument’s declared GraphQL type (e.g. Int).

column_type: String

The native column’s SQL type (e.g. uuid).

TemporalKeyInDocument

L2: a query sorts or filters a DateTime, Date or Time field it reads out of its relation’s document (#1571). The runtime compares (data->>'key')::timestamptz, a cast PostgreSQL will not index (it depends on the session’s TimeZone), so every sort or filter on the key reads every row. A native column of the type, mapped by an argument of the field’s name, is read instead, and an index on it serves both.

Fields

query_name: String

Name of the query.

sql_source: String

The sql_source relation.

field: String

The field, as the schema names it.

column: String

The column the runtime would read for it.

remedy: TemporalKeyRemedy

What would let an index serve the field.

TviewIndexMissing

L2: a query filters a TVIEW’s document on keys no index of the TVIEW serves (#1571): its inject parameters and arguments that read data->>'key', on every call. pg_tviews keeps an index declared with the TVIEW (its indexes option) over its rebuilds.

Fields

query_name: String

Name of the query.

tview: String

The TVIEW’s table, schema-qualified.

keys: Vec<String>

The document keys it filters on, in the index’s order.

options: Value

The TVIEW’s options with the index added: the whole declaration a replace must pass, since one without indexes drops them.

NativeKeyDisagreement

L3 (#1579): a query is scoped by an inject_params column that is a native column of its relation, its type publishes the key as a field, and sampled rows hold a different value in the column than in the document. The root read filters on the column and an embedded document of the type on the key: they must agree.

Fields

query_name: String

Name of the query.

sql_source: String

The sql_source relation.

column: String

The native column, and the document key of the same name.

json_column: String

The JSON column holding the document.

sampled: u64

Rows sampled.

disagreeing: u64

Rows whose column and key differ.

Implementations

impl DatabaseWarning

pub fn statement(&self) -> Option<String>

For TviewIndexMissing: the statement that declares the index with the TVIEW, keeping its definition and its other options. None for any other warning.

impl DatabaseWarning

pub const fn severity(&self) -> Severity

The severity of this finding under compile --database (#384).

Error-severity drift fails the compile (unless --allow-drift): the declared schema names database objects that do not exist or cannot serve the declared shape, so the first query/mutation against them fails at runtime. Warn-severity findings are advisory:

• MissingTypeSource is warn-grade by design (#653): synthesized value-object sources would drown a hard gate.
• MissingJsonKey is sampling-based; a nullable field may legitimately be unset in every sampled row, so only a required field’s absent key is an error.
• NativeColumnFallback is a performance advisory — the JSONB path is correct, just slower.

Trait Implementations

impl Debug for DatabaseWarning

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for DatabaseWarning

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.