From 4ac8dfbeef6b72cb9dbd5160efcf106fe7b96802 Mon Sep 17 00:00:00 2001 From: penekhun Date: Fri, 17 Nov 2023 21:20:16 +0900 Subject: [PATCH] docs: Add howto guidance on comments in sql for Database Initialization Refine the note about SQL comments in the documentation for initializing a database using basic SQL scripts in Spring Boot. The revised statement provides clearer guidance on using `--` for single-line comments and `/*` and `*/` for block comments, with a caution about potential issues with other comment formats. --- .../src/docs/asciidoc/howto/data-initialization.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-initialization.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-initialization.adoc index 3765e0ceb3b7..0aaebffc84d0 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-initialization.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-initialization.adoc @@ -62,6 +62,8 @@ While we do not recommend using multiple data source initialization technologies This will defer data source initialization until after any `EntityManagerFactory` beans have been created and initialized. `schema.sql` can then be used to make additions to any schema creation performed by Hibernate and `data.sql` can be used to populate it. +NOTE: When including comments in your SQL file, it is advisable to use `--` for single-line comments and `/++*++` and `++*++/` for block comments. Be cautious when using other comment formats, as they may lead to the omission of certain SQL statements during parsing. + If you are using a <>, like Flyway or Liquibase, you should use them alone to create and initialize the schema. Using the basic `schema.sql` and `data.sql` scripts alongside Flyway or Liquibase is not recommended and support will be removed in a future release.