MongoDB Management

Version:
2019.3
Last modified: October 11, 2019

Alteryx includes an option to use an embedded version of a MongoDB database when setting up a Gallery to reduce the amount of configuration necessary for deploying a basic instance of Alteryx Server. Several utilities are available to back up and restore data from Alteryx Server deployments, which can prove beneficial in the unlikely event of a system failure, data corruption or loss, or need to roll back to past data. Users can also reset the user or admin password for their MongoDB. 

Back up and restore data using the command line utilities available from the AlteryxService.exe executable. Because the database backup process requires Alteryx 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 first, then Workers, and last 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 Controller first, then Workers, and last 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.

Set New MongoDB Credentials

  1. Stop AlteryxService.
  2. From the command line, navigate to the directory to store the backup.
  3. Execute the following command to update the non-admin password: alteryxservice setemongopassword=[password]
  4. Execute the following command to update the admin password: alteryxservice seteadminmongopassword=[password]
  5. Restart AlteryxService.
Was This Helpful?

Need something else? Visit the Alteryx Community or contact support.