Interface IQueryBindingsOptions

interface IQueryBindingsOptions {
    filterBindings?: {
        bindings: BindingsStream;
        metadata: MetadataBindings;
    };
    joinBindings?: { bindings: BindingsStream; metadata: MetadataBindings };
}

Properties

filterBindings?: { bindings: BindingsStream; metadata: MetadataBindings }

Bindings to filter the query operation's result by. This can only be done if the source accepts filterBindings in the selector shape.

The caller of this function should ensure that only bindings are being passed that are applicable to the query, which means that a projection and filtering step might be needed beforehand.

joinBindings?: { bindings: BindingsStream; metadata: MetadataBindings }

Bindings that must be joined by the source together with the operation. This can only be done if the source accepts joinBindings in the selector shape.

The passed bindings may optionally apply to different variables than the query. If this is not the case, then filterBindings should be used instead.