TEIV: Add readme about running pgsql-generator in teiv 27/13627/1
authorJvD_Ericsson <jeff.van.dam@est.tech>
Tue, 15 Oct 2024 14:49:34 +0000 (15:49 +0100)
committerJvD_Ericsson <jeff.van.dam@est.tech>
Tue, 15 Oct 2024 15:17:33 +0000 (16:17 +0100)
Change-Id: I8c41999940aeaf272287a6ac6f4d97ee3b6a7768
Signed-off-by: JvD_Ericsson <jeff.van.dam@est.tech>
teiv/src/test/resources/pgsqlschema/README.md [new file with mode: 0644]

diff --git a/teiv/src/test/resources/pgsqlschema/README.md b/teiv/src/test/resources/pgsqlschema/README.md
new file mode 100644 (file)
index 0000000..53f3a66
--- /dev/null
@@ -0,0 +1,7 @@
+# PGSQL schema generator
+During the `generate-resources` phase of the Maven build pgsql-schema-generator will run (see `exec-maven-plugin` in the
+`teiv` POM), v1 of the SQL files in this directory are **automatically overwritten** if there are changes to the YANG
+models.
+
+**NOTE**: After regenerating SQL files, ensure the new v1 SQL files are checked in to version control. This ensures
+that the generated SQL files remain in sync with the resource SQL files.