Module org.tentackle.sql

Package org.tentackle.sql

Class DefaultScriptRunner

java.lang.Object

org.tentackle.sql.DefaultScriptRunner

All Implemented Interfaces:

ScriptRunner

Direct Known Subclasses:

PostgresScriptRunner

public class DefaultScriptRunner
extends Object
implements ScriptRunner

Default implementation of a script runner.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DefaultScriptRunner.SQLCode	The next SQL code to execute as a statement.

Constructor Summary

Constructors

Constructor	Description
DefaultScriptRunner(Backend backend, Connection connection)	Creates a script runner.

Method Summary

Modifier and Type	Method	Description
DefaultScriptRunner.SQLCode	determineNextSqlCode(String script, int offset)	Determines the next SQL code to execute.
protected boolean	determinePosixEscapeSyntaxSupported()	Determines whether Posix escape syntax is supported by the backend and/or connection.
Backend	getBackend()	Gets the backend for this script runner.
Connection	getConnection()	Gets the connection for this script runner.
boolean	isEscapeProcessingEnabled()	Returns whether JDBC escape processing is enabled.
List<ScriptRunnerResult>	run(String script)	Runs the SQL script.
void	setEscapeProcessingEnabled(boolean enabled)	Enables or disables JDBC escape processing.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultScriptRunner

public DefaultScriptRunner(Backend backend,
 Connection connection)

Creates a script runner.

Parameters:

backend - the backend

connection - the SQL connection

See Also:

• AbstractBackend.createScriptRunner(Connection)

Method Details

getBackend

public Backend getBackend()

Description copied from interface: ScriptRunner

Gets the backend for this script runner.

Specified by:

getBackend in interface ScriptRunner

Returns:

the backend

getConnection

public Connection getConnection()

Description copied from interface: ScriptRunner

Gets the connection for this script runner.

Specified by:

getConnection in interface ScriptRunner

Returns:

the connection

setEscapeProcessingEnabled

public void setEscapeProcessingEnabled(boolean enabled)

Description copied from interface: ScriptRunner

Enables or disables JDBC escape processing.

Specified by:

setEscapeProcessingEnabled in interface ScriptRunner

Parameters:

enabled - true if escape processing is enabled

See Also:

• Statement.setEscapeProcessing(boolean)

isEscapeProcessingEnabled

public boolean isEscapeProcessingEnabled()

Description copied from interface: ScriptRunner

Returns whether JDBC escape processing is enabled.

Specified by:

isEscapeProcessingEnabled in interface ScriptRunner

Returns:

true if enabled (default)

run

public List<ScriptRunnerResult> run(String script)

Description copied from interface: ScriptRunner

Runs the SQL script.

Throws BackendException if script execution failed.

Specified by:

run in interface ScriptRunner

Parameters:

script - the SQL script

Returns:

the results, never null

determineNextSqlCode

public DefaultScriptRunner.SQLCode determineNextSqlCode(String script,
 int offset)

Determines the next SQL code to execute.

Parameters:

script - the SQL script

offset - the offset where to start in the script to find the next statement

Returns:

the next SQL code to send to the database, null if end of script found

determinePosixEscapeSyntaxSupported

protected boolean determinePosixEscapeSyntaxSupported()

Determines whether Posix escape syntax is supported by the backend and/or connection.

Returns:

true if supported