Package org.h2.tools

Class Script


  • public class Script
    extends Tool
    Creates a SQL script file by extracting the schema and data of a database.
    • Field Summary

      • Fields inherited from class org.h2.util.Tool

        out
    • Constructor Summary

      Constructors 
      Constructor Description
      Script()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static void main​(java.lang.String... args)
      Options are case sensitive.
      static void process​(java.lang.String url, java.lang.String user, java.lang.String password, java.lang.String fileName, java.lang.String options1, java.lang.String options2)
      Backs up a database to a stream.
      static void process​(java.sql.Connection conn, java.lang.String fileName, java.lang.String options1, java.lang.String options2)
      Backs up a database to a stream.
      void runTool​(java.lang.String... args)
      Run the tool with the given output stream and arguments.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Script

        public Script()
    • Method Detail

      • main

        public static void main​(java.lang.String... args)
                         throws java.sql.SQLException
        Options are case sensitive.
        Supported options
        [-help] or [-?] Print the list of options
        [-url "<url>"] The database URL (jdbc:...)
        [-user <user>] The user name (default: sa)
        [-password <pwd>] The password
        [-script <file>] The target script file name (default: backup.sql)
        [-options ...] A list of options (only for embedded H2, see SCRIPT)
        [-quiet] Do not print progress information
        Parameters:
        args - the command line arguments
        Throws:
        java.sql.SQLException - on failure
      • runTool

        public void runTool​(java.lang.String... args)
                     throws java.sql.SQLException
        Description copied from class: Tool
        Run the tool with the given output stream and arguments.
        Specified by:
        runTool in class Tool
        Parameters:
        args - the argument list
        Throws:
        java.sql.SQLException - on failure
      • process

        public static void process​(java.lang.String url,
                                   java.lang.String user,
                                   java.lang.String password,
                                   java.lang.String fileName,
                                   java.lang.String options1,
                                   java.lang.String options2)
                            throws java.sql.SQLException
        Backs up a database to a stream.
        Parameters:
        url - the database URL
        user - the user name
        password - the password
        fileName - the target file name
        options1 - the options before the file name (may be an empty string)
        options2 - the options after the file name (may be an empty string)
        Throws:
        java.sql.SQLException - on failure
      • process

        public static void process​(java.sql.Connection conn,
                                   java.lang.String fileName,
                                   java.lang.String options1,
                                   java.lang.String options2)
                            throws java.sql.SQLException
        Backs up a database to a stream. The stream is not closed. The connection is not closed.
        Parameters:
        conn - the connection
        fileName - the target file name
        options1 - the options before the file name
        options2 - the options after the file name
        Throws:
        java.sql.SQLException - on failure