Skip to main content

branch

branch

Starts a new branch, all stages following the branch command will be run on the root of the first branch, until another branch command or a mergebranches command.

examples:​

Query​

seed '[{"key": "value"}]'
|| branch
  || addcolumn branch 1
|| branch
  || addcolumn branch 2
|| mergebranches

Results prior to branch stage:​

key
value

Results after branch stage:​

keybranch
value1
value2

flags:​

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

--branchFilter​

A filter to apply prior to the branch, so that only filters with no zero results are branched.

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

--fresh​

Starts the branch as if it was a fresh query, so will not use results from prior to the first branch.

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

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