From: JvD_Ericsson <jeff.van.dam@est.tech>
Date: Tue, 15 Oct 2024 14:49:34 +0000 (+0100)
Subject: TEIV: Add readme about running pgsql-generator in teiv
X-Git-Tag: 0.1.0~7
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=e92b5863d9677488b2334a18b84c6cbb599db9e4;p=smo%2Fteiv.git

TEIV: Add readme about running pgsql-generator in teiv

Change-Id: I8c41999940aeaf272287a6ac6f4d97ee3b6a7768
Signed-off-by: JvD_Ericsson <jeff.van.dam@est.tech>
---

diff --git a/teiv/src/test/resources/pgsqlschema/README.md b/teiv/src/test/resources/pgsqlschema/README.md
new file mode 100644
index 0000000..53f3a66
--- /dev/null
+++ b/teiv/src/test/resources/pgsqlschema/README.md
@@ -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.