io.ebean

Interface ScriptRunner

public interface ScriptRunner

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

  EbeanServer server = Ebean.getDefaultServer();
  server.script().run("/scripts/test-script.sql");

Example using place holders in the script

  Map<String,String> placeholders = new HashMap<>();
  placeholders.put("tableName", "e_basic");

  EbeanServer server = Ebean.getDefaultServer();
  server.script().run("/scripts/test-script.sql");

Method Summary

Modifier and Type	Method and Description
void	run(String path) Run a script given the resource path (that should start with "/").
void	run(String path, Map<String,String> placeholderMap) Run a script given the resource path (that should start with "/") and place holders.
void	run(URL resource) Run a DDL or SQL script given the resource.
void	run(URL resource, Map<String,String> placeholderMap) Run a DDL or SQL script given the resource and place holders.

Method Detail

run

void run(String path)

Run a script given the resource path (that should start with "/").

run

void run(String path,
         Map<String,String> placeholderMap)

Run a script given the resource path (that should start with "/") and place holders.

  Map<String,String> placeholders = new HashMap<>();
  placeholders.put("tableName", "e_basic");

  EbeanServer server = Ebean.getDefaultServer();
  server.script().run("/scripts/test-script.sql");

run

void run(URL resource)

Run a DDL or SQL script given the resource.

run

void run(URL resource,
         Map<String,String> placeholderMap)

Run a DDL or SQL script given the resource and place holders.