Raven.Assure

Configurable Raven.Backup CLI and API wrapper for RavenDB.

Includes CLI tool (assure) with configurable settings and an API wrapper for Raven.Backup (Raven.Assure).

Install

Download the latest release assure-[version].zip.

Unzip into directory of your choice.

Configs

Copy configs/default.json to a new file in configs/ and tweak to your liking.

Backup location

"Out": {
  "To": {
    "FilePath": "C:\\your\\backup-folder"
  }
}

"In": {
  "From": {
    "FilePath": "C:\\your\\backup-folder"
  }
}

Warning: Out.To.FilePath and In.From.FilePath must be a full file path.

(✗) test.qa.raven.bak
(✓) C:\\temp\\test.qa.raven.bak

Incremental

"Out": {
  "Incremental": true
}

Incremental backups require particular settings in the RavenDB server configuration.

RemoveEncryptionKey

"Out": {
  "RemoveEncryptionKey": true
}

When this is set to true, the encryption key setting (SecuredSettings["Raven/Encryption/Key"]) in Database.Document files in the backup will be set to null.

"SecuredSettings": {
    "Raven/Encryption/Key": null
}

Restore (in) requires the encryption key to be added back to the Database.Document files. If using incremental backups, it must be added to the latest incremental Database.Document file.

To-do

• Add option to specify encryption key when restoring

Back up or restore a file system

"IsFileSystem": true,
"Out": {
  "From": {
    "Server": {
      "FileSystem": "Your.Files"
    }
  }
},  
"In": {
  "To": {
    "Server": {
      "FileSystem": "Your.Files.Restored"
    }
  }
}

CLI (> assure in/out ...)

> assure [out|in] [config-name]

Backup example

> assure out test.qa

API

To-do

• Add fluentish API docs