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 and Mike 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
PDF is the secondary output format. wkhtmltopdf is used to produce it.
Starting with version 3.5 you may access the PDF document from the appendix in the HTML site.
The PDF version is also accessible per version from Releases.
You find all releases and release information here.
The SQL code blocks in the Markdown files of this repository are automatically checked with db* CODECOP. The result is stored in SonarCloud. The idea is to follow our own guidelines, at least in the good examples.
- Install Docker in your environment
- Fork this respository
- For Windows users only
- Install Git for Windows, it provides Git command line tools, a GUI and a Bash emulator
- Check/change the version in mkdocs.yml
- Open a terminal window in the tools folder
- Build/update the table in appendix B
run
./genappendix.sh. - Build/update the PDF file
run
./genpdf.sh. - Test the HTML site locally
run
./serve.shand open http://localhost:8000 - Deploy HTML site
run
./mike.sh deploy main. - Set default version (HTML redirect)
run
./mike.sh set-default main.
- Build/update the table in appendix B
run
commitchanges andpushall branches.
The Trivadis PL/SQL & SQL Coding Guidelines are licensed under the Apache License, Version 2.0. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.