Jump to Content
Coalesce.io
DocumentationAPIRelease NotesCommunity
Log InCoalesce.io
Log In
DocumentationAPIRelease NotesCommunity

About

  • What is Coalesce?
  • Deployment and Refresh

Getting Started

  • Quick Start Guide
  • Setup Requirements

The User Menu

  • User Menu Overview
  • Git Settings
  • Support Information
  • Security Settings
  • Users
  • Single Sign-On

Build Settings

  • Build Settings
  • Storage Locations
  • Development Workspaces
  • Environments
    • Connections
    • Storage Mappings
  • Macros
  • Node Types

The Build Interface

  • Overview of the Build Interface
  • Editing a Node
    • Mapping Grid
    • Join Tab
    • Config Tab
    • Ref Functions
    • JSON Parser
    • Advanced Node Functionality
  • Git Integration
  • Multi Source Nodes
  • Selector
  • Problem Scanner
  • Jobs
  • Subgraphs
  • Column Lineage
  • Column Bulk editor

Templating & Node Types

  • Out-of-the-Box Node Types
  • User-defined Nodes (UDNs)
  • Node Config Options

The Deploy Interface

  • Overview of the Deploy Interface
  • Deploying to an Environment
  • Refreshing an Environment

Command Line Interface

  • CLI Overview
  • CLI Setup
  • CLI Plan
  • CLI Deploy
  • CLI Refresh

Architecture & Security

  • Architecture
  • Security
  • Authentication Methods

Parameters

  • Overview
  • Setting Default Parameters
  • Overwriting at Deploy
  • Overwriting at Refresh

Scheduling

  • Scheduling Overview
  • GitHub Actions Example
  • Azure DevOps Pipelines Example

CLI Plan

Suggest Edits

Purpose

The purpose of the plan command is to generate a coa-plan.json file, which is needed before a Deploy.

Syntax

coa plan [options]

Execution

Run coa plan in the same directory as the locally cloned copy of your Coalesce project's Git repository.

Optional Flags

Type coa help plan to see all available options.

Updated 8 months ago


  • Table of Contents
    • Purpose
    • Syntax
    • Execution
    • Optional Flags