Module org.seasar.doma.core

Package org.seasar.doma.jdbc.query

Interface ScriptQuery

All Superinterfaces:

Query

All Known Implementing Classes:

SqlFileScriptQuery

public interface ScriptQuery
extends Query

A query that executes SQL scripts.

This interface defines operations for executing SQL scripts from files or other sources.

Method Summary

Modifier and Type	Method	Description
String	getBlockDelimiter()	Returns the delimiter that separates SQL statements in the script.
boolean	getHaltOnError()	Returns whether execution should halt on error.
Supplier<Reader>	getReaderSupplier()	Returns a supplier that provides a reader for the script content.
String	getScriptFilePath()	Returns the path of the script file.
URL	getScriptFileUrl()	Returns the URL of the script file.
SqlLogType	getSqlLogType()	Returns the SQL log type for this script query.

Methods inherited from interface org.seasar.doma.jdbc.query.Query

comment, complete, getClassName, getConfig, getMethod, getMethodName, getQueryTimeout, getSql, prepare

Method Details

getScriptFileUrl

URL getScriptFileUrl()

Returns the URL of the script file.

Returns:

the URL of the script file

getReaderSupplier

Supplier<Reader> getReaderSupplier()

Returns a supplier that provides a reader for the script content.

Returns:

the reader supplier

getScriptFilePath

String getScriptFilePath()

Returns the path of the script file.

Returns:

the script file path

getBlockDelimiter

String getBlockDelimiter()

Returns the delimiter that separates SQL statements in the script.

Returns:

the block delimiter

getHaltOnError

boolean getHaltOnError()

Returns whether execution should halt on error.

Returns:

true if execution should halt on error

getSqlLogType

SqlLogType getSqlLogType()

Returns the SQL log type for this script query.

Returns:

the SQL log type