Support custom comment prefix in JdbcTestUtils.executeSqlScript() [SPR-11519]

[spring-projects-issues]

Sam Brannen opened SPR-11519 and commented

Status Quo

JdbcTestUtils.readScript(LineNumberReader, String) already allows one to supply a custom commentPrefix. However, there is currently no variant of executeSqlScript() that allows you to provide the commentPrefix. Consequently, there is no way to execute a script and specify a custom comment prefix (e.g., "//" instead of "--").

Deliverables

1. Introduce overloaded versions of executeSqlScript() in JdbcTestUtils that allow one to supply a custom comment prefix.

---

Affects: 4.0 GA

Issue Links:

• Support multi-line SQL comments in ResourceDatabasePopulator and JdbcTestUtils [SPR-9531] #14165 Support multi-line SQL comments in ResourceDatabasePopulator and JdbcTestUtils

[spring-projects-issues]

Chris Baldwin commented

Sam Brannen Should people be extending JdbcTestUtils or should they be encouraged to place anything related to this common functionality in org.springframework.jdbc.support.JdbcUtils and use it from there?

On a related note will the comment parsing function need to be extended to support multiple concurrent single line comment types? The use case would be you document that you support both SQL comments (--) and Java style (//) comments. You won't know ahead of time which style any given user SQL script will use. To handle this you will need to have the parsing code check for both comment types as it is processing the script.

[spring-projects-issues]

Sam Brannen commented

Hi Chris,

Should people be extending JdbcTestUtils or should they be encouraged to place anything related to this common functionality in org.springframework.jdbc.support.JdbcUtils and use it from there?

Ideally, any part of the public API in JdbcTestUtils related to parsing and executing scripts should be deprecated once #14165 is complete.

So I will revisit the scope and necessity of this issue once #14165 is complete.

Regards,

Sam

[spring-projects-issues]

Sam Brannen commented

Hi Chris,

On a related note will the comment parsing function need to be extended to support multiple concurrent single line comment types?

No, I don't think that is necessary. It should be sufficient for developers to be able to specify the prefix to use for single-line comments, as scripts within a project typically do not include competing single-line comment prefixes.

Thanks for all of your feedback!

Sam

[spring-projects-issues]

Sam Brannen commented

Resolving this issue as Won't Fix, since all script execution code has been moved to ScriptUtils in the spring-jdbc module as a result of #14165.

Note that ScriptUtils.executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String) accepts parameters for all comment prefixes and delimiters.