SFDX Data Move Utility (SFDMU)

The SFDX Data Move Utility (SFDMU) is an advanced SF CLI plugin designed to streamline data migration within various Salesforce environments, including scratch, development, sandbox, and production orgs.

This powerful tool supports migration from other Salesforce orgs or CSV files and efficiently manages various data operations, enabling the migration of multiple related sObjects in a single run.

• SFDMU GUI Desktop Application: A straightforward and intuitive application for creating, managing, and executing data migrations.
• SFDMU Help Center: Comprehensive documentation available.
• User Support Policy: Review guidelines before opening support cases.
• Contribution Policy: Learn how to contribute to our project.

Version Notice

We recently released a new improved v5 version of the SFDMU plugin, built on the latest SF CLI plugin architecture and including the latest available security updates. We recommend using the latest available plugin version. If it does not work correctly in your environment yet, temporarily roll back to v4.39.0. SFDMU is supported as an SF CLI plugin (sf sfdmu run). Full migration guidance is available on Get Started.

Key Features:

• Comprehensive Migration Support: Enables direct Org-to-Org data migration, eliminating the need for CSV intermediates, and supports CRUD operations: Insert, Upsert, Update, Delete.
• Multiple Objects and Relationships: Manages migrations involving multiple object sets and handles complex relationships, including circular references.
• Ease of Use: Simplifies the configuration process with a single export.json file.
• Secure and Local: Ensures data security as all operations are performed locally without cloud interactions.
• High Performance: Optimizes processing by focusing on necessary data subsets.
• Extended Functionality: Provides advanced features such as custom field mapping, data anonymization, and supports composite external ID keys among others.

Installation Instructions:

1. Prepare Environment: Install the Salesforce CLI following the official instructions.

2. Install the new improved version of the plugin (recommended):

   # Uninstall old version, if any:
   $ sf plugins uninstall sfdmu
   
   # Install the latest published plugin version:
   $ sf plugins install sfdmu@latest

3. Temporarily roll back to the previous stable line if the new improved version does not work yet:

   # Remove current plugin:
   $ sf plugins uninstall sfdmu
   
   # Install previous stable version:
   $ sf plugins install sfdmu@4.39.0

4. Switch back to the new improved version later:

   $ sf plugins install sfdmu@latest

5. If you need to pin a specific plugin version:

   $ sf plugins install sfdmu@<version>

6. If you find a bug in the new improved version of the plugin, please report it with diagnostic logs:

   $ sf sfdmu run --sourceusername source@name.com --targetusername target@name.com --diagnostic --anonymise

   Attach the full generated .log file, your export.json, and related CSV samples. --anonymise hashes sensitive values in .log files before sharing. Full masking list: Log File Management in Plugin Migrations.

For Developers:

Detailed Setup

For developers needing customization or access to the source:

# Clone the repository:
$ git clone https://github.com/forcedotcom/SFDX-Data-Move-Utility
# Navigate to the directory and link it:
$ cd SFDX-Data-Move-Utility
$ npm install
$ sf plugins link

Debugging

Use the source-debug flow from the official debugging guide:

$ ./sfdmu-run-debug.cmd --sourceusername source@mail.com --targetusername target@mail.com --path .

In VSCode, enable Node Debug -> Auto Attach (On) and set Use Preview Auto Attach to Off.

For detailed debugging guidance, see Debugging Steps.

Migration Configuration:

Set up a migration job by creating an export.json file with specific data models and operations, as detailed in the Full export.json Format Guide.

Here is a basic export.json example for upserting Accounts and their related Contacts, assuming a unique Name for Accounts and a unique LastName for Contacts across source and target orgs:

{
  "objects": [
    {
      "operation": "Upsert",
      "externalId": "LastName",
      "query": "SELECT FirstName, LastName, AccountId FROM Contact",
      "master": false
    },
    {
      "operation": "Upsert",
      "externalId": "Name",
      "query": "SELECT Name, Phone FROM Account WHERE Name = 'John Smith'"
    }
  ]
}

For full object model details, advanced parameters, and edge cases, use: Get Started and Detailed export.json Format.

Migration Execution:

Navigate to the directory where your export.json file is located and execute migrations using commands tailored to your source and target, whether they are Salesforce orgs or CSV files:

# Migrate data from one Salesforce org to another
$ sf sfdmu run --sourceusername source.org.username@name.com --targetusername target.org.username@name.com

# Export data from a Salesforce org to CSV files
$ sf sfdmu run --sourceusername source.org.username@name.com --targetusername csvfile

# Import data from CSV files to a Salesforce org
$ sf sfdmu run --sourceusername csvfile --targetusername target.org.username@name.com

SFDMU execution is plugin-only. Standalone Node.js module run mode is not supported.

Note:

When importing or exporting from/to CSV files, ensure that the files are located in the directory containing the export.json file. The files should be named according to the API name of the respective sObject, such as Account.csv, Contact.csv. This naming convention helps in accurately mapping the data to the correct sObjects during the import or export process.

Watch the Demo

• Experience the plugin in action here.

Documentation Links:

• Getting Started
• Installation Guide
• Configuration Tips
• How to Run Migrations
• Debugging Steps
• Detailed export.json Format
• SFDMU GUI Application Detailed Documentation

Additional Notes

• If you encounter permission issues on MacOS, prepend your commands with sudo. Adjust CLI command syntax if using the older SFDX CLI platform.
• To allow SFDMU to connect to your source and target orgs, ensure you have established a local connection to these orgs using the standard sf org login web commands, as detailed in the Authorize an Org Using a Browser documentation.