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 (if the file does not exist in the cellar, a new one will be created). 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 cellar file containing the diff (if the file does not exist in the cellar, 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)

--cache

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

--checkpoint

Format: "{CHECKPOINT NAME}:{COLUMN}" Used to store the value of the provided column (in the first row of results) in the provided name for use as a checkpoint in scheduled queries or other stages. Not encrypted. Can be accessed using $CHECKPOINTS.{CHECKPOINT NAME}$

--filter

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

--guid

Adds a populated random guid column.

--labelStage

Used to label a stage with a user provided label.

--randomizeHash

Randomizes the stage hash, even if args and flags are the same.

--stats

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

--table

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

--type

Each command has a default type, either "mapping" or "reducing". Some commands can operate as either, when "reducing" they will operate on all rows at once, when "mapping", they will operate on one row at a time.

--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.

--variable

Format: "{VARIABLE NAME}:{COLUMN}" Used to store the value of the provided column (in the first row of results) in the provided name for use as a variable in other stages. Can be accessed using $VARIABLES.{VARIABLE NAME}$. Stored as an encrypted secret. Not stored across queries.

support

AMI_ENTERPRISE AMI_FREE AMI_PRO BINARY_ENTERPRISE BINARY_FREE BINARY_PRO DESKTOP_ENTERPRISE DESKTOP_FREE DESKTOP_PRO DOCKER_ENTERPRISE DOCKER_FREE DOCKER_PRO