Merge pull request #486 from it-at-m/389-vereinheitlichung-db

doku update für db naming
it-at-m · Oct 14, 2024 · 717f08e · 717f08e
2 parents 28ce07a + f0a010d
commit 717f08e
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 3 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -34,9 +34,12 @@ export default withMermaid({
                     text: 'Getting Started', link: `${PATH_TECHNIK}get_started/`
                 },
                 {text: 'Entwicklungsumgebung', link: `${PATH_TECHNIK}development/`},
-                {text: 'Coding Conventions', link: `${PATH_CODING_CONVENTIONS}`, collapsed: true, items: [
-                        {text: 'Naming Convention - Testing', link: `${PATH_CODING_CONVENTIONS}tests_naming`}
-                    ]},
+                {
+                    text: 'Coding Conventions', link: `${PATH_CODING_CONVENTIONS}`, collapsed: true, items: [
+                        {text: 'Naming Convention - Testing', link: `${PATH_CODING_CONVENTIONS}tests_naming`},
+                        {text: 'Naming Convention - Database', link: `${PATH_CODING_CONVENTIONS}db_naming`}
+                    ]
+                },
                 {
                     text: 'Adr', link: `${PATH_ADR}`, collapsed: true, items: [
                         {text: 'Renovate - ignoriere lombok', link: `${PATH_ADR}adr001-renovate-ignore-lombok`},

diff --git a/docs/src/technik/coding_conventions/db_naming.md b/docs/src/technik/coding_conventions/db_naming.md
@@ -0,0 +1,21 @@
+# Uppercase-Convention für Datenbanken
+
+## Kontext
+
+Aktuell sind sowohl Namen als auch Properties der Datenbanktabellen mal in Uppercase, mal in Lowercase.
+Sofern Oracle und h2 nicht durch eine Änderung der migration-scripts auf Probleme stößt, wurde die Frage gestellt, die
+Tabellennamen und Properties zu vereinheitlichen.
+
+## Entscheidung
+
+Nachdem ein Renaming der migration-scripts gemäß Recherche möglich ist, werden die Skripte aller Services refactored:
+Syntax in Uppercase, Tabellenname, entsprechend der Klassenamen, in UpperCamelCase und die Properties in lowerCamelCase.
+
+Beispiel:
+
+```sql [V1_0__createWahlbezirk.sql]
+CREATE TABLE Wahlbezirk
+(
+id VARCHAR2(36) NOT NULL,
+wahlbezirkArt VARCHAR2(3) NOT NULL
+)