FORMAT

FORMAT returns canonical FeatureQL source without executing the statement or applying a mutation.

Syntax

FORMAT [(format_options)] statement

FORMAT [(format_options)]
<following statements in the same multi-statement request>

format_options ::=
    FIX
  | ESCAPED
  | WIDTH integer
  | option [, option ...]

FORMAT [(format_options)] statement

FORMAT [(format_options)]
<following statements in the same multi-statement request>

format_options ::=
    FIX
  | ESCAPED
  | WIDTH integer
  | option [, option ...]

When a statement follows directly, FORMAT renders that statement. Bare FORMAT renders the remaining statements in the same multi-statement request.

Options

• FIX migrates supported legacy spellings to strict syntax in addition to formatting layout.
• ESCAPED returns newline and other layout markers in an escaped representation used by tooling and tests.
• WIDTH integer controls the preferred output width.
• Options are comma-separated inside one parenthesized block.

FORMAT (FIX, WIDTH 88)
RETURN total:=price*quantity,price,quantity;

Formatting preserves semantics. It may normalize aliases, spacing, indentation, and dependency order where required by canonical rendering.

FORMAT is a statement. It is distinct from expression functions or operators named FORMAT.

See Formatting queries for strict-mode migrations, comment attachment, and worked examples. The short form is on Statement tools .