Class QueryEngine

A Comunica SPARQL query engine.

Hierarchy

QueryEngineBase
- QueryEngine

Index

Constructors

Methods

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

Constructors

constructor

new QueryEngine(engine?: ActorInitQueryBase): QueryEngine
Parameters
- engine: ActorInitQueryBase = ...
Returns QueryEngine
Overrides QueryEngineBase.constructor
- Defined in engines/query-sparql-solid/lib/QueryEngine.ts:11

Methods

explain

explain<QueryFormatTypeInner extends QueryFormatType>(
    query: QueryFormatTypeInner,
    context: QueryFormatTypeInner extends string
        ? QueryStringContext
        : QueryAlgebraContext,
    explainMode: QueryExplainMode,
): Promise<IQueryExplained>
Explain the given query
Type Parameters
- QueryFormatTypeInner extends QueryFormatType
Parameters
- query: QueryFormatTypeInner
  A query string or algebra.
- context: QueryFormatTypeInner extends string ? QueryStringContext : QueryAlgebraContext
  An optional query context.
- explainMode: QueryExplainMode
  The explain mode.
Returns Promise<IQueryExplained>
A promise that resolves to the query output or explanation.
Inherited from QueryEngineBase.explain
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:32

getResultMediaTypeFormats

getResultMediaTypeFormats(context?: any): Promise<Record<string, string>>
Parameters
- Optionalcontext: any
  An optional context.
Returns Promise<Record<string, string>>
All available SPARQL result media type formats.
Inherited from QueryEngineBase.getResultMediaTypeFormats
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:50

getResultMediaTypes

getResultMediaTypes(context?: any): Promise<Record<string, number>>
Parameters
- Optionalcontext: any
  An optional context.
Returns Promise<Record<string, number>>
All available SPARQL (weighted) result media types.
Inherited from QueryEngineBase.getResultMediaTypes
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:45

invalidateHttpCache

invalidateHttpCache(url?: string, context?: any): 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.
Inherited from QueryEngineBase.invalidateHttpCache
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:66

query

query<QueryFormatTypeInner extends QueryFormatType>(
    query: QueryFormatTypeInner,
    context?: QueryFormatTypeInner extends string
        ? QueryStringContext
        : QueryAlgebraContext,
): Promise<QueryType>
Evaluate the given query
Type Parameters
- QueryFormatTypeInner extends QueryFormatType
Parameters
- query: QueryFormatTypeInner
  A query string or algebra.
- Optionalcontext: QueryFormatTypeInner extends string ? QueryStringContext : QueryAlgebraContext
  An optional query context.
Returns Promise<QueryType>
A promise that resolves to the query output.
Inherited from QueryEngineBase.query
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:23

queryBindings

queryBindings<QueryFormatTypeInner extends QueryFormatType>(
    query: QueryFormatTypeInner,
    context?: QueryFormatTypeInner extends string
        ? QueryStringContext
        : QueryAlgebraContext,
): 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 ? QueryStringContext : QueryAlgebraContext
  A context.
Returns Promise<BindingsStream>
Inherited from QueryEngineBase.queryBindings
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:12

queryBoolean

queryBoolean<QueryFormatTypeInner extends QueryFormatType>(
    query: QueryFormatTypeInner,
    context?: QueryFormatTypeInner extends string
        ? QueryStringContext
        : QueryAlgebraContext,
): 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 ? QueryStringContext : QueryAlgebraContext
  A context.
Returns Promise<boolean>
Inherited from QueryEngineBase.queryBoolean
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:14

`Protected`queryOfType

queryOfType<
    QueryFormatTypeInner extends QueryFormatType,
    QueryTypeOut extends QueryEnhanced,
>(
    query: QueryFormatTypeInner,
    context:
        | undefined
        | (
            QueryFormatTypeInner extends string
                ? QueryStringContext
                : QueryAlgebraContext
        ),
    expectedType: QueryTypeOut["resultType"],
): Promise<ReturnType<QueryTypeOut["execute"]>>
Type Parameters
- QueryFormatTypeInner extends QueryFormatType
- QueryTypeOut extends QueryEnhanced
Parameters
- query: QueryFormatTypeInner
- context:
      | undefined
      | (
          QueryFormatTypeInner extends string
              ? QueryStringContext
              : QueryAlgebraContext
      )
- expectedType: QueryTypeOut["resultType"]
Returns Promise<ReturnType<QueryTypeOut["execute"]>>
Inherited from QueryEngineBase.queryOfType
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:16

queryOrExplain

queryOrExplain<QueryFormatTypeInner extends QueryFormatType>(
    query: QueryFormatTypeInner,
    context?: QueryFormatTypeInner extends string
        ? QueryStringContext
        : QueryAlgebraContext,
): 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 ? QueryStringContext : QueryAlgebraContext
  An optional query context.
Returns Promise<QueryType | IQueryExplained>
A promise that resolves to the query output or explanation.
Inherited from QueryEngineBase.queryOrExplain
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:40

queryQuads

queryQuads<QueryFormatTypeInner extends QueryFormatType>(
    query: QueryFormatTypeInner,
    context?: QueryFormatTypeInner extends string
        ? QueryStringContext
        : QueryAlgebraContext,
): 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 ? QueryStringContext : QueryAlgebraContext
  A context.
Returns Promise<AsyncIterator<Quad> & ResultStream<Quad>>
Inherited from QueryEngineBase.queryQuads
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:13

queryVoid

queryVoid<QueryFormatTypeInner extends QueryFormatType>(
    query: QueryFormatTypeInner,
    context?: QueryFormatTypeInner extends string
        ? QueryStringContext
        : QueryAlgebraContext,
): 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 ? QueryStringContext : QueryAlgebraContext
  A context.
Returns Promise<void>
Inherited from QueryEngineBase.queryVoid
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:15

resultToString

resultToString(
    queryResult: Query<any>,
    mediaType?: string,
    context?: any,
): 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.
Inherited from QueryEngineBase.resultToString
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:58

`Static`finalToInternalResult

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

`Static`internalToFinalResult

internalToFinalResult(internalResult: IQueryOperationResult): QueryType
Convert an internal query result to a final one.
Parameters
- internalResult: IQueryOperationResult
  An intermediary query result.
Returns QueryType
Inherited from QueryEngineBase.internalToFinalResult
- Defined in node_modules/@comunica/actor-init-query/lib/QueryEngineBase.d.ts:71

Class QueryEngine

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns QueryEngine

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