@triply/triplydb
    Preparing search index...

    Interface RunPipelineOpts

    What a pipeline should run, and where its results should go.

    interface RunPipelineOpts {
        destination: { dataset: Dataset; graph?: string | Graph };
        onProgress?: (progress: PipelineProgress) => void;
        queries: (
            | Query
            | {
                priority?: number;
                query: Query;
                variables?: { [variable: string]: string
                | undefined };
            }
        )[];
        source?: Dataset;
    }
    Index
    destination onProgress? queries source?
    destination: { dataset: Dataset; graph?: string | Graph }

    Where to write the results.

    Type Declaration

    • dataset: Dataset

      The dataset to write into.

    • Optionalgraph?: string | Graph

      The graph to write into. The instance picks one when omitted.

    onProgress?: (progress: PipelineProgress) => void

    Called with each progress update while the pipeline runs.

    Pass defaultLogger to print them, or your own function to do something else.

    queries: (
        | Query
        | {
            priority?: number;
            query: Query;
            variables?: { [variable: string]: string
            | undefined };
        }
    )[]

    The queries to run, in parallel.

    Type Declaration

    • Query
    • {
          priority?: number;
          query: Query;
          variables?: { [variable: string]: string | undefined };
      }
      • Optionalpriority?: number

        Which queries the pipeline runs first; higher goes earlier. Order is unspecified without it.

      • query: Query

        The query to run.

      • Optionalvariables?: { [variable: string]: string | undefined }

        Values for the query's declared variables, keyed by variable name.

    Pass a Query on its own, or wrap it to set a priority or bind its variables.

    source?: Dataset

    The dataset to run the queries against.

    Only needed when the queries do not all target the same dataset; leave it unset otherwise.

    Settings

    On This Page
    Properties