Console - BACKUP

Executes a complete backup on the currently opened database. It then compresses the backup file using the ZIP algorithm. You can then restore a database from backups, using the RESTORE DATABASE command. You can automate backups using the Automatic-Backup server plugin.

Backups and restores are similar to the EXPORT DATABASE and IMPORT DATABASE, but they offer better performance than these options.

NOTE: OrientDB Community Edition does not support backing up remote databases. OrientDB Enterprise Edition does support this feature. For more information on how to implement this with Enterprise Edition, see Remote Backups.


BACKUP DATABASE <output-file> [-incremental] [-compressionLevel=<compressionLevel>] [-bufferSize=<bufferSize>]
  • <output-file> Defines the path to the backup file.
  • -incremental Option to execute an incremental backup. When enabled, it computes the data to backup as all new changes since the last backup. Available only in the OrientDB Enterprise Edition version 2.2 or later.
  • -compressionLevel Defines the level of compression for the backup file. Valid levels are 0 to 9. The default is 9. Available in 1.7 or later.
  • -bufferSize Defines the compression buffer size. By default, this is set to 1MB. Available in 1.7 or later.


In order to enable a user to execute this command, you must add the permission of create for the resource database.backup to the database user.


  • Backing up a database:
orientdb> CONNECT plocal:../databases/mydatabase admin admin
orientdb> BACKUP DATABASE /backups/

Backing current database to: database
Backup executed in 0.52 seconds

Backup API

In addition to backups called through the Console, you can also manage backups through the Java API. Using this, you can perform either a full or incremental backup on your database.

Full Backup

In Java or any other language that runs on top of the JVM, you can initiate a full backup by using the backup() method on a database instance.

db.backup(out, options, callable, listener, compressionLevel, bufferSize);
  • out Refers to the OutputStream that it uses to write the backup content. Use a FileOutputStream to make the backup persistent on disk.
  • options Defines backup options as a Map<String, Object> object.
  • callable Defines the callback to execute when the database is locked.
  • listener Defines the listened called for backup messages.
  • compressionLevel Defines the level of compression for the backup. It supports levels between 0 and 9, where 0 equals no compression and 9 the maximum. Higher compression levels do mean smaller files, but they also mean the backup requires more from the CPU at execution time.
  • bufferSize Defines the buffer size in bytes. The larger the buffer, the more efficient the comrpession.


ODatabaseDocumentTx db = new ODatabaseDocumentTx("plocal:/temp/mydb");"admin", "admin");
  OCommandOutputListener listener = new OCommandOutputListener() {
    public void onMessage(String iText) {

  OutputStream out = new FileOutputStream("/temp/");
} finally {

Incremental Backup

As of version 2.2, OrientDB Enterprise Edition supports incremental backups executed through Java or any language that runs on top of the JVM, using the incrementalBackup() method against a database instance.

  • backupDirectory Defines the directory where it generates the incremental backup files.

It is important that previous incremental backup files are present in the same directory, in order to compute the database portion to back up, based on the last incremental backup.


ODatabaseDocumentTx db = new ODatabaseDocumentTx("plocal:/temp/mydb");"admin", "admin");
} finally {

For more information, see:

results matching ""

    No results matching ""