/*
 * Copyright 2004-2019 H2 Group. Multiple-Licensed under the MPL 2.0,
 * and the EPL 1.0 (http://h2database.com/html/license.html).
 * Initial Developer: H2 Group
 */
package org.h2.tools;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintStream;
import java.io.StringReader;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.Properties;
import java.util.concurrent.TimeUnit;

import org.h2.api.ErrorCode;
import org.h2.engine.Constants;
import org.h2.server.web.ConnectionInfo;
import org.h2.util.JdbcUtils;
import org.h2.util.ScriptReader;
import org.h2.util.SortedProperties;
import org.h2.util.StringUtils;
import org.h2.util.Tool;
import org.h2.util.Utils;

Interactive command line tool to access a database using JDBC.
@h2.resource
/** * Interactive command line tool to access a database using JDBC. * @h2.resource */
public class Shell extends Tool implements Runnable { private static final int MAX_ROW_BUFFER = 5000; private static final int HISTORY_COUNT = 20; // Windows: '\u00b3'; private static final char BOX_VERTICAL = '|'; private PrintStream err = System.err; private InputStream in = System.in; private BufferedReader reader; private Connection conn; private Statement stat; private boolean listMode; private int maxColumnSize = 100; private final ArrayList<String> history = new ArrayList<>(); private boolean stopHide; private String serverPropertiesDir = Constants.SERVER_PROPERTIES_DIR;
Options are case sensitive. Supported options are:
[-help] or [-?] Print the list of options
[-url "<url>"] The database URL (jdbc:h2:...)
[-user <user>] The user name
[-password <pwd>] The password
[-driver <class>] The JDBC driver class to use (not required in most cases)
[-sql "<statements>"] Execute the SQL statements and exit
[-properties "<dir>"] Load the server properties from this directory
If special characters don't work as expected, you may need to use -Dfile.encoding=UTF-8 (Mac OS X) or CP850 (Windows).
Params:
  • args – the command line arguments
@h2.resource
/** * Options are case sensitive. Supported options are: * <table> * <tr><td>[-help] or [-?]</td> * <td>Print the list of options</td></tr> * <tr><td>[-url "&lt;url&gt;"]</td> * <td>The database URL (jdbc:h2:...)</td></tr> * <tr><td>[-user &lt;user&gt;]</td> * <td>The user name</td></tr> * <tr><td>[-password &lt;pwd&gt;]</td> * <td>The password</td></tr> * <tr><td>[-driver &lt;class&gt;]</td> * <td>The JDBC driver class to use (not required in most cases)</td></tr> * <tr><td>[-sql "&lt;statements&gt;"]</td> * <td>Execute the SQL statements and exit</td></tr> * <tr><td>[-properties "&lt;dir&gt;"]</td> * <td>Load the server properties from this directory</td></tr> * </table> * If special characters don't work as expected, you may need to use * -Dfile.encoding=UTF-8 (Mac OS X) or CP850 (Windows). * @h2.resource * * @param args the command line arguments */
public static void main(String... args) throws SQLException { new Shell().runTool(args); }
Sets the standard error stream.
Params:
  • err – the new standard error stream
/** * Sets the standard error stream. * * @param err the new standard error stream */
public void setErr(PrintStream err) { this.err = err; }
Redirects the standard input. By default, System.in is used.
Params:
  • in – the input stream to use
/** * Redirects the standard input. By default, System.in is used. * * @param in the input stream to use */
public void setIn(InputStream in) { this.in = in; }
Redirects the standard input. By default, System.in is used.
Params:
  • reader – the input stream reader to use
/** * Redirects the standard input. By default, System.in is used. * * @param reader the input stream reader to use */
public void setInReader(BufferedReader reader) { this.reader = reader; }
Run the shell tool with the given command line settings.
Params:
  • args – the command line settings
/** * Run the shell tool with the given command line settings. * * @param args the command line settings */
@Override public void runTool(String... args) throws SQLException { String url = null; String user = ""; String password = ""; String sql = null; for (int i = 0; args != null && i < args.length; i++) { String arg = args[i]; if (arg.equals("-url")) { url = args[++i]; } else if (arg.equals("-user")) { user = args[++i]; } else if (arg.equals("-password")) { password = args[++i]; } else if (arg.equals("-driver")) { String driver = args[++i]; JdbcUtils.loadUserClass(driver); } else if (arg.equals("-sql")) { sql = args[++i]; } else if (arg.equals("-properties")) { serverPropertiesDir = args[++i]; } else if (arg.equals("-help") || arg.equals("-?")) { showUsage(); return; } else if (arg.equals("-list")) { listMode = true; } else { showUsageAndThrowUnsupportedOption(arg); } } if (url != null) { org.h2.Driver.load(); conn = DriverManager.getConnection(url, user, password); stat = conn.createStatement(); } if (sql == null) { promptLoop(); } else { ScriptReader r = new ScriptReader(new StringReader(sql)); while (true) { String s = r.readStatement(); if (s == null) { break; } execute(s); } if (conn != null) { conn.close(); } } }
Run the shell tool with the given connection and command line settings. The connection will be closed when the shell exits. This is primary used to integrate the Shell into another application.

Note: using the "-url" option in args doesn't make much sense since it will override the conn parameter.

Params:
  • conn – the connection
  • args – the command line settings
/** * Run the shell tool with the given connection and command line settings. * The connection will be closed when the shell exits. * This is primary used to integrate the Shell into another application. * <p> * Note: using the "-url" option in {@code args} doesn't make much sense * since it will override the {@code conn} parameter. * </p> * * @param conn the connection * @param args the command line settings */
public void runTool(Connection conn, String... args) throws SQLException { this.conn = conn; this.stat = conn.createStatement(); runTool(args); } private void showHelp() { println("Commands are case insensitive; SQL statements end with ';'"); println("help or ? Display this help"); println("list Toggle result list / stack trace mode"); println("maxwidth Set maximum column width (default is 100)"); println("autocommit Enable or disable autocommit"); println("history Show the last 20 statements"); println("quit or exit Close the connection and exit"); println(""); } private void promptLoop() { println(""); println("Welcome to H2 Shell " + Constants.getFullVersion()); println("Exit with Ctrl+C"); if (conn != null) { showHelp(); } String statement = null; if (reader == null) { reader = new BufferedReader(new InputStreamReader(in)); } while (true) { try { if (conn == null) { connect(); showHelp(); } if (statement == null) { print("sql> "); } else { print("...> "); } String line = readLine(); if (line == null) { break; } String trimmed = line.trim(); if (trimmed.isEmpty()) { continue; } boolean end = trimmed.endsWith(";"); if (end) { line = line.substring(0, line.lastIndexOf(';')); trimmed = trimmed.substring(0, trimmed.length() - 1); } String lower = StringUtils.toLowerEnglish(trimmed); if ("exit".equals(lower) || "quit".equals(lower)) { break; } else if ("help".equals(lower) || "?".equals(lower)) { showHelp(); } else if ("list".equals(lower)) { listMode = !listMode; println("Result list mode is now " + (listMode ? "on" : "off")); } else if ("history".equals(lower)) { for (int i = 0, size = history.size(); i < size; i++) { String s = history.get(i); s = s.replace('\n', ' ').replace('\r', ' '); println("#" + (1 + i) + ": " + s); } if (!history.isEmpty()) { println("To re-run a statement, type the number and press and enter"); } else { println("No history"); } } else if (lower.startsWith("autocommit")) { lower = StringUtils.trimSubstring(lower, "autocommit".length()); if ("true".equals(lower)) { conn.setAutoCommit(true); } else if ("false".equals(lower)) { conn.setAutoCommit(false); } else { println("Usage: autocommit [true|false]"); } println("Autocommit is now " + conn.getAutoCommit()); } else if (lower.startsWith("maxwidth")) { lower = StringUtils.trimSubstring(lower, "maxwidth".length()); try { maxColumnSize = Integer.parseInt(lower); } catch (NumberFormatException e) { println("Usage: maxwidth <integer value>"); } println("Maximum column width is now " + maxColumnSize); } else { boolean addToHistory = true; if (statement == null) { if (StringUtils.isNumber(line)) { int pos = Integer.parseInt(line); if (pos == 0 || pos > history.size()) { println("Not found"); } else { statement = history.get(pos - 1); addToHistory = false; println(statement); end = true; } } else { statement = line; } } else { statement += "\n" + line; } if (end) { if (addToHistory) { history.add(0, statement); if (history.size() > HISTORY_COUNT) { history.remove(HISTORY_COUNT); } } execute(statement); statement = null; } } } catch (SQLException e) { println("SQL Exception: " + e.getMessage()); statement = null; } catch (IOException e) { println(e.getMessage()); break; } catch (Exception e) { println("Exception: " + e.toString()); e.printStackTrace(err); break; } } if (conn != null) { try { conn.close(); println("Connection closed"); } catch (SQLException e) { println("SQL Exception: " + e.getMessage()); e.printStackTrace(err); } } } private void connect() throws IOException, SQLException { String url = "jdbc:h2:~/test"; String user = ""; String driver = null; try { Properties prop; if ("null".equals(serverPropertiesDir)) { prop = new Properties(); } else { prop = SortedProperties.loadProperties( serverPropertiesDir + "/" + Constants.SERVER_PROPERTIES_NAME); } String data = null; boolean found = false; for (int i = 0;; i++) { String d = prop.getProperty(Integer.toString(i)); if (d == null) { break; } found = true; data = d; } if (found) { ConnectionInfo info = new ConnectionInfo(data); url = info.url; user = info.user; driver = info.driver; } } catch (IOException e) { // ignore } println("[Enter] " + url); print("URL "); url = readLine(url).trim(); if (driver == null) { driver = JdbcUtils.getDriver(url); } if (driver != null) { println("[Enter] " + driver); } print("Driver "); driver = readLine(driver).trim(); println("[Enter] " + user); print("User "); user = readLine(user); for (;;) { String password = readPassword(); try { conn = JdbcUtils.getConnection(driver, url + ";IFEXISTS=TRUE", user, password); break; } catch (SQLException ex) { if (ex.getErrorCode() == ErrorCode.DATABASE_NOT_FOUND_2) { println("Type the same password again to confirm database creation."); String password2 = readPassword(); if (password.equals(password2)) { conn = JdbcUtils.getConnection(driver, url, user, password); break; } else { println("Passwords don't match. Try again."); continue; } } else { throw ex; } } } stat = conn.createStatement(); println("Connected"); }
Print the string without newline, and flush.
Params:
  • s – the string to print
/** * Print the string without newline, and flush. * * @param s the string to print */
protected void print(String s) { out.print(s); out.flush(); } private void println(String s) { out.println(s); out.flush(); } private String readPassword() throws IOException { try { Object console = Utils.callStaticMethod("java.lang.System.console"); print("Password "); char[] password = (char[]) Utils.callMethod(console, "readPassword"); return password == null ? null : new String(password); } catch (Exception e) { // ignore, use the default solution } Thread passwordHider = new Thread(this, "Password hider"); stopHide = false; passwordHider.start(); print("Password > "); String p = readLine(); stopHide = true; try { passwordHider.join(); } catch (InterruptedException e) { // ignore } print("\b\b"); return p; }
INTERNAL. Hides the password by repeatedly printing backspace, backspace, >, <.
/** * INTERNAL. * Hides the password by repeatedly printing * backspace, backspace, &gt;, &lt;. */
@Override public void run() { while (!stopHide) { print("\b\b><"); try { Thread.sleep(10); } catch (InterruptedException e) { // ignore } } } private String readLine(String defaultValue) throws IOException { String s = readLine(); return s.isEmpty() ? defaultValue : s; } private String readLine() throws IOException { String line = reader.readLine(); if (line == null) { throw new IOException("Aborted"); } return line; } private void execute(String sql) { if (StringUtils.isWhitespaceOrEmpty(sql)) { return; } long time = System.nanoTime(); try { ResultSet rs = null; try { if (stat.execute(sql)) { rs = stat.getResultSet(); int rowCount = printResult(rs, listMode); time = System.nanoTime() - time; println("(" + rowCount + (rowCount == 1 ? " row, " : " rows, ") + TimeUnit.NANOSECONDS.toMillis(time) + " ms)"); } else { int updateCount = stat.getUpdateCount(); time = System.nanoTime() - time; println("(Update count: " + updateCount + ", " + TimeUnit.NANOSECONDS.toMillis(time) + " ms)"); } } finally { JdbcUtils.closeSilently(rs); } } catch (SQLException e) { println("Error: " + e.toString()); if (listMode) { e.printStackTrace(err); } } } private int printResult(ResultSet rs, boolean asList) throws SQLException { if (asList) { return printResultAsList(rs); } return printResultAsTable(rs); } private int printResultAsTable(ResultSet rs) throws SQLException { ResultSetMetaData meta = rs.getMetaData(); int len = meta.getColumnCount(); boolean truncated = false; ArrayList<String[]> rows = new ArrayList<>(); // buffer the header String[] columns = new String[len]; for (int i = 0; i < len; i++) { String s = meta.getColumnLabel(i + 1); columns[i] = s == null ? "" : s; } rows.add(columns); int rowCount = 0; while (rs.next()) { rowCount++; truncated |= loadRow(rs, len, rows); if (rowCount > MAX_ROW_BUFFER) { printRows(rows, len); rows.clear(); } } printRows(rows, len); rows.clear(); if (truncated) { println("(data is partially truncated)"); } return rowCount; } private boolean loadRow(ResultSet rs, int len, ArrayList<String[]> rows) throws SQLException { boolean truncated = false; String[] row = new String[len]; for (int i = 0; i < len; i++) { String s = rs.getString(i + 1); if (s == null) { s = "null"; } // only truncate if more than one column if (len > 1 && s.length() > maxColumnSize) { s = s.substring(0, maxColumnSize); truncated = true; } row[i] = s; } rows.add(row); return truncated; } private int[] printRows(ArrayList<String[]> rows, int len) { int[] columnSizes = new int[len]; for (int i = 0; i < len; i++) { int max = 0; for (String[] row : rows) { max = Math.max(max, row[i].length()); } if (len > 1) { Math.min(maxColumnSize, max); } columnSizes[i] = max; } for (String[] row : rows) { StringBuilder buff = new StringBuilder(); for (int i = 0; i < len; i++) { if (i > 0) { buff.append(' ').append(BOX_VERTICAL).append(' '); } String s = row[i]; buff.append(s); if (i < len - 1) { for (int j = s.length(); j < columnSizes[i]; j++) { buff.append(' '); } } } println(buff.toString()); } return columnSizes; } private int printResultAsList(ResultSet rs) throws SQLException { ResultSetMetaData meta = rs.getMetaData(); int longestLabel = 0; int len = meta.getColumnCount(); String[] columns = new String[len]; for (int i = 0; i < len; i++) { String s = meta.getColumnLabel(i + 1); columns[i] = s; longestLabel = Math.max(longestLabel, s.length()); } StringBuilder buff = new StringBuilder(); int rowCount = 0; while (rs.next()) { rowCount++; buff.setLength(0); if (rowCount > 1) { println(""); } for (int i = 0; i < len; i++) { if (i > 0) { buff.append('\n'); } String label = columns[i]; buff.append(label); for (int j = label.length(); j < longestLabel; j++) { buff.append(' '); } buff.append(": ").append(rs.getString(i + 1)); } println(buff.toString()); } if (rowCount == 0) { for (int i = 0; i < len; i++) { if (i > 0) { buff.append('\n'); } String label = columns[i]; buff.append(label); } println(buff.toString()); } return rowCount; } }