Class QueryEngineBase<QueryContext, QueryStringContextInner, QueryAlgebraContextInner>

Base implementation of a Comunica query engine.

Type Parameters

QueryContext extends IQueryContextCommon = IQueryContextCommon
QueryStringContextInner extends RDF.QueryStringContext = QueryStringContext
QueryAlgebraContextInner extends RDF.QueryAlgebraContext = QueryAlgebraContext

Hierarchy

QueryEngineBase

Implements

IQueryEngine<QueryStringContextInner, QueryAlgebraContextInner>

Index

Constructors

constructor

Methods

explain getResultMediaTypeFormats getResultMediaTypes invalidateHttpCache query queryBindings queryBoolean queryOfType queryOrExplain queryQuads queryVoid resultToString finalToInternalResult internalToFinalResult

Constructors

constructor

new QueryEngineBase<QueryContext, QueryStringContextInner, QueryAlgebraContextInner>(actorInitQuery): QueryEngineBase<QueryContext, QueryStringContextInner, QueryAlgebraContextInner>
Type Parameters
- QueryContext extends IQueryContextCommon = IQueryContextCommon
- QueryStringContextInner extends QueryStringContext = QueryStringContext
- QueryAlgebraContextInner extends QueryContext = QueryAlgebraContext
Parameters
- actorInitQuery: ActorInitQueryBase
Returns QueryEngineBase<QueryContext, QueryStringContextInner, QueryAlgebraContextInner>
- Defined in actor-init-query/lib/QueryEngineBase.ts:36

Methods

explain

explain<QueryFormatTypeInner>(query, context, explainMode): Promise<IQueryExplained>
Explain the given query
Type Parameters
- QueryFormatTypeInner extends QueryFormatType
Parameters
- query: QueryFormatTypeInner
  A query string or algebra.
- context: QueryFormatTypeInner extends string
  ? QueryStringContextInner
  : QueryAlgebraContextInner
  An optional query context.
- explainMode: QueryExplainMode
  The explain mode.
Returns Promise<IQueryExplained>
A promise that resolves to the query output or explanation.
Implementation of IQueryEngine.explain
- Defined in actor-init-query/lib/QueryEngineBase.ts:106

getResultMediaTypeFormats

getResultMediaTypeFormats(context?): Promise<Record<string, string>>
Parameters
- Optionalcontext: any
  An optional context.
Returns Promise<Record<string, string>>
All available SPARQL result media type formats.
Implementation of IQueryEngine.getResultMediaTypeFormats
- Defined in actor-init-query/lib/QueryEngineBase.ts:156

getResultMediaTypes

getResultMediaTypes(context?): Promise<Record<string, number>>
Parameters
- Optionalcontext: any
  An optional context.
Returns Promise<Record<string, number>>
All available SPARQL (weighted) result media types.
Implementation of IQueryEngine.getResultMediaTypes
- Defined in actor-init-query/lib/QueryEngineBase.ts:146

invalidateHttpCache

invalidateHttpCache(url?, context?): Promise<any>
Invalidate all internal caches related to the given page URL. If no page URL is given, then all pages will be invalidated.
Parameters
- Optionalurl: string
  The page URL to invalidate.
- Optionalcontext: any
  An optional ActionContext to pass to the actors.
Returns Promise<any>
A promise resolving when the caches have been invalidated.
Implementation of IQueryEngine.invalidateHttpCache
- Defined in actor-init-query/lib/QueryEngineBase.ts:197

query

query<QueryFormatTypeInner>(query, context?): Promise<QueryType>
Evaluate the given query
Type Parameters
- QueryFormatTypeInner extends QueryFormatType
Parameters
- query: QueryFormatTypeInner
  A query string or algebra.
- Optionalcontext: QueryFormatTypeInner extends string
  ? QueryStringContextInner
  : QueryAlgebraContextInner
  An optional query context.
Returns Promise<QueryType>
A promise that resolves to the query output.
Implementation of IQueryEngine.query
- Defined in actor-init-query/lib/QueryEngineBase.ts:87

queryBindings

queryBindings<QueryFormatTypeInner>(query, context?): Promise<BindingsStream>
Query the bindings results of a SELECT query.
Type Parameters
- QueryFormatTypeInner extends QueryFormatType
Parameters
- query: QueryFormatTypeInner
  A query string or algebra object. Algebra objects must not contain blank nodes. They should be converted to variables.
- Optionalcontext: QueryFormatTypeInner extends string
  ? QueryStringContextInner
  : QueryAlgebraContextInner
  A context.
Returns Promise<BindingsStream>
Implementation of IQueryEngine.queryBindings
- Defined in actor-init-query/lib/QueryEngineBase.ts:40

queryBoolean

queryBoolean<QueryFormatTypeInner>(query, context?): Promise<boolean>
Query the boolean result of an ASK query.
Type Parameters
- QueryFormatTypeInner extends QueryFormatType
Parameters
- query: QueryFormatTypeInner
  A query string or algebra object. Algebra objects must not contain blank nodes. They should be converted to variables.
- Optionalcontext: QueryFormatTypeInner extends string
  ? QueryStringContextInner
  : QueryAlgebraContextInner
  A context.
Returns Promise<boolean>
Implementation of IQueryEngine.queryBoolean
- Defined in actor-init-query/lib/QueryEngineBase.ts:54

`Protected`queryOfType

