Salesforce DX Developer Guide

How Salesforce Developer Experience Changes the Way You Work
Set Up Salesforce DX Tools for Developer Users
Project Setup
Authorization
Metadata Coverage
Scratch Orgs
Supported Scratch Org Editions and Allocations
Build Your Own Scratch Org Definition File
Create a Scratch Org Based on an Org Shape
Create Scratch Orgs
Scratch Org Snapshots (Beta)
Get Started with Scratch Org Snapshots (Beta)
Salesforce CLI Snapshot Commands (Beta)
Create a Scratch Org Snapshot (Beta)
Create a Snapshot for Use with Namespaced Scratch Orgs (Beta)
Create a Scratch Org Based on a Snapshot (Beta)
Manage and Maintain Your Snapshots (Beta)
Select the Salesforce Release for a Scratch Org
Deploy Source From Your Project to the Scratch Org
Retrieve Source from the Scratch Org to Your Project
Scratch Org Users
Manage Scratch Orgs from the Dev Hub Org
Scratch Org Error Codes
Sandboxes
Track Changes Between Your Project and Org
Development
Build and Release Your App
Unlocked Packages
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Scratch Org Snapshots (Beta)

Capture the state of a scratch org’s configuration so that you can use it to create scratch org replicas. A snapshot is a point-in-time copy of a scratch org that includes installed packages, features, limits, licenses, metadata, and data.

This feature is a Beta Service. Customers may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.

Note

Configuring a scratch org with a project’s dependencies can be a manual and time-consuming process. It can require pushing dependent metadata to a scratch org, seeding it with sample data, installing a package or two, and then performing manual tasks directly in the scratch org. And then, poof, the scratch org expires, and you have to start all over again. With scratch org snapshots, you can quickly replicate scratch orgs with the required project dependencies.

How Snapshots Fit in the Development Lifecycle

Because a snapshot is a point-in-time copy of your scratch org, it’s static. To update your snapshot, delete it and create a new snapshot.

You can create a snapshot from only a scratch org and, conversely, you can create only scratch orgs from a snapshot. Snapshots have the same 200-MB data storage limit as scratch orgs. A snapshot isn’t meant to replace source-driven development or a version control system. You continue to follow development best practices by externalizing and modularizing your project source.

Snapshots and scratch orgs don’t replace sandboxes for user acceptance testing. A snapshot is intended to contain the static dependencies of a project, and not the entire happy soup of your production org.

Snapshot Allocations and Limits

Snapshots are associated with a Dev Hub org. Therefore, you must use the same Dev Hub org when you create the scratch org from the snapshot.

  • You can create up to 5 snapshots per Dev Hub org daily, with a maximum of 5 active snapshots.
  • Snapshots expire after 30 days.