Package org.h2.tools

Class Backup

java.lang.Object
org.h2.util.Tool
org.h2.tools.Backup
public class Backup extends org.h2.util.Tool
Creates a backup of a database. This tool copies all database files. The database must be closed before using this tool. To create a backup while the database is in use, run the BACKUP SQL statement. In an emergency, for example if the application is not responding, creating a backup using the Backup tool is possible by using the quiet mode. However, if the database is changed while the backup is running in quiet mode, the backup could be corrupt.

  • Field Summary

    Fields inherited from class org.h2.util.Tool

    out

  • Constructor Summary

    Constructors
    Constructor
    Description
    Backup()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    execute(String zipFileName, String directory, String db, boolean quiet)
    Backs up database files.
    static void
    main(String... args)
    Options are case sensitive.
    void
    runTool(String... args)
    Run the tool with the given output stream and arguments.

    Methods inherited from class org.h2.util.Tool

    getMainClassName, isOption, printNoDatabaseFilesFound, setOut, showUsage, showUsageAndThrowUnsupportedOption, throwUnsupportedOption

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Backup

      public Backup()

  • Method Details

    • main

      public static void main(String... args) throws SQLException
      Options are case sensitive.
      Supported options are:
      [-help] or [-?] Print the list of options
      [-file <filename>] The target file name (default: backup.zip)
      [-dir <dir>] The source directory (default: .)
      [-db <database>] Source database; not required if there is only one
      [-quiet] Do not print progress information
      Parameters:
      args - the command line arguments
      Throws:
      SQLException - on failure

    • runTool

      public void runTool(String... args) throws SQLException
      Description copied from class: org.h2.util.Tool
      Run the tool with the given output stream and arguments.
      Specified by:
      runTool in class org.h2.util.Tool
      Parameters:
      args - the argument list
      Throws:
      SQLException - on failure

    • execute

      public static void execute(String zipFileName, String directory, String db, boolean quiet) throws SQLException
      Backs up database files.
      Parameters:
      zipFileName - the name of the target backup file (including path)
      directory - the source directory name
      db - the source database name (null if there is only one database, and empty string to backup all files in this directory)
      quiet - don't print progress information
      Throws:
      SQLException - on failure