queryOfType<QueryFormatTypeInner, QueryTypeOut>(query, context, expectedType): Promise<ReturnType<QueryTypeOut["execute"]>>
Type Parameters
- QueryFormatTypeInner extends QueryFormatType
- QueryTypeOut extends QueryEnhanced
Parameters
- query: QueryFormatTypeInner
- context: undefined | (QueryFormatTypeInner extends string
  ? QueryStringContextInner
  : QueryAlgebraContextInner)
- expectedType: QueryTypeOut["resultType"]
Returns Promise<ReturnType<QueryTypeOut["execute"]>>
- Defined in actor-init-query/lib/QueryEngineBase.ts:68

queryOrExplain

queryOrExplain<QueryFormatTypeInner>(query, context?): Promise<QueryType | IQueryExplained>
Evaluate or explain the given query
Type Parameters
- QueryFormatTypeInner extends QueryFormatType
Parameters
- query: QueryFormatTypeInner
  A query string or algebra.
- Optionalcontext: QueryFormatTypeInner extends string
  ? QueryStringContextInner
  : QueryAlgebraContextInner
  An optional query context.
Returns Promise<QueryType | IQueryExplained>
A promise that resolves to the query output or explanation.
- Defined in actor-init-query/lib/QueryEngineBase.ts:123

queryQuads

queryQuads<QueryFormatTypeInner>(query, context?): Promise<AsyncIterator<Quad> & ResultStream<Quad>>
Query the quad results of a CONSTRUCT or DESCRIBE query.
Type Parameters
- QueryFormatTypeInner extends QueryFormatType
Parameters
- query: QueryFormatTypeInner
  A query string or algebra object. Algebra objects must not contain blank nodes. They should be converted to variables.
- Optionalcontext: QueryFormatTypeInner extends string
  ? QueryStringContextInner
  : QueryAlgebraContextInner
  A context.
Returns Promise<AsyncIterator<Quad> & ResultStream<Quad>>
Implementation of IQueryEngine.queryQuads
- Defined in actor-init-query/lib/QueryEngineBase.ts:47

queryVoid

queryVoid<QueryFormatTypeInner>(query, context?): Promise<void>
Execute an UPDATE query.
Type Parameters
- QueryFormatTypeInner extends QueryFormatType
Parameters
- query: QueryFormatTypeInner
  A query string or algebra object. Algebra objects must not contain blank nodes. They should be converted to variables.
- Optionalcontext: QueryFormatTypeInner extends string
  ? QueryStringContextInner
  : QueryAlgebraContextInner
  A context.
Returns Promise<void>
Implementation of IQueryEngine.queryVoid
- Defined in actor-init-query/lib/QueryEngineBase.ts:61

resultToString

resultToString(queryResult, mediaType?, context?): Promise<IActorQueryResultSerializeOutput>
Convert a query result to a string stream based on a certain media type.
Parameters
- queryResult: Query<any>
  A query result.
- OptionalmediaType: string
  A media type.
- Optionalcontext: any
  An optional context.
Returns Promise<IActorQueryResultSerializeOutput>
A text stream.
Implementation of IQueryEngine.resultToString
- Defined in actor-init-query/lib/QueryEngineBase.ts:169

`Static`finalToInternalResult

finalToInternalResult(finalResult): Promise<IQueryOperationResult>
Convert a final query result to an internal one.
Parameters
- finalResult: Query<any>
  A final query result.
Returns Promise<IQueryOperationResult>
- Defined in actor-init-query/lib/QueryEngineBase.ts:245

`Static`internalToFinalResult

internalToFinalResult(internalResult): QueryType
Convert an internal query result to a final one.
Parameters
- internalResult: IQueryOperationResult
  An intermediary query result.
Returns QueryType
- Defined in actor-init-query/lib/QueryEngineBase.ts:206

Class QueryEngineBase<QueryContext, QueryStringContextInner, QueryAlgebraContextInner>

Type Parameters

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns QueryEngineBase<QueryContext, QueryStringContextInner, QueryAlgebraContextInner>

Methods

explain

Type Parameters

Parameters

Returns Promise<IQueryExplained>

getResultMediaTypeFormats

Parameters

Returns Promise<Record<string, string>>

getResultMediaTypes

Parameters

Returns Promise<Record<string, number>>

invalidateHttpCache

Parameters

Returns Promise<any>

query

Type Parameters

Parameters

Returns Promise<QueryType>

queryBindings

Type Parameters

Parameters

Returns Promise<BindingsStream>

queryBoolean

Type Parameters

Parameters

Returns Promise<boolean>

ProtectedqueryOfType

Type Parameters

Parameters

Returns Promise<ReturnType<QueryTypeOut["execute"]>>

queryOrExplain

Type Parameters

Parameters

Returns Promise<QueryType | IQueryExplained>

queryQuads

Type Parameters

Parameters

Returns Promise<AsyncIterator<Quad> & ResultStream<Quad>>

queryVoid

Type Parameters

Parameters

Returns Promise<void>

resultToString

Parameters

Returns Promise<IActorQueryResultSerializeOutput>

StaticfinalToInternalResult

Parameters

Returns Promise<IQueryOperationResult>

StaticinternalToFinalResult

Parameters

Returns QueryType

Settings

On This Page

`Protected`queryOfType

`Static`finalToInternalResult

`Static`internalToFinalResult