View Source Plumbery (plumbery v0.1.0)

Module Plumbery provides a DSL for building pipelines.

Basic concepts are as follows:

  • request is a struct that is passed beetween pipes
  • pipe is a function that accepts a struct and returns a struct, normally of the same kind
  • pipeline is a pipe composed of other pipes. The request moves through the pipeline one pipe at a time and each pipe has an opportunity to halt the pipeline. After a pipeline is halted, the request is returned from the pipeline without going through subsequent pipes in the pipeline
  • inlet is a function that accepts zero or more arguments and returns a request. Useful for API entry points that accept arbitrary arguments and convert them to a request

Options

  • :extensions (list of module that adopts Spark.Dsl.Extension) - A list of DSL extensions to add to the Spark.Dsl

  • :otp_app (atom/0) - The otp_app to use for any application configurable options

  • :fragments (list of module/0) - Fragments to include in the Spark.Dsl. See the fragments guide for more.