@openhps/rdf
    Preparing search index...

    Interface IQueryEngine<QueryStringContextInner, QueryAlgebraContextInner>

    Base interface for a Comunica query engine.

    interface IQueryEngine<
        QueryStringContextInner extends
            RDF.QueryStringContext = QueryStringContext,
        QueryAlgebraContextInner extends
            RDF.QueryAlgebraContext = QueryAlgebraContext,
    > {
        explain: <QueryFormatTypeInner extends QueryFormatType>(
            query: QueryFormatTypeInner,
            context: QueryFormatTypeInner extends string
                ? QueryStringContextInner
                : QueryAlgebraContextInner,
            explainMode: QueryExplainMode,
        ) => Promise<IQueryExplained>;
        getResultMediaTypeFormats: (
            context?: IActionContext,
        ) => Promise<Record<string, string>>;
        getResultMediaTypes: (
            context?: IActionContext,
        ) => Promise<Record<string, number>>;
        invalidateHttpCache: (url?: string) => Promise<any>;
        query: <QueryFormatTypeInner extends QueryFormatType>(
            query: QueryFormatTypeInner,
            context?: QueryFormatTypeInner extends string
                ? QueryStringContextInner
                : QueryAlgebraContextInner,
        ) => Promise<QueryType>;
        queryBindings: <QueryFormatTypeInner extends QueryFormatType>(
            query: QueryFormatTypeInner,
            context?: QueryFormatTypeInner extends string
                ? QueryStringContextInner
                : QueryAlgebraContextInner,
        ) => Promise<BindingsStream>;
        queryBoolean: <QueryFormatTypeInner extends QueryFormatType>(
            query: QueryFormatTypeInner,
            context?: QueryFormatTypeInner extends string
                ? QueryStringContextInner
                : QueryAlgebraContextInner,
        ) => Promise<boolean>;
        queryQuads: <QueryFormatTypeInner extends QueryFormatType>(
            query: QueryFormatTypeInner,
            context?: QueryFormatTypeInner extends string
                ? QueryStringContextInner
                : QueryAlgebraContextInner,
        ) => Promise<AsyncIterator<Quad> & ResultStream<Quad>>;
        queryVoid: <QueryFormatTypeInner extends QueryFormatType>(
            query: QueryFormatTypeInner,
            context?: QueryFormatTypeInner extends string
                ? QueryStringContextInner
                : QueryAlgebraContextInner,
        ) => Promise<void>;
        resultToString: (
            queryResult: QueryType,
            mediaType?: string,
            context?: any,
        ) => any;
    }

    Type Parameters

    • QueryStringContextInner extends RDF.QueryStringContext = QueryStringContext
    • QueryAlgebraContextInner extends RDF.QueryAlgebraContext = QueryAlgebraContext

    Hierarchy

    Index

    Properties

    explain getResultMediaTypeFormats getResultMediaTypes invalidateHttpCache query queryBindings queryBoolean queryQuads queryVoid resultToString

    Properties

    explain: <QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context: QueryFormatTypeInner extends string
            ? QueryStringContextInner
            : QueryAlgebraContextInner,
        explainMode: QueryExplainMode,
    ) => Promise<IQueryExplained>

    Explain the given query

    Type Declaration

      • <QueryFormatTypeInner extends QueryFormatType>(
            query: QueryFormatTypeInner,
            context: QueryFormatTypeInner extends string
                ? QueryStringContextInner
                : QueryAlgebraContextInner,
            explainMode: QueryExplainMode,
        ): Promise<IQueryExplained>

      • Type Parameters

        • QueryFormatTypeInner extends QueryFormatType

        Parameters

        • query: QueryFormatTypeInner

          A query string or algebra. Algebra objects must not contain blank nodes. They should be converted to variables.

        • context: QueryFormatTypeInner extends string
              ? QueryStringContextInner
              : QueryAlgebraContextInner

          A query context.

        • explainMode: QueryExplainMode

          The explain mode.

        Returns Promise<IQueryExplained>

        A promise that resolves to the query output.

    getResultMediaTypeFormats: (
        context?: IActionContext,
    ) => Promise<Record<string, string>>

    Type Declaration

      • (context?: IActionContext): Promise<Record<string, string>>

      • Parameters

        • Optionalcontext: IActionContext

          An optional context.

        Returns Promise<Record<string, string>>

        All available SPARQL result media type formats.

    getResultMediaTypes: (
        context?: IActionContext,
    ) => Promise<Record<string, number>>

    Type Declaration

      • (context?: IActionContext): Promise<Record<string, number>>

      • Parameters

        • Optionalcontext: IActionContext

          An optional context.

        Returns Promise<Record<string, number>>

        All available SPARQL (weighted) result media types.

    invalidateHttpCache: (url?: string) => Promise<any>

    Invalidate all internal caches related to the given page URL. If no page URL is given, then all pages will be invalidated.

    Type Declaration

      • (url?: string): Promise<any>

      • Parameters

        • Optionalurl: string

          The page URL to invalidate.

        Returns Promise<any>

        A promise resolving when the caches have been invalidated.

    query: <QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context?: QueryFormatTypeInner extends string
            ? QueryStringContextInner
            : QueryAlgebraContextInner,
    ) => Promise<QueryType>

    Initiate a given query. This will produce a future to a query result, which has to be executed to obtain the query results. This can reject given an unsupported or invalid query.

    This method is prefered in case you don't know beforehand what type of query will be executed, or if you require access to the metadata of the results.

    Type Declaration

      • <QueryFormatTypeInner extends QueryFormatType>(
            query: QueryFormatTypeInner,
            context?: QueryFormatTypeInner extends string
                ? QueryStringContextInner
                : QueryAlgebraContextInner,
        ): Promise<QueryType>

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

    queryBindings: <QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context?: QueryFormatTypeInner extends string
            ? QueryStringContextInner
            : QueryAlgebraContextInner,
    ) => Promise<BindingsStream>

    Query the bindings results of a SELECT query.

    Type Declaration

      • <QueryFormatTypeInner extends QueryFormatType>(
            query: QueryFormatTypeInner,
            context?: QueryFormatTypeInner extends string
                ? QueryStringContextInner
                : QueryAlgebraContextInner,
        ): Promise<BindingsStream>

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

    queryBoolean: <QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context?: QueryFormatTypeInner extends string
            ? QueryStringContextInner
            : QueryAlgebraContextInner,
    ) => Promise<boolean>

    Query the boolean result of an ASK query.

    Type Declaration

      • <QueryFormatTypeInner extends QueryFormatType>(
            query: QueryFormatTypeInner,
            context?: QueryFormatTypeInner extends string
                ? QueryStringContextInner
                : QueryAlgebraContextInner,
        ): Promise<boolean>

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

    queryQuads: <QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context?: QueryFormatTypeInner extends string
            ? QueryStringContextInner
            : QueryAlgebraContextInner,
    ) => Promise<AsyncIterator<Quad> & ResultStream<Quad>>

    Query the quad results of a CONSTRUCT or DESCRIBE query.

    Type Declaration

      • <QueryFormatTypeInner extends QueryFormatType>(
            query: QueryFormatTypeInner,
            context?: QueryFormatTypeInner extends string
                ? QueryStringContextInner
                : QueryAlgebraContextInner,
        ): Promise<AsyncIterator<Quad> & ResultStream<Quad>>

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

    queryVoid: <QueryFormatTypeInner extends QueryFormatType>(
        query: QueryFormatTypeInner,
        context?: QueryFormatTypeInner extends string
            ? QueryStringContextInner
            : QueryAlgebraContextInner,
    ) => Promise<void>

    Execute an UPDATE query.

    Type Declaration

      • <QueryFormatTypeInner extends QueryFormatType>(
            query: QueryFormatTypeInner,
            context?: QueryFormatTypeInner extends string
                ? QueryStringContextInner
                : QueryAlgebraContextInner,
        ): Promise<void>

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

    resultToString: (
        queryResult: QueryType,
        mediaType?: string,
        context?: any,
    ) => any

    Convert a query result to a string stream based on a certain media type.

    Type Declaration

      • (queryResult: QueryType, mediaType?: string, context?: any): any

      • Parameters

        • queryResult: QueryType

          A query result.

        • OptionalmediaType: string

          A media type.

        • Optionalcontext: any

          An optional context.

        Returns any

        A text stream.

    Settings

    Member Visibility

    On This Page

    Properties