Class ExecutionContext

An execution context conatains control information for query execution.

Hierarchy

ExecutionContext

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ExecutionContext(): ExecutionContext

- Defined in src/engine/context/execution-context.ts:38
Returns ExecutionContext

Properties

Protected _cache

_cache: BGPCache | null

Protected _defaultGraphs

_defaultGraphs: string[]

Protected _hints

_hints: QueryHints

Protected _namedGraphs

_namedGraphs: string[]

Protected _properties

_properties: Map<Symbol, any>

Accessors

cache

get cache(): BGPCache | null
set cache(newCache: BGPCache | null): void

- Defined in src/engine/context/execution-context.ts:101
Get the BGP cache currently used by the query engine. returns null if caching is disabled

Returns BGPCache | null

The BGP cache currently used by the query engine, or null if caching is disabled.
- Defined in src/engine/context/execution-context.ts:110
Set the BGP cache currently used by the query engine. Use null to disable caching

Parameters
- newCache: BGPCache | null
  
  The BGP cache to use for caching.
Returns void

The BGP cache currently used by the query engine, or null if caching is disabled.

defaultGraphs

get defaultGraphs(): string[]
set defaultGraphs(values: string[]): void

- Defined in src/engine/context/execution-context.ts:52
The set of graphs used as the default graph

Returns string[]

The set of graphs used as the default graph
- Defined in src/engine/context/execution-context.ts:60
Update the set of graphs used as the default graph

Parameters
- values: string[]
  
  The set of graphs used as the default graph
Returns void

The set of graphs used as the default graph

hints

get hints(): QueryHints
set hints(newHints: QueryHints): void

- Defined in src/engine/context/execution-context.ts:84
Get query hints collected until now

Returns QueryHints

All query hints collected until now
- Defined in src/engine/context/execution-context.ts:92
Update the query hints

Parameters
- newHints: QueryHints
  
  New query hints
Returns void

All query hints collected until now

namedGraphs

get namedGraphs(): string[]
set namedGraphs(values: string[]): void

- Defined in src/engine/context/execution-context.ts:68
The set of graphs used as named graphs

Returns string[]

The set of graphs used as named graphs
- Defined in src/engine/context/execution-context.ts:76
Update the set of graphs used as named graphs

Parameters
- values: string[]
  
  The set of graphs used as named graphs
Returns void

The set of graphs used as named graphs

Methods

cachingEnabled

cachingEnabled(): boolean

- Defined in src/engine/context/execution-context.ts:118
Test the caching is enabled

Returns boolean

True if the caching is enabled, false otherwise

clone

clone(): ExecutionContext

- Defined in src/engine/context/execution-context.ts:153
Clone the execution context

Returns ExecutionContext

A clone of the execution context

getProperty

getProperty(key: Symbol): any | null

- Defined in src/engine/context/execution-context.ts:127
Get a property associated with a key

Parameters
- key: Symbol
  
  Key associated with the property
Returns any | null

The value associated with the key

hasProperty

hasProperty(key: Symbol): boolean

- Defined in src/engine/context/execution-context.ts:136
Test if the context contains a property associated with a key

Parameters
- key: Symbol
  
  Key associated with the property
Returns boolean

True if the context contains a property associated with the key

merge

merge(other: ExecutionContext): ExecutionContext

- Defined in src/engine/context/execution-context.ts:168
Merge the context with another execution context

Parameters
- other: ExecutionContext
  
  Execution context to merge with
Returns ExecutionContext

The merged execution context

setProperty

setProperty(key: Symbol, value: any): void

- Defined in src/engine/context/execution-context.ts:145
Set a (key, value) property in the context

Parameters
- key: Symbol
  
  Key of the property
- value: any
  
  Value of the property
Returns void

Generated using TypeDoc