Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IActorQueryOperationOutputBindings

Query operation output for a bindings stream. For example: SPARQL SELECT results

Hierarchy

Index

Properties

bindingsStream

bindingsStream: BindingsStream

The stream of bindings resulting from the given operation.

canContainUndefs

canContainUndefs: boolean

If any of the bindings could contain an undefined variable binding. If this is false, then all variables are guaranteed to have a defined bound value in the bindingsStream.

Optional context

context: ActionContext

The resulting action context.

Optional metadata

metadata: undefined | (() => Promise<Record<string, any>>)

Callback that returns a promise that resolves to the metadata about the stream. This can contain things like the estimated number of total stream elements, or the order in which the bindings appear. This callback can be invoked multiple times. The actors that return this metadata will make sure that multiple calls properly cache this promise. Metadata will not be collected until this callback is invoked.

type

type: "bindings"

The type of output.

variables

variables: string[]

The list of variable names (without '?') for which bindings are provided in the stream.

Generated using TypeDoc