io.ebean.ScriptRunner Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation

composite of common runtime dependencies for all platforms

There is a newer version: 15.8.1

package io.ebean;

import java.net.URL;
import java.util.Map;

/**
 * Runs DDL and SQL scripts.
 * 
 * Typically these are scripts used for testing such as seed SQL scripts or truncate SQL scripts.
 * 

 * Scripts are executed in their own transaction and committed on successful completion.
 *
 * 
Example of simple use
 * {@code
 *
 *   Database database = DB.getDefault();
 *   database.script().run("/scripts/test-script.sql");
 *
 * }
 */
public interface ScriptRunner {

  /**
   * Run a script given the resource path (that should start with "/").
   */
  void run(String path);

  /**
   * Run a script given the resource path (that should start with "/") and place holders.
   *
   * {@code
   *
   *   Map placeholders = new HashMap<>();
   *   placeholders.put("tableName", "e_basic");
   *
   *   Database database = DB.getDefault();
   *   database.script().run("/scripts/test-script.sql", placeholders);
   *
   * }
   */
  void run(String path, Map placeholderMap);

  /**
   * Run a DDL or SQL script given the resource.
   */
  void run(URL resource);

  /**
   * Run a DDL or SQL script given the resource and place holders.
   */
  void run(URL resource, Map placeholderMap);

  /**
   * Run the raw provided DDL or SQL script.
   *
   * @param name          The name of the script for logging purposes
   * @param content       The SQL content
   * @param useAutoCommit Set to true to use auto commit true and continue when any errors occur
   */
  void runScript(String name, String content, boolean useAutoCommit);

}