SQL and PL/pgSQL Programming Style Guide - Versionsgeschichte

Stefan: /* Style guidelines for PL/pgSQL */

2020-06-01T18:43:49Z

Style guidelines for PL/pgSQL

← Nächstältere Version		Version vom 1. Juni 2020, 18:43 Uhr
Zeile 13:		Zeile 13:
	** Function parameter names in lowercase_with_underscores		** Function parameter names in lowercase_with_underscores
	** All-uppercase for CONSTANT_VARIABLES		** All-uppercase for CONSTANT_VARIABLES
	** (Local variables and functions start with _underscore => tbd.)		** Local variables and functions start with _underscore (=> tbd.)
	* Whitespace and newlines:		* Whitespace and newlines:
	** Two blank lines before top-level functions		** Two blank lines before top-level functions

Stefan: /* Style guidelines for SQL and in general */

2020-06-01T18:38:50Z

Style guidelines for SQL and in general

← Nächstältere Version		Version vom 1. Juni 2020, 18:38 Uhr
Zeile 1:		Zeile 1:
	== Style guidelines for SQL and in general ==		== Style guidelines for SQL and in general ==
	* File names in lowercase_with_underscores, ~~encoding~~ UTF-8		* File names in lowercase_with_underscores, use UTF-8 encoding
	* Use [http://sqlformat.darold.net/ Free Online version] of the PostgreSQL SQL syntax beautifier [https://github.com/darold/pgFormatter pgFormatter]		* Use [http://sqlformat.darold.net/ Free Online version] of the PostgreSQL SQL syntax beautifier [https://github.com/darold/pgFormatter pgFormatter]
	* Indent with 4 spaces (don't use tabs)		* Indent with 4 spaces (don't use tabs)

Stefan: /* Style guidelines for PL/pgSQL */

2020-06-01T18:35:12Z

Style guidelines for PL/pgSQL

← Nächstältere Version		Version vom 1. Juni 2020, 18:35 Uhr
Zeile 13:		Zeile 13:
	** Function parameter names in lowercase_with_underscores		** Function parameter names in lowercase_with_underscores
	** All-uppercase for CONSTANT_VARIABLES		** All-uppercase for CONSTANT_VARIABLES
	** (Local variables and functions start with _underscore = tbd.)		** (Local variables and functions start with _underscore => tbd.)
	* Whitespace and newlines:		* Whitespace and newlines:
	** Two blank lines before top-level functions		** Two blank lines before top-level functions

Stefan: /* Style guidelines for SQL and in general */

2020-06-01T18:32:29Z

Style guidelines for SQL and in general

← Nächstältere Version		Version vom 1. Juni 2020, 18:32 Uhr
Zeile 2:		Zeile 2:
	* File names in lowercase_with_underscores, encoding UTF-8		* File names in lowercase_with_underscores, encoding UTF-8
	* Use [http://sqlformat.darold.net/ Free Online version] of the PostgreSQL SQL syntax beautifier [https://github.com/darold/pgFormatter pgFormatter]		* Use [http://sqlformat.darold.net/ Free Online version] of the PostgreSQL SQL syntax beautifier [https://github.com/darold/pgFormatter pgFormatter]
	* Indent with 4 spaces (don't use ~~tags~~)		* Indent with 4 spaces (don't use tabs)
	* Max line-length 80 characters (especially in comments)		* Max line-length 80 characters (especially in comments)
	* IMPORTANT: '''Put keywords, datatypes and functions all-lowercase''' - opposite e.g. to Joe Celko’s - because they are _not_ the main content!		* IMPORTANT: '''Put keywords, datatypes and functions all-lowercase''' - opposite e.g. to Joe Celko’s - because they are _not_ the main content!

Stefan: /* Best Practices for PL/pgSQL */

2020-06-01T18:28:14Z

Best Practices for PL/pgSQL

← Nächstältere Version		Version vom 1. Juni 2020, 18:28 Uhr
Zeile 33:		Zeile 33:
	* Add COMMENT ON FUNCTION: see e.g. https://github.com/pgRouting/pgrouting/blob/master/sql/withPoints/withPoints.sql		* Add COMMENT ON FUNCTION: see e.g. https://github.com/pgRouting/pgrouting/blob/master/sql/withPoints/withPoints.sql
	* Do Unit Testing with PGUnit: https://github.com/adrianandrei-ca/pgunit (minimal introduction from Prof. Keller available).		* Do Unit Testing with PGUnit: https://github.com/adrianandrei-ca/pgunit (minimal introduction from Prof. Keller available).
			* Prefer triggers over rules.

	== Learning PL/pgSQL ==		== Learning PL/pgSQL ==

Stefan: /* Learning PL/pgSQL */

2020-06-01T18:23:06Z

Learning PL/pgSQL

← Nächstältere Version		Version vom 1. Juni 2020, 18:23 Uhr
Zeile 35:		Zeile 35:

	== Learning PL/pgSQL ==		== Learning PL/pgSQL ==
	* Book "PostgreSQL Server Programming", Packt. ~~e.g. "Summary of RETURN SETOF variants" => See PDF ("grey copy")~~		* Book "PostgreSQL Server Programming", Packt Publishing.
	~~http://index-of.co.uk/Database/SQL%20Database/PostgreSQL%20Server%20Programming%20-%20Second%20Edition%20by%20Usama%20Dar.pdf~~
	* "Introduction to PL/pgSQL Development", by Jim Mlodgenski from AWS, given at Percona Conference 2019: https://www.percona.com/live/19/sites/default/files/slides/Introduction%20to%20PL_pgSQL%20Development%20-%20FileId%20-%20187790.pdf1.		* "Introduction to PL/pgSQL Development", by Jim Mlodgenski from AWS, given at Percona Conference 2019: https://www.percona.com/live/19/sites/default/files/slides/Introduction%20to%20PL_pgSQL%20Development%20-%20FileId%20-%20187790.pdf1.

Stefan am 1. Juni 2020 um 18:22 Uhr

2020-06-01T18:22:02Z

← Nächstältere Version		Version vom 1. Juni 2020, 18:22 Uhr
Zeile 41:		Zeile 41:
	General:		General:
	* How to write an Extension: See https://github.com/dimitri/base36		* How to write an Extension: See https://github.com/dimitri/base36


			[[Kategorie:PostgreSQL]] [[Kategorie:SQL]] [[Kategorie:PL/pgSQL]] [[Kategorie:Programmieren]]

Stefan am 1. Juni 2020 um 18:20 Uhr

2020-06-01T18:20:32Z

← Nächstältere Version		Version vom 1. Juni 2020, 18:20 Uhr
Zeile 33:		Zeile 33:
	* Add COMMENT ON FUNCTION: see e.g. https://github.com/pgRouting/pgrouting/blob/master/sql/withPoints/withPoints.sql		* Add COMMENT ON FUNCTION: see e.g. https://github.com/pgRouting/pgrouting/blob/master/sql/withPoints/withPoints.sql
	* Do Unit Testing with PGUnit: https://github.com/adrianandrei-ca/pgunit (minimal introduction from Prof. Keller available).		* Do Unit Testing with PGUnit: https://github.com/adrianandrei-ca/pgunit (minimal introduction from Prof. Keller available).


	== Learning PL/pgSQL ==		== Learning PL/pgSQL ==

Stefan: /* Style guidelines for PL/pgSQL */

2020-06-01T18:20:14Z

Style guidelines for PL/pgSQL

← Nächstältere Version		Version vom 1. Juni 2020, 18:20 Uhr
Zeile 12:		Zeile 12:
	** Function names in lowercase_with_underscores (handle ST_-functions insensitive).		** Function names in lowercase_with_underscores (handle ST_-functions insensitive).
	** Function parameter names in lowercase_with_underscores		** Function parameter names in lowercase_with_underscores
	** Local variables and functions start with _underscore
	** All-uppercase for CONSTANT_VARIABLES		** All-uppercase for CONSTANT_VARIABLES
			** (Local variables and functions start with _underscore = tbd.)
	* Whitespace and newlines:		* Whitespace and newlines:
	** Two blank lines before top-level functions		** Two blank lines before top-level functions
Zeile 28:		Zeile 28:
	** In docstrings, list each argument on a separate line		** In docstrings, list each argument on a separate line
	** Docstrings should have a blank line after first line and before the final """		** Docstrings should have a blank line after first line and before the final """


	== Best Practices for PL/pgSQL ==		== Best Practices for PL/pgSQL ==

Stefan am 1. Juni 2020 um 18:18 Uhr

2020-06-01T18:18:57Z

← Nächstältere Version		Version vom 1. Juni 2020, 18:18 Uhr
Zeile 1:		Zeile 1:
	== SQL and general ==		== Style guidelines for SQL and in general ==
	* File names in lowercase_with_underscores, encoding UTF-8		* File names in lowercase_with_underscores, encoding UTF-8
	* Use [http://sqlformat.darold.net/ Free Online version] of the PostgreSQL SQL syntax beautifier [https://github.com/darold/pgFormatter pgFormatter]		* Use [http://sqlformat.darold.net/ Free Online version] of the PostgreSQL SQL syntax beautifier [https://github.com/darold/pgFormatter pgFormatter]
Zeile 7:		Zeile 7:
	* Else follow [https://www.sqlstyle.guide Sqlstyle.guide] which is compatible with Joe Celko’s SQL Programming Style book		* Else follow [https://www.sqlstyle.guide Sqlstyle.guide] which is compatible with Joe Celko’s SQL Programming Style book

	== PL/pgSQL ==		== Style guidelines for PL/pgSQL ==
	* Same as above plus (inspired partially by [https://tandysony.com/2018/02/14/pep-8.html PEP 8]):		* Same as above plus (inspired partially by [https://tandysony.com/2018/02/14/pep-8.html PEP 8]):
	* Naming conventions:		* Naming conventions:
Zeile 30:		Zeile 30:


	== PL/pgSQL ~~Best Practices~~ ==		== Best Practices for PL/pgSQL ==

	* Add COMMENT ON FUNCTION: see e.g. https://github.com/pgRouting/pgrouting/blob/master/sql/withPoints/withPoints.sql		* Add COMMENT ON FUNCTION: see e.g. https://github.com/pgRouting/pgrouting/blob/master/sql/withPoints/withPoints.sql