MongoDB Backups

Version:
2023.1
Last modified: September 12, 2023

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 Server functionality for several minutes), perform backups during off-peak times.

Create a MongoDB Backup

  1. Stop AlteryxService. Shutdown multiple machines in order—Server UI node, workers, and then the controller.
  2. From the command line, navigate to the Alteryx Server installation folder (for example, D:\Program Files\Alteryx\bin).
  3. Execute the following command to save a backup of the database in the specified folder (must be an empty 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 Server UI node.

Restore from a MongoDB Backup

  1. Stop AlteryxService.
  2. From the command line, navigate to the Alteryx Server installation folder (for example, D:\Program Files\Alteryx\bin).
  3. Execute the following command to restore the MongoDB backup to the specified folder (must be an empty folder):alteryxservice emongorestore=path_to_backup_location,path_to_mongo_folder

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

    If you restore your MongoDB to a new folder with a different name, then you have to update the Data Folder in Alteryx System Settings > Controller > Persistence to allow AlteryxService to start with the newly restored MongoDB folder. For more information about the controller configuration, go to the Controller help page.

    Screenshot of System Settings, the Controller page.

  4. Confirm the restore was successful. This is a necessary step as a restore failure will not be reported above and can lead to missing data on your Server. To do so, review the mongoRestore.log in the MongoDB folder where the data was restored.  Open mongoRestore.log and go to the last line.  Confirm that it reports #### document(s) restored successfully, 0 document(s) failed to restore.

    Do not proceed if the Mongo restore failed.

  5. If the restore was successful, 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.