Class ActorOptimizeQueryOperationFilterPushdown

A comunica Filter Pushdown Optimize Query Operation Actor.

Hierarchy (View Summary)

ActorOptimizeQueryOperation
- ActorOptimizeQueryOperationFilterPushdown

Constructors

constructor

new ActorOptimizeQueryOperationFilterPushdown(
args: IActorOptimizeQueryOperationFilterPushdownArgs,
): ActorOptimizeQueryOperationFilterPushdown
Parameters
- args: IActorOptimizeQueryOperationFilterPushdownArgs
Returns ActorOptimizeQueryOperationFilterPushdown
Overrides ActorOptimizeQueryOperation.constructor
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:27

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionOptimizeQueryOperation,
    IActorTest,
    IActorOptimizeQueryOperationOutput,
    undefined,
>[] = []

Actor that must be registered in the bus before this actor.

`Readonly`bus

bus: Bus<
    Actor<
        IActionOptimizeQueryOperation,
        IActorTest,
        IActorOptimizeQueryOperationOutput,
        undefined,
    >,
    IActionOptimizeQueryOperation,
    IActorTest,
    IActorOptimizeQueryOperationOutput,
    undefined,
>

The bus this actor subscribes to.

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

Methods

filterPushdown

filterPushdown(
    expression: Expression,
    expressionVariables: Variable[],
    operation: Operation,
    factory: Factory,
    context: IActionContext,
): [boolean, Operation]
Recursively push down the given expression into the given operation if possible. Different operators have different semantics for choosing whether or not to push down, and how this pushdown is done. For every passed operator, it is checked whether or not the filter will have any effect on the operation. If not, the filter is voided.
Parameters
- expression: Expression
  An expression to push down.
- expressionVariables: Variable[]
  The variables inside the given expression.
- operation: Operation
  The operation to push down into.
- factory: Factory
  An algebra factory.
- context: IActionContext
  The action context.
Returns [boolean, Operation]
A tuple indicating if the operation was modified and the modified operation.
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:261

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
Inherited from ActorOptimizeQueryOperation.getDefaultLogData
- Defined in core/lib/Actor.ts:95

getEqualityExpressionPushableIntoPattern

getEqualityExpressionPushableIntoPattern(
expression: Expression,
): undefined | { term: Term; variable: Variable }
Check if the given expression is a simple equals operation with one variable and one non-literal (or literal with canonical lexical form) term that can be pushed into a pattern.
Parameters
- expression: Expression
  The current expression.
Returns undefined | { term: Term; variable: Variable }
The variable and term to fill into the pattern, or undefined.
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:502

getExpressionVariables

getExpressionVariables(expression: Expression): Variable[]
Get all variables inside the given expression.
Parameters
- expression: Expression
  An expression.
Returns Variable[]
An array of variables, or undefined if the expression is unsupported for pushdown.
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:200

getNestedFilterExpressions

getNestedFilterExpressions(
op: Filter,
): { input: Operation; nestedExpressions: Expression[] }
Get all directly nested filter expressions. As soon as a non-filter is found, it is returned as the input field.
Parameters
- op: Filter
  A filter expression.
Returns { input: Operation; nestedExpressions: Expression[] }
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:588

`Protected`getOverlappingOperations

getOverlappingOperations(
    operation: Operation,
    expressionVariables: Variable[],
): {
    fullyOverlapping: Operation[];
    notOverlapping: Operation[];
    partiallyOverlapping: Operation[];
}
Parameters
- operation: Operation
- expressionVariables: Variable[]
Returns {
    fullyOverlapping: Operation[];
    notOverlapping: Operation[];
    partiallyOverlapping: Operation[];
}
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:219

getSources

getSources(operation: Operation): IQuerySourceWrapper<IQuerySource>[]
Collected all sources that are defined within the given operation of children recursively.
Parameters
- operation: Operation
  An operation.
Returns IQuerySourceWrapper<IQuerySource>[]
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:177

isExpressionFalse

isExpressionFalse(expression: Expression): boolean
Check if an expression is simply 'false'.
Parameters
- expression: Expression
  An expression.
Returns boolean
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:579

`Protected`isLiteralWithCanonicalLexicalForm

isLiteralWithCanonicalLexicalForm(term: Term): boolean
Protected
Check if the given term is a literal with datatype that where all values can only have one possible lexical representation. In other words, no variants of values exist that should be considered equal. For example: "01"^xsd:number and "1"^xsd:number will return false.
Parameters
- term: Term
  An RDF term.
Returns boolean
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:535

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorOptimizeQueryOperation.logDebug
- Defined in core/lib/Actor.ts:108

`Protected`logError

