Start Run
start_runInitiates a new Coalesce refresh run using Snowflake credentials. Specify environment, workspace, job, node selectors, or confirm run of all nodes to start execution.
Instructions
Start a new Coalesce refresh run. Returns a task that resolves once the run has been submitted.
Requires Snowflake auth — credentials read from environment variables (Key Pair: SNOWFLAKE_KEY_PAIR_KEY, or PAT: SNOWFLAKE_PAT, plus SNOWFLAKE_USERNAME, SNOWFLAKE_WAREHOUSE, SNOWFLAKE_ROLE).
Provide exactly one of runDetails.environmentID or runDetails.workspaceID. If the user provides a job name, look up the ID with find_jobs_by_name (or list_environment_jobs) first.
Args:
runDetails.environmentID (string, optional): Target deployed environment (numeric ID as string)
runDetails.workspaceID (string, optional): Target workspace for a development run (numeric ID as string)
runDetails.jobID (string, optional): Specific job to run
runDetails.includeNodesSelector (string, optional): Node filter for ad-hoc runs
runDetails.excludeNodesSelector (string, optional): Node exclusion filter
runDetails.parallelism (number, optional): Max parallel nodes (default: 16)
runDetails.forceIgnoreWorkspaceStatus (boolean, optional): Allow run even if last deploy failed
confirmRunAllNodes (boolean): Required when no job/node scope is provided
parameters (object, optional): Key-value runtime parameters
Returns: { runCounter: number, runStatus: string, message: string }
Prefer run_and_wait when you need the final outcome in a single call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| parameters | No | Arbitrary key-value parameters to pass to the run | |
| runDetails | Yes | ||
| confirmRunAllNodes | No | Must be set to true when no jobID, includeNodesSelector, or excludeNodesSelector is provided. This confirms you intend to run ALL nodes in the target. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message | No | ||
| runStatus | No | ||
| runCounter | No |