MongoDB Backups

Last modified: May 17, 2021

Do not delete this has styles that are applied to the article.

Several utilities are available to back up and restore data from Alteryx Server deployments using the embedded version of MongoDB. Use this backup functionality to recover from a system failure or data corruption or loss. You can also use restore options to roll back to past data. 

Back up and restore data using the command line utilities available from the AlteryxService executable file AlteryxService.exe. Because the database backup process requires Server to be shut down (disabling scheduling and Gallery functionality for several minutes), perform backups during off-peak times.

Create a MongoDB Backup

  1. Stop AlteryxService. Shutdown multiple machines in order—Gallery, Workers, and then Controller.
  2. From the command line, navigate to the directory to store the backup.
  3. Execute the following command to save a backup of the database in the specified folder:

    alteryxservice emongodump=path_to_backup_location

    \Program Files\Alteryx\bin\AlteryxService.exe emongodump=c:\temp\dumpOutput
  4. Restart AlteryxService. Restart multiple machines in reverse order—restart the controller, then the workers, and then the Gallery.

Restore from a MongoDB Backup

  1. Stop AlteryxService.
  2. From the command line, navigate to the directory where the backup is located.
  3. Execute the following command to take the saved backup from the output folder and move it to the specified input folder:alteryxservice emongorestore=path_to_backup_location,path_to_mongo_folder

    \Program Files\Alteryx\bin\AlteryxService.exe emongorestore=c:\temp\dumpOutput,c:\temp\restoreInput
  4. Restart AlteryxService.

Use a MongoDB Backup

  1. Open System Settings.
  2. Go to Controller > Persistence.
  3. In the Data Folder field, browse to the folder for the backup.
  4. Select Next to continue through the System Settings windows and restart the service. When the service starts it will run off the restored folder.
Was This Page Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.