Export Database to a .ravendbdump file

Export options

Here you can filter the data you want to export, include encryption key, select collections and configurations, and apply a transform script on your documents.

Export Options

1. Include Documents
   Toggle to include documents and to enable inclusion of the following document related items:

   • Include Attachments
     Determines whether or not legacy attachments contained in the file should be imported where legacy attachments refers to v2.x and v3.x attachments.
   • Include Counters
   • Include Artificial Documents
   • Include Revisions
   • Include Conflicts

2. Other Features

   • Include Indexes
   • Remove Analyzers
   • Include Identities
   • Include Compare Exchange
   • Include Subscriptions
   • Include Configuration and OngoingTasks

3. Imported file is encrypted
   Toggle to include the decryption key when importing data from encrypted file.

Advanced export options

Select Advanced Export Options

1. Advanced
   Click the Advanced button to access the advanced export options.
   • Export all collections
   • Transform Script
   • Customize Configuration and Ongoing Tasks

Export all collections

In the Studio, select database > click Task tab > select Export Database > click the Advanced button at the bottom > toggle "Export all collections".

Advanced export options - Export all collections

• Export all collections:
  Determines whether to export All database collections.
  • This is on by default which means that all of the collections the database will be exported.
  • If Export all collections is disabled, a list of all database collections will be displayed with an option to filter collections by name.
    • Toggle "On" (switch becomes red and white) to include specific collections in the export.

Transform Script

In the Studio, select database > click Task tab > select Export Database > click the Advanced button at the bottom > toggle "Use Transform Script".

Advanced export options - Transform Script

• Use Transform Script:
  Enabling it allows you to provide a transform javascript, that would operate on each document contained by the file.

Sample transform javascript:

var id = doc['@metadata']['@id'];
if (id === 'orders/999')
    throw 'skip'; // filter-out

Customize Configuration and Ongoing Tasks

In the Studio, select database > click Task tab > select Export Database > click the Advanced button at the bottom > toggle "Customize Configuration and Ongoing Tasks".

Advanced export options - Customize Configuration and Ongoing Tasks

Ongoing tasks:

• Periodic Backups
• External replications
• ETL Tasks - Extract, Transform, Load
• Pull Replication Sinks
• Pull Replication Hubs

Other:

• Settings
• Conflict Solver Configuration
• Revisions Configuration
• Document Expiration
• Client Configuration
• Custom Sorters

Connection Strings

• Connection Strings used by ETL tasks to authenticate and connect to external databases will be exported.

Export Command via PowerShell

In the Studio, select database > click Task tab > select Export Database > click the Advanced button at the bottom.

Advanced export options - Copy command as PowerShell

• Generates the commands to run the exporting logic that you configure in this studio view from PowerShell.