What is Smuggler

By default, the DocumentStore.Smuggler works on the default document store database from the DocumentStore.Database property.

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

var northwindSmuggler = store
    .Smuggler
    .ForDatabase("Northwind");

Syntax

Task<Operation> ExportAsync(
    DatabaseSmugglerExportOptions options,
    DatabaseSmuggler toDatabase,
    CancellationToken token = default(CancellationToken));

Task<Operation> ExportAsync(
    DatabaseSmugglerExportOptions options,
    string toFile,
    CancellationToken token = default(CancellationToken));

DatabaseSmugglerExportOptions

Example

// export only Indexes and Documents to a given file
var exportOperation = await store
    .Smuggler
    .ExportAsync(
        new DatabaseSmugglerExportOptions
        {
            OperateOnTypes = DatabaseItemType.Indexes
                             | DatabaseItemType.Documents
        },
        @"C:\ravendb-exports\Northwind.ravendbdump",
        token);

await exportOperation.WaitForCompletionAsync();

Syntax

Task<Operation> ImportAsync(
    DatabaseSmugglerImportOptions options,
    Stream stream,
    CancellationToken token = default(CancellationToken));

Task<Operation> ImportAsync(
    DatabaseSmugglerImportOptions options,
    string fromFile,
    CancellationToken token = default(CancellationToken));

DatabaseSmugglerImportOptions

Example

// import only Documents from a given file
var importOperation = await store
    .Smuggler
    .ImportAsync(
        new DatabaseSmugglerImportOptions
        {
            OperateOnTypes = DatabaseItemType.Documents
        },
        // import the .ravendbdump file that you exported (i.e. in the export example above)
        @"C:\ravendb-exports\Northwind.ravendbdump",
        token);

await importOperation.WaitForCompletionAsync();

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;