Repository files navigation

Trivadis published their guidelines for PL/SQL & SQL in 2009 in the context of the DOAG conference in Nuremberg. Since then these guidelines have been continuously extended and improved. Now they are managed as a set of markdown files. This makes the guidelines more adaptable for individual application needs and simplifies the continous improvement.

HTML is the primary output format.Material for MkDocs is used to generate static HTML files andMike to publish version specific variants. The following sites are available:

• Current version based on the main branch, snapshot version of the coming release
• Latest Release
• Releases
  • Version 4.4
  • Version 4.3
  • Version 4.2
  • Version 4.1
  • Version 4.0
  • Version 3.6
  • Version 3.5
  • Version 3.4
  • Version 3.3

PDF is the secondary output format.wkhtmltopdf is used to produce it.

Starting with version 3.5 you may access the PDF document from theappendix in the HTML site.

The PDF version is also accessible per version fromReleases.

You find all releases and release informationhere.

The SQL code blocks in the Markdown files of this repository are automatically checked with db* CODECOP. The result is stored inSonarCloud. The idea is to follow our own guidelines, at least in the good examples.

1. Install Docker in your environment
   • Install Docker Desktop for Mac
   • Install Docker Desktop on Windows
   • Install Docker Server on Linux
2. Fork this respository
3. For Windows users only
   • InstallGit for Windows, it provides Git command line tools, a GUI and a Bash emulator
4. Check/change the version inmkdocs.yml
5. Open a terminal window in thetools folder
   • Build/update the table in appendix Brun./genappendix.sh.
   • Build/update the PDF filerun./genpdf.sh.
   • Test the HTML site locallyrun./serve.sh and openhttp://localhost:8000
   • Deploy HTML siterun./mike.sh deploy main.
   • Set default version (HTML redirect)run./mike.sh set-default main.
6. commit changes andpush all branches.

• DOAG PL/SQL Conventions

The Trivadis PL/SQL & SQL Coding Guidelines are licensed under the Apache License, Version 2.0. You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0.