org.springframework.data.r2dbc.connectionfactory.init

Class ScriptUtils

java.lang.Object

org.springframework.data.r2dbc.connectionfactory.init.ScriptUtils

Deprecated.

since 1.2 in favor of Spring R2DBC. Use ScriptUtils instead.

@Deprecated
public abstract class ScriptUtils
extends Object

Generic utility methods for working with SQL scripts.

Mainly for internal use within the framework.

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BLOCK_COMMENT_END_DELIMITER Deprecated. Default end delimiter for block comments within SQL scripts: "*/".
static String	DEFAULT_BLOCK_COMMENT_START_DELIMITER Deprecated. Default start delimiter for block comments within SQL scripts: "/*".
static String	DEFAULT_COMMENT_PREFIX Deprecated. Default prefix for single-line comments within SQL scripts: "--".
static String	DEFAULT_STATEMENT_SEPARATOR Deprecated. Default statement separator within SQL scripts: ";".
static String	EOF_STATEMENT_SEPARATOR Deprecated. End of file (EOF) SQL statement separator: "^^^ END OF SCRIPT ^^^".
static String	FALLBACK_STATEMENT_SEPARATOR Deprecated. Fallback statement separator within SQL scripts: "\n".

Method Summary

Modifier and Type	Method and Description
static reactor.core.publisher.Mono<Void>	executeSqlScript(Connection connection, EncodedResource resource) Deprecated. Execute the given SQL script using default settings for statement separators, comment delimiters, and exception handling flags.
static reactor.core.publisher.Mono<Void>	executeSqlScript(Connection connection, EncodedResource resource, DataBufferFactory dataBufferFactory, boolean continueOnError, boolean ignoreFailedDrops, String commentPrefix, String separator, String blockCommentStartDelimiter, String blockCommentEndDelimiter) Deprecated. Execute the given SQL script.
static reactor.core.publisher.Mono<Void>	executeSqlScript(Connection connection, Resource resource) Deprecated. Execute the given SQL script using default settings for statement separators, comment delimiters, and exception handling flags.
static reactor.core.publisher.Mono<String>	readScript(EncodedResource resource, DataBufferFactory dataBufferFactory) Deprecated. Read a script without blocking from the given resource, using "--" as the comment prefix and ";" as the statement separator, and build a String containing the lines.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STATEMENT_SEPARATOR

public static final String DEFAULT_STATEMENT_SEPARATOR

Deprecated.

Default statement separator within SQL scripts: ";".

See Also:

Constant Field Values

FALLBACK_STATEMENT_SEPARATOR

public static final String FALLBACK_STATEMENT_SEPARATOR

Deprecated.

Fallback statement separator within SQL scripts: "\n".

Used if neither a custom separator nor the DEFAULT_STATEMENT_SEPARATOR is present in a given script.

See Also:

Constant Field Values

EOF_STATEMENT_SEPARATOR

public static final String EOF_STATEMENT_SEPARATOR

Deprecated.

End of file (EOF) SQL statement separator: "^^^ END OF SCRIPT ^^^".

This value may be supplied as the separator to executeSqlScript(Connection, EncodedResource, DataBufferFactory, boolean, boolean, String, String, String, String) to denote that an SQL script contains a single statement (potentially spanning multiple lines) with no explicit statement separator. Note that such a script should not actually contain this value; it is merely a virtual statement separator.

See Also:

Constant Field Values

DEFAULT_COMMENT_PREFIX

public static final String DEFAULT_COMMENT_PREFIX

Deprecated.

Default prefix for single-line comments within SQL scripts: "--".

See Also:

Constant Field Values

DEFAULT_BLOCK_COMMENT_START_DELIMITER

public static final String DEFAULT_BLOCK_COMMENT_START_DELIMITER

Deprecated.

Default start delimiter for block comments within SQL scripts: "/*".

See Also:

Constant Field Values

DEFAULT_BLOCK_COMMENT_END_DELIMITER

public static final String DEFAULT_BLOCK_COMMENT_END_DELIMITER

Deprecated.

Default end delimiter for block comments within SQL scripts: "*/".

See Also:

Constant Field Values

Method Detail

readScript

public static reactor.core.publisher.Mono<String> readScript(EncodedResource resource,
                                                             DataBufferFactory dataBufferFactory)

Deprecated.

Read a script without blocking from the given resource, using "--" as the comment prefix and ";" as the statement separator, and build a String containing the lines.

Parameters:

resource - the EncodedResource to be read.

dataBufferFactory - the buffer factory for non-blocking script loading.

Returns:

String containing the script lines.

See Also:

