@comunica/types/lib/IQueryOperationResult.d.ts

Typings module for Comunica

import type * as RDF from '@rdfjs/types';
import type { AsyncIterator } from 'asynciterator';
import type { BindingsStream } from './Bindings';
import type { IActionContext } from './IActionContext';
import type { IMetadata, MetadataQuads, MetadataBindings } from './IMetadata';
export interface IQueryOperationResultBase {
    /**
     * The type of output.
     */
    type: string;
    /**
     * The resulting action context.
     */
    context?: IActionContext;
}
/**
 * Super interface for query operation results that represent some for of stream.
 * @see IQueryableResultBindings, IQueryableResultQuads
 */
export interface IQueryOperationResultStream<M extends IMetadata<OrderItemsType>, OrderItemsType extends RDF.Variable | RDF.QuadTermName> extends IQueryOperationResultBase {
    /**
     * Callback that returns a promise that resolves to the metadata about the stream.
     *
     * This can contain things like the estimated number of total stream elements,
     * or the order in which the bindings appear.
     *
     * This callback can be invoked multiple times.
     * Each invocation can return a different metadata object,
     * if the previous one would have become invalidated (see `metadata.state`).
     * The actors that return this metadata will make sure that multiple calls properly cache this promise,
     * and that the cached object is properly invalidated if needed.
     * Metadata will not be collected until this callback is invoked.
     *
     * This callback should resolve quickly, so it is safe to call and immediately `await` it.
     */
    metadata: () => Promise<M>;
}
/**
 * Query operation output for a bindings stream.
 * For example: SPARQL SELECT results
 */
export interface IQueryOperationResultBindings extends IQueryOperationResultStream<MetadataBindings, RDF.Variable> {
    /**
     * The type of output.
     */
    type: 'bindings';
    /**
     * The stream of bindings resulting from the given operation.
     */
    bindingsStream: BindingsStream;
}
/**
 * Query operation output for quads.
 * For example: SPARQL CONSTRUCT results
 */
export interface IQueryOperationResultQuads extends IQueryOperationResultStream<MetadataQuads, RDF.QuadTermName> {
    /**
     * The type of output.
     */
    type: 'quads';
    /**
     * The stream of quads.
     */
    quadStream: RDF.Stream & AsyncIterator<RDF.Quad> & RDF.ResultStream<RDF.Quad>;
}
/**
 * Query operation output for boolean results.
 * For example: SPARQL ASK results
 */
export interface IQueryOperationResultBoolean extends IQueryOperationResultBase {
    /**
     * The type of output.
     */
    type: 'boolean';
    /**
     * An async function resolving to the boolean output of the operation.
     */
    execute: () => Promise<boolean>;
}
/**
 * Query operation output for boolean results.
 * For example: SPARQL UPDATE results
 */
export interface IQueryOperationResultVoid extends IQueryOperationResultBase {
    /**
     * The type of output.
     */
    type: 'void';
    /**
     * An async function resolving when the update has finished.
     */
    execute: () => Promise<void>;
}
/**
 * Query operation output.
 * @see IQueryableResultBindings, IQueryableResultQuads, IQueryableResultBoolean, IQueryableResultVoid
 */
export type IQueryOperationResult = IQueryOperationResultBindings | IQueryOperationResultQuads | IQueryOperationResultBoolean | IQueryOperationResultVoid;
/**
 * Enhanced query operation output for a bindings stream.
 * For example: SPARQL SELECT results
 */
export interface IQueryBindingsEnhanced extends QueryBindings {
    execute: (opts?: RDF.QueryExecuteOptions<RDF.Variable>) => Promise<BindingsStream>;
}
/**
 * Enhanced query operation output for quads.
 * For example: SPARQL CONSTRUCT results
 */
export interface IQueryQuadsEnhanced extends QueryQuads {
    execute: (opts?: RDF.QueryExecuteOptions<RDF.QuadTermName>) => Promise<AsyncIterator<RDF.Quad> & RDF.ResultStream<RDF.Quad>>;
}
export type QueryBindings = RDF.QueryBindings<RDF.AllMetadataSupport>;
export type QueryQuads = RDF.QueryQuads<RDF.AllMetadataSupport>;
/**
 * Enhanced query operation output.
 * @see IQueryableResultBindingsEnhanced, IQueryableResultQuadsEnhanced, IQueryableResultBoolean, IQueryableResultVoid
 */
export type QueryEnhanced = IQueryBindingsEnhanced | IQueryQuadsEnhanced | RDF.QueryBoolean | RDF.QueryVoid;
/**
 * Different manners in which a query can be explained.
 */
export type QueryExplainMode = 'parsed' | 'logical' | 'physical' | 'physical-json';
/**
 * An interface marking an explained query.
 * WARNING: this API is experimental, and might be changed inbetween major versions.
 */
export interface IQueryExplained {
    explain: true;
    /**
     * The mode of explanation
     */
    type: QueryExplainMode;
    /**
     * The raw explanation data
     */
    data: any;
}