Skip to main content

freeze

freeze {name}

Freezes results for retrieval using the thaw command

arguments:

name

The name of the results to be frozen. (Optional, only used by read/write stores such as local file, s3, gcs, etc.) (type: string)

examples:

Query

seed '[{"key": "value"}]'
|| freeze local

Results prior to freeze stage:

key
value

Results after freeze stage:

messagefromto
successfilefile

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)

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

--gcp.pubsub.topic

An override topic if using a store of type 'gcpPubSub'.

--guid

Adds a populated random guid column.

--influxdb.bucket

An override bucket if using a store of type 'influxdb'.

--influxdb.precision

An override precision if using a store of type 'influxdb'.

--kafka.topic

An override topic if using a store of type 'kafka'.

--labelStage

Used to label a stage with a user provided label.

--passthrough

Results of this command will be the same as the previous stage's results.

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

--store

Store reference stored in vault. Contains the destination store and auth related information.

--table

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

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