logError(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorOptimizeQueryOperation.logError
- Defined in core/lib/Actor.ts:129

`Protected`logFatal

logFatal(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorOptimizeQueryOperation.logFatal
- Defined in core/lib/Actor.ts:136

`Protected`logInfo

logInfo(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorOptimizeQueryOperation.logInfo
- Defined in core/lib/Actor.ts:115

`Protected`logTrace

logTrace(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorOptimizeQueryOperation.logTrace
- Defined in core/lib/Actor.ts:101

`Protected`logWarn

logWarn(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorOptimizeQueryOperation.logWarn
- Defined in core/lib/Actor.ts:122

run

run(
action: IActionOptimizeQueryOperation,
): Promise<IActorOptimizeQueryOperationOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionOptimizeQueryOperation
  The action to run.
Returns Promise<IActorOptimizeQueryOperationOutput>
A promise that resolves to the run result.
Overrides ActorOptimizeQueryOperation.run
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:35

runObservable

runObservable(
action: IActionOptimizeQueryOperation,
sideData: undefined,
): Promise<IActorOptimizeQueryOperationOutput>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionOptimizeQueryOperation
  The action to run.
- sideData: undefined
Returns Promise<IActorOptimizeQueryOperationOutput>
A promise that resolves to the run result.
Inherited from ActorOptimizeQueryOperation.runObservable
- Defined in core/lib/Actor.ts:87

shouldAttemptPushDown

shouldAttemptPushDown(
    operation: Filter,
    sources: IQuerySourceWrapper<IQuerySource>[],
    sourceShapes: Map<IQuerySourceWrapper<IQuerySource>, FragmentSelectorShape>,
): boolean
Check if the given filter operation must be attempted to push down, based on the following criteria:
- Always push down if aggressive mode is enabled
- Push down if the filter is extremely selective
- Push down if federated and at least one accepts the filter
Parameters
- operation: Filter
  The filter operation
- sources: IQuerySourceWrapper<IQuerySource>[]
  The query sources in the operation
- sourceShapes: Map<IQuerySourceWrapper<IQuerySource>, FragmentSelectorShape>
  A mapping of sources to selector shapes.
Returns boolean
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:143

test

test(_action: IActionOptimizeQueryOperation): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- _action: IActionOptimizeQueryOperation
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Overrides ActorOptimizeQueryOperation.test
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:31

variablesIntersect

variablesIntersect(varsA: Variable[], varsB: Variable[]): boolean
Check if there is an overlap between the two given lists of variables.
Parameters
- varsA: Variable[]
  A list of variables.
- varsB: Variable[]
  A list of variables.
Returns boolean
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:560

variablesSubSetOf

variablesSubSetOf(varsNeedles: Variable[], varsHaystack: Variable[]): boolean
Check if all variables from the first list are included in the second list. The second list may contain other variables as well.
Parameters
- varsNeedles: Variable[]
  A list of variables to search for.
- varsHaystack: Variable[]
  A list of variables to search in.
Returns boolean
- Defined in actor-optimize-query-operation-filter-pushdown/lib/ActorOptimizeQueryOperationFilterPushdown.ts:570

`Static`getContextLogger

getContextLogger(context: IActionContext): undefined | Logger
Get the logger from the given context.
Parameters
- context: IActionContext
  An optional context.
Returns undefined | Logger
The logger or undefined.
Inherited from ActorOptimizeQueryOperation.getContextLogger
- Defined in core/lib/Actor.ts:56

Class ActorOptimizeQueryOperationFilterPushdown

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorOptimizeQueryOperationFilterPushdown

Properties

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

Methods

filterPushdown

Parameters

Returns [boolean, Operation]

ProtectedgetDefaultLogData

Parameters

Returns any

getEqualityExpressionPushableIntoPattern

Parameters

Returns undefined | { term: Term; variable: Variable }

getExpressionVariables

Parameters

Returns Variable[]

getNestedFilterExpressions

Parameters

Returns { input: Operation; nestedExpressions: Expression[] }

ProtectedgetOverlappingOperations

Parameters

Returns { fullyOverlapping: Operation[]; notOverlapping: Operation[]; partiallyOverlapping: Operation[];}

getSources

Parameters

Returns IQuerySourceWrapper<IQuerySource>[]

isExpressionFalse

Parameters

Returns boolean

ProtectedisLiteralWithCanonicalLexicalForm

Parameters

Returns boolean

ProtectedlogDebug

Parameters

Returns void

ProtectedlogError

Parameters

Returns void

ProtectedlogFatal

Parameters

Returns void

ProtectedlogInfo

Parameters

Returns void

ProtectedlogTrace

Parameters

Returns void

ProtectedlogWarn

Parameters

Returns void

run

Parameters

Returns Promise<IActorOptimizeQueryOperationOutput>

runObservable

Parameters

Returns Promise<IActorOptimizeQueryOperationOutput>

shouldAttemptPushDown

Parameters

Returns boolean

test

Parameters

Returns Promise<TestResult<IActorTest>>

variablesIntersect

Parameters

Returns boolean

variablesSubSetOf

Parameters

Returns boolean

StaticgetContextLogger

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Protected`getDefaultLogData

`Protected`getOverlappingOperations

Returns {
fullyOverlapping: Operation[];
notOverlapping: Operation[];
partiallyOverlapping: Operation[];
}

`Protected`isLiteralWithCanonicalLexicalForm

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger