Export Database to a .ravendbdump file


  • Use the Export Database view to export data from your database to a .ravendbdump file.

  • .ravendbdump is RavenDB's format for exporting/importing a database, with backward compatibility between RavenDB versions.

  • On a sharded database, data can be exported from all shards into a .ravendbdump file.
    Read about exporting data from a sharded database in the section dedicated to this operation.

  • In this page:


Export Database View

The Export Database view allows you to select the data you want to export and export it to a .ravendbdump file.

Export Database View

Export Database View

  1. Export Database View
    Click to open the Export Database view.
  2. Documents and Extensions
    Select the document entities you want to export.
  3. Cluster Entities
    Select the cluster entities you want to export.
  4. Include Artificial Documents
    Toggle on to export Artificial Documents.
  5. Include Conflicts
    Toggle on to export Conflicts.
  6. Encrypt exported file
    Toggle on to encrypt the exported .ravendbdump file.
    When enabled, you'll be able to provide the encryption key that will be used.
    please store the key in a safe place so you can provide it when importing the stored file to decrypt the data.

    Provide Encryption Key

    Provide Encryption Key

  7. Advanced
    Click to display advanced export settings.

  8. Export Database
    Click to export the selected data to a .ravendbdump file.

Advanced Export Options

Display Advanced Options

Display Advanced Options

Click to display the advanced export options.


Advanced Export Options

Advanced Export Options

  1. Export all collections
    Disable to select the collections you want to export,
    or keep Enabled to export all collections.

    Export collections

    Export collections

    • Use the Filter bar to display the collection whose name includes the specified string.
  2. Use Transform script
    Toggle on to enter a custom JavaScript that will be executed over each exported document.

    Transform Script

    Transform Script

    • Sample transform javascript:
      var id = doc['@metadata']['@id'];
                if (id === 'orders/999')
                throw 'skip'; // filter-out
  3. Customize Configuration and Ongoing Tasks
    Toggle on to choose the components to export more specifically.

    Figure 6. Advanced Export Options - Customize Configuration and Ongoing Tasks

    Advanced export options - Customize Configuration and Ongoing Tasks

  4. Export Command
    Click to create a PowerShell, Cmd or Bash command.
    Running the command you created from the selected command line window will export your data as defined by your settings.

    PowerShell Command

    PowerShell Command

    A. Click the Export Command button and select the command line to prepare a command.
    B. Click to copy the created export command to the clipboard.

  5. Close Advanced
    Click to close the advanced export options view.

  6. Export Database
    Click to export the selected data by your settings to a .ravendbdump file.