DefaultDataBufferFactory

executeSqlScript

public static reactor.core.publisher.Mono<Void> executeSqlScript(Connection connection,
                                                                 Resource resource)
                                                          throws ScriptException

Deprecated.

Execute the given SQL script using default settings for statement separators, comment delimiters, and exception handling flags.

Statement separators and comments will be removed before executing individual statements within the supplied script.

Warning: this method does not release the provided Connection.

Parameters:

connection - the R2DBC connection to use to execute the script; already configured and ready to use.

resource - the resource to load the SQL script from; encoded with the current platform's default encoding.

Returns:

Mono that initiates script execution and is notified upon completion.

Throws:

ScriptException - if an error occurred while executing the SQL script.

See Also:

executeSqlScript(Connection, EncodedResource, DataBufferFactory, boolean, boolean, String, String, String, String), DEFAULT_STATEMENT_SEPARATOR, DEFAULT_COMMENT_PREFIX, DEFAULT_BLOCK_COMMENT_START_DELIMITER, DEFAULT_BLOCK_COMMENT_END_DELIMITER, ConnectionFactoryUtils.getConnection(io.r2dbc.spi.ConnectionFactory), ConnectionFactoryUtils.releaseConnection(io.r2dbc.spi.Connection, io.r2dbc.spi.ConnectionFactory)

executeSqlScript

public static reactor.core.publisher.Mono<Void> executeSqlScript(Connection connection,
                                                                 EncodedResource resource)
                                                          throws ScriptException

Deprecated.

Execute the given SQL script using default settings for statement separators, comment delimiters, and exception handling flags.

Statement separators and comments will be removed before executing individual statements within the supplied script.

Warning: this method does not release the provided Connection.

Parameters:

connection - the R2DBC connection to use to execute the script; already configured and ready to use.

resource - the resource (potentially associated with a specific encoding) to load the SQL script from.

Returns:

Mono that initiates script execution and is notified upon completion.

Throws:

ScriptException - if an error occurred while executing the SQL script.

See Also:

executeSqlScript(Connection, EncodedResource, DataBufferFactory, boolean, boolean, String, String, String, String), DEFAULT_STATEMENT_SEPARATOR, DEFAULT_COMMENT_PREFIX, DEFAULT_BLOCK_COMMENT_START_DELIMITER, DEFAULT_BLOCK_COMMENT_END_DELIMITER, ConnectionFactoryUtils.getConnection(io.r2dbc.spi.ConnectionFactory), ConnectionFactoryUtils.releaseConnection(io.r2dbc.spi.Connection, io.r2dbc.spi.ConnectionFactory)

executeSqlScript

public static reactor.core.publisher.Mono<Void> executeSqlScript(Connection connection,
                                                                 EncodedResource resource,
                                                                 DataBufferFactory dataBufferFactory,
                                                                 boolean continueOnError,
                                                                 boolean ignoreFailedDrops,
                                                                 String commentPrefix,
                                                                 @Nullable
                                                                 String separator,
                                                                 String blockCommentStartDelimiter,
                                                                 String blockCommentEndDelimiter)
                                                          throws ScriptException

Deprecated.

Execute the given SQL script.

Statement separators and comments will be removed before executing individual statements within the supplied script.

Warning: this method does not release the provided Connection.

Parameters:

connection - the R2DBC connection to use to execute the script; already configured and ready to use.

dataBufferFactory - the buffer factory for non-blocking script loading.

resource - the resource (potentially associated with a specific encoding) to load the SQL script from.

continueOnError - whether or not to continue without throwing an exception in the event of an error.

ignoreFailedDrops - whether or not to continue in the event of specifically an error on a DROP statement.

commentPrefix - the prefix that identifies single-line comments in the SQL script (typically "--").

separator - the script statement separator; defaults to ";" if not specified and falls back to "\n" as a last resort; may be set to "^^^ END OF SCRIPT ^^^" to signal that the script contains a single statement without a separator.

blockCommentStartDelimiter - the start block comment delimiter.

blockCommentEndDelimiter - the end block comment delimiter.

Returns:

Mono that initiates script execution and is notified upon completion.

Throws:

ScriptException - if an error occurred while executing the SQL script.

See Also:

DEFAULT_STATEMENT_SEPARATOR, FALLBACK_STATEMENT_SEPARATOR, EOF_STATEMENT_SEPARATOR, ConnectionFactoryUtils.getConnection(io.r2dbc.spi.ConnectionFactory), ConnectionFactoryUtils.releaseConnection(io.r2dbc.spi.Connection, io.r2dbc.spi.ConnectionFactory)