Skip to main content

diff

diff [cellar file name] [optionalColumn1 ... optionalColumnN]

Diffs the incoming results against a previously frozen set of results in the cellar. This command can use flags to control overwriting the cellar comparison file to include new entries, and/or remove old entries.

arguments:

cellar file name

The name of a file containing the diff (if the file does not exist, a new one will be created). (type: string)

optionalColumnN

An optional set of one more columns to use to contruct the diff, by default all columns will be used. (type: string)

examples:

Query

seed '[{"key": "value"}]'
|| diff my_diff key --update

Results prior to diff stage:

key
value

Results after diff stage:

key
value

flags:

--add

When true, the diff file will be updated to add new entries from the pipeline results.

--appendStage

Used to append the results from a previous stage to the current stage. (provide a label, stage index, or boolean true to append the previous results)

--attributes

A comma separated list of attributes to include in the command results. If not provided, all attributes will be included.

--cache

A boolean value of true/false that determines whether or not to use the cache. Generally most commands will default to true.

--filter

A filter to run on the command results before completing the command. If not provided, no filter is run on the results.

--labelStage

Used to label a stage with a user provided label.

--stats

Controls if a stats calculation is run on a stage after it completes.

--update

When true, the diff file will be updated to add new entries from the pipeline results and remove old entries that do not exist in the pipeline results.