Skip to main content

Workspaces

A Workspace is a sandbox environment where you can complete the development of your data, refine it, and perform preliminary validation before you merge your work into the codebase. Each Workspace has its own graph, storage locations, macros, node types, connection configuration, and Git branch. You can create multiple Workspaces to work on different tasks and merge them into the codebase using Environments. For example, a data engineer may be tasked with creating a new data mart. They could create a new Workspace with its own Git branch, separate from the main Workspace. Once the feature is done, its code can be merged back into the main branch.

A Coalesce architecture diagram with two panels. The left panel shows an organizational structure with an administration layer and various department projects, while the right panel details the Central IT Compliance workflow, displaying feature workspaces that feed through Git and deployment pipelines into production, QA, and dev environments.

Workspaces are where you:

  • Complete all Coalesce development in the Coalesce App.
  • Create objects and load or refresh data manually on-demand, for individual objects, for part of the data pipeline, or for the full data pipeline.
  • When a change is made to an object, such as adding or dropping a column or renaming a column, the object is dropped and recreated rather than altered with ALTER.
  • Deleted objects are not dropped in the backend instance.

Managing Workspaces​

Access to a project's Workspaces follows project access. People you add under Project Settings > Members can work in that project's Workspaces according to their project role. For steps and role details, see How to Assign User Roles and RBAC permissions and roles.

For an in-depth guide on creating Workspaces, take a look at Step 3: Create a Workspace.

Create a Workspace​

  1. Select the Project you want to create the Workspace in.
  2. Click Create Workspace.
  3. Give your Workspace a Name and Description.
  4. Select a current branch to make a new branch from. For example, if you want to create a branch off main, select main, then the commit you want to start from, and then in New Branch Name, enter the new branch name.
  5. Then click Create.
  6. Your new Workspace will be created with the new branch.

Edit a Workspace​

There are two ways to edit a Workspace:

  • Go to Build Settings > Workspace and click the cog.
  • From the Project page, click the cog next to the Workspace.

You can update the following in a Workspace:

  • Settings includes Workspace name, description, and tag color.
  • User Credentials including OAuth
  • Storage Mappings
  • Parameters

Workspace Settings Overview​

To edit or create a Workspace, go to Build Settings > Workspace.

Workspace settings panel for Docs with fields for name, platform, description, tag color, creator, creation date, and account URL.
  1. Settings - Includes the Workspace name, description, tag color, creator, creation date, and account URL. For Workspace and other IDs you use in API calls, see Workspace and Environment IDs.
  2. User Credentials - Configure how you want to connect to your Data Platform. If you want to use OAuth, we recommend that approach, and you'll also need to add your OAuth Settings.
  3. Storage Mappings - To deploy or refresh, you need Storage Mappings set up. Storage Mappings represent the physical locations in your Data Platform where your data pipeline deploys. See Storage Locations and Storage Mappings.
  4. Parameters - Parameters are defined as a JSON blob you set that can be accessed in the metadata during template rendering. Learn more about Parameters.
  5. OAuth Settings - Enter the OAuth configuration information for your data platform

Duplicate or Copy a Workspace​

To duplicate a Workspace, go to the Projects page and click the Duplicate Settings button, . Then follow the on-screen prompts.

To copy a Workspace, click the three dots next to the Workspace and select Copy Objects from Workspace.

Review When To Use Copy Objects, Duplicate, or Create New Project to learn more about duplicating versus copying and what information will migrate to the Workspace.

Passwords

Passwords aren't copied.

Delete a Workspace​

There are two ways to open Workspace Settings:

  • Go to Build Settings > Workspace and click the cog.
  • From the Project page, click the cog next to the Workspace.

In Workspace Settings, click Delete Workspace.

If you delete all Workspaces, Coalesce creates a new blank Workspace named DEV, because there must always be at least one development Workspace.

In Build, your browser URL can include Project and Workspace identifiers. Copy the full address bar URL so teammates with access open the same context.

  1. Open Build for the Project and Workspace you want.
  2. Copy the URL from your browser and send it.
Project access

A shared link does not grant access. The recipient needs project membership and a role that allows them to see the information. Check Project Settings > Members if something fails.

What's Next?​