Keeps the rows of its input for which a condition is true (PLAN §11.11): a lambda of one row, as written in Query's text mode, x | $x.SHIPPED_DATE > $x.REQUIRED_DATE, which the engine checks against the cube's model. Until it has, for this input and this condition, the node waits (ERR_CHECKING). The columns stay as they are, and the rows kept stay in the input's order.

Hierarchy (View Summary)

Constructors

Properties

code: string

The condition's text, as the user typed it

id: string

Unique within the query and shown to users, e.g. filter101

key: number

Assigned at construction from a monotonic sequence: the node's identity for change detection

lambda: undefined | JsonObject

The engine's JSON for the text, a lambda, without source information and with its number literals as their digit strings, as an Extend column's (PLAN §11.7); undefined until the text is checked

rest: JsonObject

The keys of the node's saved JSON that this version does not know, kept so a re-save writes them back (PLAN §10.3); edits keep them too

Accessors

  • get acceptsNewInputs(): boolean

    Whether edits may change which nodes feed this one. Not for a node whose port semantics are unknown, such as an Unknown node.

    Returns boolean

  • get consumesInputOrder(): boolean

    Whether the node takes rows by their order, as a Limit does: the emitter then writes its input's order as a sort just before it (PLAN §11.4)

    Returns boolean

  • get portLabels(): readonly string[]

    Labels for the input ports, shown on the edges that feed them

    Returns readonly string[]

  • get ports(): readonly string[]

    The named input slots, in order: none for a source, one for a unary transform, two for a binary one

    Returns readonly string[]

Methods

  • The condition's first problem that needs no engine, undefined when it has none: a condition, a lambda of one row, and no backslash in a LIKE function's literal. The editor checks these before it asks the engine to check the condition.

    Returns undefined | string

  • Checks, in order: the condition's problems that need no engine (getConditionProblem); then the check: pending until the engine has checked this condition for this input (ERR_CHECKING), then why it couldn't, naming the condition's type when it isn't one Boolean

    Parameters

    • inputSchemas: readonly Schema[]
    • Optionalerrors: string[]

    Returns boolean

  • The node to keep once its two inputs swap ports: by default this node. A node whose settings name its inputs by side, such as a Join's key columns, returns a new node (same id) with those settings swapped too.

    Returns QueryNode