GGM Generator schema.compile(any_model)
← Terug

Handleiding

De GGM Schema Generator genereert database schema's, visualisaties en Linked Data vanuit het Gemeentelijk Gegevensmodel v2.5.1. Deze handleiding legt uit hoe je de tool gebruikt, welke formaten beschikbaar zijn en hoe je de configuratie-opties inzet.

1 Een diagram selecteren

Via de boomstructuur

De sidebar links toont het volledige GGM per domein en subdomein. Klik op een domein om het uit te klappen en klik op een diagramnaam om het te selecteren — het wordt blauw gemarkeerd.

Via zoeken

Bovenaan de sidebar staat een zoekveld. Typ een (deel van een) diagramnaam en de boomstructuur filtert live mee. Handig bij grote domeinen zoals Ruimte of Sociaal Domein.

Wis is ook een reset — de Wis-knop wist niet alleen het zoekveld, maar reset ook de diagramselectie en de volledige configuratie. Gebruik dit om helemaal opnieuw te beginnen.

2 Een schematype kiezen

Kies het gewenste uitvoerformaat via de radiobuttons (of dropdown op mobiel):

DDL — Databaseschema's

  • MySQL — MySQL / MariaDB
  • MS SQL — SQL Server
  • Oracle — Oracle Database
  • PostgreSQL — PostgreSQL

Modelformaten

  • JSON — JSON Schema
  • RDF Turtle — Linked Data
  • ArchiMate — XML-export
  • dbDiagram.io — DBML
  • UML — PlantUML diagram

3 Genereren

Klik op Genereer. Het resultaat verschijnt rechts in het codepaneel met syntaxkleuring. Boven het resultaat staan twee knoppen:

  • Kopieer — kopieert de volledige output naar het klembord
  • Download — downloadt het bestand direct (.sql, .json, .ttl, .xml etc.)
De knop Configuratie wordt pas actief na het genereren van een DDL-formaat (MySQL, MS SQL, Oracle of PostgreSQL). Voor JSON, RDF, ArchiMate, dbDiagram en UML is configuratie niet van toepassing.

Visualiseren via externe tools

Sommige formaten zijn bedoeld om te bekijken in een externe applicatie. Kopieer de gegenereerde code en plak deze in:

4 Configuratie (alleen DDL)

Na het genereren van een DDL-schema klik je op Configuratie om het paneel te openen. Er zijn vier instelbare secties:

Constraints

Kies het type constraints: volledig (FKs + constraints), alleen FK-velden, of helemaal zonder. Je kunt dit op elk moment wijzigen en opnieuw genereren zonder de rest van de configuratie te verliezen.

Enumeraties

Toggle om enumeratietabellen wel of niet mee te genereren. Staat standaard aan.

Custom velden

Voeg extra kolommen toe aan alle tabellen — handig voor technische datawarehouse-velden zoals laaddatum, bronsysteem of versienummer. Per veld stel je naam, datatype en nullable in. Custom velden zijn ook vereist voor de technische sleutel optie.

Samengestelde primaire sleutel

Stel per tabel zelf samen welke kolommen de PRIMARY KEY vormen. Selecteer een tabel, vink de gewenste kolommen aan, en geconfigureerde tabellen verschijnen als chips. Nuttig wanneer het model al een logische bedrijfssleutel bevat.

Technische sleutel met unieke index

Voeg een surrogaatsleutel toe als technische PK en bewaar de bedrijfssleutel als unieke index. Vereist custom velden. Configureer per tabel welke kolommen de unieke index vormen.

Tabelprefixen

Geef tabelnamen een prefix per tabel. Handig voor consistente naamgeving of het combineren van meerdere domeinen in één database.

Historie op relaties — via EA-tag

Werkt automatisch op basis van een tag in Enterprise Architect: als een connector de tag Historie heeft, genereert de generator een koppeltabel met de suffix _HIS en twee extra kolommen: BEGINGELDIGHEID en EINDGELDIGHEID. Zo leg je vast in welke periode een relatie geldig was. Dit geldt ook voor 1:N-relaties.

KP_PERSOON_ADRES_HIS_ID (PK) PERSOON_ID ADRES_ID BEGINGELDIGHEID DATE EINDGELDIGHEID DATE

Configuratie exporteren en importeren

Rechts van de Genereer-knop staan twee knoppen (zichtbaar na openen Configuratie):

  • ↓ Exporteer — slaat de volledige configuratie op als .json-bestand
  • ↑ Importeer — laad een eerder opgeslagen configuratiebestand in

Zo kun je configuraties hergebruiken, delen met collega's of opslaan per project.

Veelgebruikte flows

Flow A — Snel een schema ophalen

Voor wanneer je een standaard DDL-bestand wilt zonder verdere configuratie.

  1. Zoek of selecteer een diagram in de sidebar
  2. Kies een DDL-formaat
  3. Klik Genereer
  4. Klik Download
Flow B — Schema met samengestelde primaire sleutel

Als het model al een logische bedrijfssleutel heeft die je direct als PK wilt gebruiken, zonder technisch surrogaat-ID.

  1. Selecteer een diagram en kies een DDL-formaat
  2. Klik Genereer
  3. Open Configuratie
  4. Schakel Samengestelde primaire sleutel in
  5. Selecteer per tabel de kolommen die samen de PK vormen
  6. Klik opnieuw Genereer en download het resultaat
Flow C — Technische primaire sleutel met unieke index

Als je een surrogaat-ID wilt toevoegen als technische PK en de bedrijfssleutel apart wilt bewaren via een unieke index — typisch voor datawarehouse-omgevingen.

  1. Selecteer een diagram en kies een DDL-formaat
  2. Klik Genereer
  3. Open Configuratie
  4. Schakel Custom velden in → voeg een technisch ID-veld toe (bijv. dwh_id INT)
  5. Schakel Technische sleutel met unieke index in → selecteer het ID-veld als PK
  6. Stel de indexkolommen in als bedrijfssleutel
  7. Klik opnieuw Genereer en download het resultaat
Flow D — Configuratie hergebruiken

Sla een configuratie op en gebruik deze later opnieuw of deel hem met collega's.

  1. Stel de gewenste configuratie in
  2. Klik ↓ Exporteer → sla het JSON-bestand op
  3. Open later hetzelfde of een ander diagram
  4. Klik ↑ Importeer → laad het opgeslagen bestand
  5. Klik Genereer
Flow E — Stabiele links voor een pipeline

Directe GitHub-links naar alle DDL- en JSON Schema bestanden, geschikt voor gebruik in pipelines of scripts.

  1. Ga naar de Downloads pagina
  2. Zoek het juiste domein in de accordion
  3. Kopieer de directe GitHub-link voor het gewenste formaat
  4. Gebruik de link in je pipeline, script of documentatie
Flow F — Diagram visualiseren via een externe tool

Sommige formaten zijn bedoeld om te bekijken in een externe applicatie.

  1. Selecteer een diagram
  2. Kies dbDiagram, UML of RDF Turtle
  3. Klik Genereer en dan Kopieer
  4. Open de externe tool en plak de code: