What is Smuggler

By default, the DocumentStore.smuggler works on the default document store database from the DocumentStore.database .

In order to switch it to a different database use the .forDatabase method.

const northwindSmuggler = store
    .smuggler
    .forDatabase("Northwind");

Usage

const operation = await store.smuggler.export(options, toDatabase);

const operation = await store.smuggler.export(options, toFile);

DatabaseSmugglerExportOptions

Example

const options = new DatabaseSmugglerExportOptions();
options.operateOnTypes = ["Documents"];
const operation = await store
    .smuggler
    .export(options, "C:\\ravendb-exports\\Northwind.ravendbdump");
await operation.waitForCompletion();

Usage

const operation = await store.smuggler.import(options, fromFile);

const operation = await store.smuggler.import(options, stream);

DatabaseSmugglerImportOptions

Example

const options = new DatabaseSmugglerImportOptions();
options.operateOnTypes = ["Documents"];
const operation = await store.smuggler.import(options, "C:\\ravendb-exports\\Northwind.ravendbdump");
await operation.waitForCompletion();

TransformScript exposes the ability to modify or even filter-out the document during the import and export process using the provided JavaScript.

Underneath the JavaScript engine is exactly the same as used for patching operations giving you identical syntax and capabilities with additional ability to filter out documents by throwing a 'skip' exception.

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

this.Freight = 15.3;