pipeline.core — com.fooheads/pipeline 0.1.2

The core of pipeline. This is where the definition and running of the pipelines exists.

*pipeline clj

Memory for last pipline executed

action clj

(action step-name f inputs)

(action step-name f inputs output)

(action step-name f inputs output output-spec)

(action step-name f inputs output output-spec bindings)

(action step-name f inputs output output-spec bindings validation-fns)

args clj

(args pipeline)

Returns the args used when run-pipeline was called on this pipeline. Will return nil on a pipeline that has not been started

args-for-step clj

(args-for-step step state options)

bindings clj

(bindings pipeline-or-step)

Returns the bindings of a pipeline or a step.

default-validation-fns clj

failed-step clj

(failed-step pipeline)

Returns the first failed step of a pipeline.

failed-steps clj

(failed-steps pipeline)

Returns all failed steps of a pipeline.

failed? clj

(failed? pipeline-or-step)

Returns true if the pipeline or a step was failed.

failure-message clj

(failure-message step)

failure-reason clj

(failure-reason step)

failure-value clj

(failure-value step)

last-executed-step clj

(last-executed-step pipeline)

last-run clj

(last-run)

Returns the stored result from the last call to run-pipeline

make-pipeline clj

(make-pipeline pipeline-bindings & steps-and-pipelines)

make-step clj

(make-step step-type
           step-name
           f
           inputs
           output
           output-spec
           bindings
           validation-fns)

next-step clj

(next-step pipeline)

not-started? clj

(not-started? pipeline-or-step)

Returns true if the pipeline or a step or not started.

pipeline-finished? clj

(pipeline-finished? pipeline)

pipeline? clj

(pipeline? pipeline)

Returns true if given a valid pipeline

registry clj

resolve-spec clj

(resolve-spec var-or-any)

result clj

(result pipeline-or-step)

Returns the result from a successful step or from a successful pipeline. If the arg is a pipeline, the result is the result of the last step.

If called on a step that is not successful or a pipeline that is not successful, an exception is thrown.

run-pipeline clj

(run-pipeline pipeline args)

(run-pipeline pipeline args options)

Executes a pipeline and returns the full execution context as a result. In the execution context, result and errors can be found, but also a full trace of each step's input, result and time spent.

Options can be given to run-pipeline, but there are not yet any options defined.

Even though run-pipeline returns the full execution context, it's recommended to use the helper functions in this package to extract data for common tasks. This protects you slightly from breaking changes in the data structure since this is still pre-alpha.

The last pipeline result (the full execution context) is stored in pipeline.core/*pipeline-run as well as returned

run-step clj

(run-step f args output-schema state validation-fns options)

Runs a single step. This is called from run-pipeline and normally not used directly, but is still public since it can be useful during development.

schema-path clj

schema-paths clj

schema-pipeline clj

schema-step clj

schema-step-not-started clj

schema-steps clj

scope-pipeline clj

(scope-pipeline input-paths output-path & steps-and-pipelines)

Scopes a pipeline to isolate it from the surrounding scope.

Scopes the input-paths and output-path for all steps, and replace the first step's input-path and the last step's output-path with the provided ones.

state clj

(state pipeline-or-step)

Returns the state of a pipeline or a step.

state? clj

(state? state-value pipeline-or-step)

Returns the state for a pipeline or a step

step clj

(step pipeline step-name)

Returns a named or numbered (seq-id) step in a pipeline

step-name clj

(step-name step)

Returns the name of a step

step-path clj

(step-path pipeline step)

step? clj

(step? pipeline)

Returns true if given a valid step

steps clj

(steps pipeline)

Returns the steps in a pipeline

steps? clj

(steps? pipeline)

Returns true is given a vector of steps

successful? clj

(successful? pipeline-or-step)

Returns true if the pipeline or a step was successful.

transformation clj

(transformation step-name f inputs output)

(transformation step-name f inputs output output-spec)

(transformation step-name f inputs output output-spec bindings)

(transformation step-name f inputs output output-spec bindings validation-fns)

update-pipeline clj

(update-pipeline pipeline step)

update-state clj

(update-state state step)

update-step clj

(update-step step args result)

validation-functions clj

(validation-functions step)

Returns the validation functions for a step