Class QueryEngine

A Comunica SPARQL query engine.

Hierarchy

  • QueryEngineBase<
        IQueryContextCommon,
        Omit<QueryStringContext, "sources"> & { sources?: SourceType[] },
        Omit<QueryAlgebraContext, "sources"> & { sources?: SourceType[] },
    >
    • QueryEngine

Constructors

constructor

Methods

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

Constructors

constructor

Methods

explain

  • explain<QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context: QueryFormatTypeInner extends string
            ? Omit<QueryStringContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            }
            : Omit<QueryAlgebraContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            },
        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
          ? Omit<QueryStringContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }
          : Omit<QueryAlgebraContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }

      An optional query context.

    • explainMode: QueryExplainMode

      The explain mode.

    Returns Promise<IQueryExplained>

    A promise that resolves to the query output or explanation.

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.

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.

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.

query

  • query<QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context?: QueryFormatTypeInner extends string
            ? Omit<QueryStringContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            }
            : Omit<QueryAlgebraContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            },
    ): Promise<QueryType>

  • Evaluate the given query

    Type Parameters

    • QueryFormatTypeInner extends QueryFormatType

    Parameters

    • query: QueryFormatTypeInner

      A query string or algebra.

    • Optionalcontext: QueryFormatTypeInner extends string
          ? Omit<QueryStringContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }
          : Omit<QueryAlgebraContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }

      An optional query context.

    Returns Promise<QueryType>

    A promise that resolves to the query output.

queryBindings

  • queryBindings<QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context?: QueryFormatTypeInner extends string
            ? Omit<QueryStringContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            }
            : Omit<QueryAlgebraContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            },
    ): 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
          ? Omit<QueryStringContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }
          : Omit<QueryAlgebraContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }

      A context.

    Returns Promise<BindingsStream>

queryBoolean

  • queryBoolean<QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context?: QueryFormatTypeInner extends string
            ? Omit<QueryStringContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            }
            : Omit<QueryAlgebraContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            },
    ): 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
          ? Omit<QueryStringContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }
          : Omit<QueryAlgebraContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }

      A context.

    Returns Promise<boolean>

ProtectedqueryOfType

  • queryOfType<
        QueryFormatTypeInner extends QueryFormatType,
        QueryTypeOut extends QueryEnhanced,
    >(
        query: QueryFormatTypeInner,
        context:
            | undefined
            | (
                QueryFormatTypeInner extends string
                    ? Omit<QueryStringContext, "sources"> & {
                        sources?: QuerySourceUnidentified[];
                    }
                    : Omit<QueryAlgebraContext, "sources"> & {
                        sources?: QuerySourceUnidentified[];
                    }
            ),
        expectedType: QueryTypeOut["resultType"],
    ): Promise<ReturnType<QueryTypeOut["execute"]>>

  • Type Parameters

    • QueryFormatTypeInner extends QueryFormatType
    • QueryTypeOut extends QueryEnhanced

    Parameters

    • query: QueryFormatTypeInner
    • context:
          | undefined
          | (
              QueryFormatTypeInner extends string
                  ? Omit<QueryStringContext, "sources"> & {
                      sources?: QuerySourceUnidentified[];
                  }
                  : Omit<QueryAlgebraContext, "sources"> & {
                      sources?: QuerySourceUnidentified[];
                  }
          )
    • expectedType: QueryTypeOut["resultType"]

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

queryOrExplain

  • queryOrExplain<QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context?: QueryFormatTypeInner extends string
            ? Omit<QueryStringContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            }
            : Omit<QueryAlgebraContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            },
    ): 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
          ? Omit<QueryStringContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }
          : Omit<QueryAlgebraContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }

      An optional query context.

    Returns Promise<QueryType | IQueryExplained>

    A promise that resolves to the query output or explanation.

queryQuads

  • queryQuads<QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context?: QueryFormatTypeInner extends string
            ? Omit<QueryStringContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            }
            : Omit<QueryAlgebraContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            },
    ): 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
          ? Omit<QueryStringContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }
          : Omit<QueryAlgebraContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }

      A context.

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

queryVoid

  • queryVoid<QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context?: QueryFormatTypeInner extends string
            ? Omit<QueryStringContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            }
            : Omit<QueryAlgebraContext, "sources"> & {
                sources?: QuerySourceUnidentified[];
            },
    ): 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
          ? Omit<QueryStringContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }
          : Omit<QueryAlgebraContext, "sources"> & {
              sources?: QuerySourceUnidentified[];
          }

      A context.

    Returns Promise<void>

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.

StaticfinalToInternalResult

  • 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>

StaticinternalToFinalResult

  • internalToFinalResult(internalResult: IQueryOperationResult): QueryType

  • Convert an internal query result to a final one.

    Parameters

    • internalResult: IQueryOperationResult

      An intermediary query result.

    Returns QueryType

Settings

Member Visibility

On This Page

Constructors
Methods