Interface FilterIncompatibleWithCursorableIndexScanNotice

interface FilterIncompatibleWithCursorableIndexScanNotice {
    category: "indexing";
    code: "filterIncompatibleWithCursorableIndexScan";
    containers?: ContainerReference[];
    grade: "D";
    hint: string;
    incompatibleFilterTypes?: string[];
    level: "warning";
    orHasNonEqualityBranches?: boolean;
    reasons: IncompatibleIndexScanReason[];
    resultExpression: string;
}

Properties

category: "indexing"
code: "filterIncompatibleWithCursorableIndexScan"
containers?: ContainerReference[]

Containers whose properties participate in a cross-container AND condition. The built-in space predicate is excluded from this list. This field is present when crossContainer is reported.

grade: "D"
hint: string
incompatibleFilterTypes?: string[]

Names of concrete filters that contributed to this notice, when available. For incompatibleLeafType, this identifies the operator itself, for example OverlapsFilter, AllFilter, or ContainedByFilter.

level: "warning"
orHasNonEqualityBranches?: boolean

Whether an OR filter contains branches other than equality predicates. This is meaningful when reasons contains orFilter; if false, rewrite the branches as in only when they are equality predicates on the same property.

Reasons why a filter is not recognized as compatible with efficient index-backed cursoring:

  • multipleRangePredicates: range, prefix, or exists applies to more than one property in an AND filter. Multiple bounds on one property are allowed.
  • crossContainer: An AND filter combines properties from multiple containers (space is excluded; type plus a container property still triggers this reason).
  • multipleNodeEdgeIndexGroups: Node/edge space and type use separate built-in index groups.
  • nestedFilter: A direct relation target is filtered, requiring a join. Denormalize the property onto the current instance when possible.
  • incompatibleLeafType: The leaf operator cannot be represented as a cursor-compatible predicate. See incompatibleFilterTypes.
  • nonCursorableProperty: The property cannot support a stable cursor scan, including list properties and non-cursorable node/edge built-ins such as externalId, createdTime, and lastUpdatedTime.
  • notFilter: Negation is generally not one ordered range. Rewrite only when null behavior is preserved; negated equals is exclusion, and negation of space equals/in is exempt for access control.
  • orFilter: OR branches cannot generally use one ordered cursor scan. If all branches are equality predicates on the same property, rewrite them as in; orHasNonEqualityBranches identifies non-equality branches.
resultExpression: string

Identifier for the result set expression that the notice applies to.