Alle SQL queries documenteren, fantasie of noodzaak

Vaak is er geen apart document waarin de werking van een applicatie is beschreven. Deze informatie is in de meeste gevallen echter wel in het Functioneel Ontwerp terug te vinden. Daardoor is de functionele beschrijving meestal wel actueel, de ontwikkelaars hebben het functioneel ontwerp immers nodig als uitgangspunt voor de bouw van de applicatie.
De Functionele Beheerder heeft echter vaak zelfgemaakte SQL queries in beheer waarvan ook documentatie aanwezig hoort te zijn. Deze documentatie is nodig om de queries over te kunnen dragen en de werking te begrijpen. Van belang is dat we de volledige SQL query met alle statements bewaren: SQL updates, SQL subqueries, SQL sort etc. Afhankelijk van het soort SQL query dienen we het volgde te documenteren:

Standaard SQL query documenteren

Standaard SQL queries kennen een permanent karakter en zullen vaak regelmatig draaien. Tegen deze achtergrond dient een goede registratie en documentatie van de queries plaats te vinden zodat we altijd verantwoording over getoonde cijfers kunnen afgeleggen. De volgende gegevens moeten we vast­leggen:

• De querynaam
• Actuele versienummer
• Omschrijving van het doel van de query

  

• Omschrijving van de werking van de query incl. de tekortkomin­gen
• Datum waarop de versie in productie gegaan is
• Een uitdraai van de SQL statements

Van de vorige versies dient ten behoeve van de controleerbaarheid eveneens een registratie plaats te vinden, zodat altijd duidelijk is hoe bepaalde cijfers in het verleden tot stand kwamen. De volgende gegevens moeten we vast­leggen:

• De querynaam.
• Het versienummer.
• Omschrijving van het doel van de query.
• Omschrijving van de werking van de query incl. de tekortkomingen.
• Datum waarop de versie in productie gegaan is.
• Datum waarop de versie uit productie gegaan is.
• Een uitdraai van de SQL statements.

Aan standaard SQL queries dienen we meer zorg te besteden dan aan eenmalige SQL queries.

Eénmalige queries documenteren

Eénmalige SQL queries voor speciale opvragingen of externe opdrachten kennen geen permanent karakter. Niettemin dient er ook een goede registratie van deze SQL queries plaats te vinden, zodat we daarover later verantwoording kunnen afleggen. De volgende gege­vens moeten we vast­leggen:

• De querynaam
• Actuele versienummer
• Omschrijving van het doel van de query
• Omschrijving van de werking van de query incl. de tekortkomin­gen
• Datum waarop de versie in productie gegaan is
• Een uitdraai van de SQL statements

SQL Update queries documenteren

SQL Update queries mogen geen permanent karakter hebben maar dienen voor het herstellen van de SQL database nadat fouten ontstaan zijn. Het kan ook voorkomen dat er binnen de applicatie nog geen update functie voor een bepaalde tabel bestaat. Als dezelfde entiteiten frequent gemuteerd moeten worden, dienen we er een module voor te gebouwen.
Vanwege de functieschieding mogen SQL update queries  alleen door de systeembeheerders uitge­voerd te worden. Daarom dient er een goede registratie van de SQL update query plaats te vinden. Zodoende kan daar later verant­woording over afgelegd worden. De volgende gege­vens moeten we vast­leggen:

• De querynaam
• Actuele versienummer
• Omschrijving van het doel van de SQL Update query
• Omschrijving van de werking van de SQL Update query
• Datum waarop de versie in productie gegaan is
• Een uitdraai van de SQL Statements

Discussieer mee op LinkedIn.