Overview

Parameters act as read-only environment variables. Parameters are defined as a JSON blob set by the user that can be accessed in the metadata during template rendering. These values can be set for a Workspace/Environment at various points to provide flexibility of template behavior during Deploying or Refreshing.

An example use case might be using a variable to indicate full-refresh versus incremental.

Parameters can be set on a Workspace/Environment in several ways:

• In the GUI as an Environment's default parameters
• In the GUI before a Deployment
• Through the CLI app, coa, during Plan and Refresh
• Through the REST API, using the Refresh endpoint

📘

Parameters in git

Parameters are exclusively stored in Coalesce's metadata repository and will not be committed to your git repository.