Skip to content

name

String denoting the name of a pipeline, stage, job or step.

name: string

The name is used to reference a part of the dataflow.

Best Practices for names

Since names are used as references, some best practices are:

  • Make the name descriptive
  • It should indicate what portion of the dataflow it refers to.
  • Names should be unique in their context
  • This is so that it can be properly referenced.
  • Keep the name short (but still clear and unique)
  • When names are used as references, shorter strings makes it easier to specify them.
  • Use underscores to replace spaces
  • This keeps it clear that the name is one block of text.
  • Use lowercase
  • Although not a formal requirement, this keeps the names consistent and clear.

Tips and Tricks

Some ideas that may help coming up with useful names:

  • Name a dataflow the same as the filename containing the YAML. This makes it easy to trace messages that appear in logs back to the source.
  • When a series of dataflows are to be run in sequence, it is often handy to prefix dataflow names with a zero padded number (e.g. 01 or 001). This makes the listing of dataflows sort easier and makes the logs clear as to where in a sequence this are.