@triply/triplydb
    Preparing search index...

    Class Pipeline

    A running batch job that executes one or more saved queries and writes their results.

    Returned by an Account's runPipeline and by Query.runPipeline; pipelines are never constructed directly. Use Pipeline.waitForPipelineToFinish to block until it completes.

    const query = await account.getQuery("my-query");
    const target = await account.getDataset("my-target-dataset");

    const pipeline = await account.runPipeline({
      queries: [query],
      destination: { dataset: target },
    });
    await pipeline.waitForPipelineToFinish();
    Index
    slug
    getInfo waitForPipelineToFinish
    slug: string

    The pipeline run's identifier, as it appears in its URL.

    • This pipeline's last known state: its status, progress and any error it reported.

      Returns PipelineInfo

      Read from what was last fetched rather than making a request, so it is synchronous and does not advance on its own. Pipeline.waitForPipelineToFinish is what keeps it current.

    • Waits until this pipeline finishes.

      Parameters

      • Optionalopts: { onProgress?: (progress: PipelineProgress) => void }

        onProgress is called with each update; pass defaultLogger to print them.

      Returns Promise<void>

      Polls the instance until the job reports that it is done. A pipeline keeps running whether or not you wait, so this is about observing it, not driving it.

      If the pipeline finishes unsuccessfully.

    Settings

    On This Page
    Properties
    Methods