SQL coding style - Revision history

Devdocsbot: Protected "SQL coding style": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-13T14:07:34Z

Protected "SQL coding style": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 14:07, 13 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-13T14:05:17Z

Update migration status and path

← Older revision		Revision as of 14:05, 13 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/general/development/policies/codingstyle/sql}}
	This page describes recommended coding style for complex database queries.		This page describes recommended coding style for complex database queries.

Mudrd8mz: Text replacement - "" to ""

2021-07-14T20:23:24Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 20:23, 14 July 2021
Line 21:		Line 21:
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	$records = $DB->get_records_select('some_table', "id > ?", array(111));		$records = $DB->get_records_select('some_table', "id > ?", array(111));
	</~~code~~>		</syntaxhighlight>

	==Parameter placeholders==		==Parameter placeholders==
Line 32:		Line 32:
	WHERE id > :above";		WHERE id > :above";
	$records = $DB->get_records_sql($sql, array('above'=>111));		$records = $DB->get_records_sql($sql, array('above'=>111));
	</~~code~~>		</syntaxhighlight>

	==Indentation==		==Indentation==

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:36:11Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:36, 14 July 2021
				
Line 19:
Line 19:
All sql queries and fragments should be enclosed in double quotes, do not concat SQL from multiple parts if possible. The single quotes are used for sql strings, it also helps with visual highlighting and SQL code completion in some IDEs. All sql queries and fragments should be enclosed in double quotes, do not concat SQL from multiple parts if possible. The single quotes are used for sql strings, it also helps with visual highlighting and SQL code completion in some IDEs.



<code php> <syntaxhighlight lang="php">
$records = $DB->get_records_select('some_table', "id > ?", array(111)); $records = $DB->get_records_select('some_table', "id > ?", array(111));
</code> </code>
Line 27:
Line 27:
All variable query parameters must be specified via placeholders. It is possible to use three different types of placeholders: :named, ? and $1. It is recommended to use named parameters if there is more than one parameter. All variable query parameters must be specified via placeholders. It is possible to use three different types of placeholders: :named, ? and $1. It is recommended to use named parameters if there is more than one parameter.



<code php> <syntaxhighlight lang="php">
$sql = "SELECT * $sql = "SELECT *
           FROM {some_table}            FROM {some_table}



Mits: ja link
2021-02-21T07:30:18Z
ja link

				
				
				
				
				
				← Older revision
				Revision as of 07:30, 21 February 2021
				
Line 51:
Line 51:
[[Category:XMLDB]] [[Category:XMLDB]]
[[Category:DB]] [[Category:DB]]

[[ja:SQLコーディングスタイル]]



Marina.glancy: /* General rules */
2016-06-22T06:55:24Z
General rules

				
				
				
				
				
				← Older revision
				Revision as of 06:55, 22 June 2016
				
Line 13:
Line 13:
* Always use AS keyword for column aliases. * Always use AS keyword for column aliases.
* Never use AS keyword for table aliases. * Never use AS keyword for table aliases.
* Use <> for comparing if values are not equals and do not use !=



==Double quotes== ==Double quotes==



Emerrill: Updating to show table aliases info and link to Database page.
2014-06-11T15:32:25Z
Updating to show table aliases info and link to Database page.

				
				
				
				
				
				← Older revision
				Revision as of 15:32, 11 June 2014
				
Line 12:
Line 12:
* Do not use right joins. * Do not use right joins.
* Always use AS keyword for column aliases. * Always use AS keyword for column aliases.
* Never use AS keyword for table aliases.



==Double quotes== ==Double quotes==
Line 43:
Line 44:



* [[Data manipulation API]] * [[Data manipulation API]]
* [[Database]]
* [[Coding style]] * [[Coding style]]






Skodak: /* Parameter placeholders */
2013-06-14T11:22:04Z
Parameter placeholders

				
				
				
				
				
				← Older revision
				Revision as of 11:22, 14 June 2013
				
Line 23:
Line 23:
==Parameter placeholders== ==Parameter placeholders==



All variable query parameters must be specified via placeholders. It is possible to use three different types of placeholders: :named, ? and $1. It is recommended to use named parameters if there is more than one. All variable query parameters must be specified via placeholders. It is possible to use three different types of placeholders: :named, ? and $1. It is recommended to use named parameters if there is more than one parameter.



<code php> <code php>



Skodak: /* Subqueries */
2013-06-14T11:20:43Z
Subqueries

				
				
				
				
				
				← Older revision
				Revision as of 11:20, 14 June 2013
				
Line 38:
Line 38:
==Subqueries== ==Subqueries==



There are no strict rules for subquery indentation, see MDLSITE-1914. There are no strict rules for subquery indentation, the deciding factor is good readability - see MDLSITE-1914.
  



==See also== ==See also==



Skodak: /* See also */
2013-06-14T11:19:49Z
See also

				
				
				
				
				
				← Older revision
				Revision as of 11:19, 14 June 2013
				
Line 35:
Line 35:



[[File:sql_indentation.png]] [[File:sql_indentation.png]]

==Subqueries==

There are no strict rules for subquery indentation, see MDLSITE-1914.




==See also== ==See also==

← Older revision		Revision as of 13:36, 14 July 2021
Line 19:		Line 19:
	All sql queries and fragments should be enclosed in double quotes, do not concat SQL from multiple parts if possible. The single quotes are used for sql strings, it also helps with visual highlighting and SQL code completion in some IDEs.		All sql queries and fragments should be enclosed in double quotes, do not concat SQL from multiple parts if possible. The single quotes are used for sql strings, it also helps with visual highlighting and SQL code completion in some IDEs.

	<~~code~~ php>		<syntaxhighlight lang="php">
	$records = $DB->get_records_select('some_table', "id > ?", array(111));		$records = $DB->get_records_select('some_table', "id > ?", array(111));
	</code>		</code>
Line 27:		Line 27:
	All variable query parameters must be specified via placeholders. It is possible to use three different types of placeholders: :named, ? and $1. It is recommended to use named parameters if there is more than one parameter.		All variable query parameters must be specified via placeholders. It is possible to use three different types of placeholders: :named, ? and $1. It is recommended to use named parameters if there is more than one parameter.

	<~~code~~ php>		<syntaxhighlight lang="php">
	$sql = "SELECT *		$sql = "SELECT *
	FROM {some_table}		FROM {some_table}

← Older revision		Revision as of 07:30, 21 February 2021
Line 51:		Line 51:
	[[Category:XMLDB]]		[[Category:XMLDB]]
	[[Category:DB]]		[[Category:DB]]

			[[ja:SQLコーディングスタイル]]

← Older revision		Revision as of 06:55, 22 June 2016
Line 13:		Line 13:
	* Always use AS keyword for column aliases.		* Always use AS keyword for column aliases.
	* Never use AS keyword for table aliases.		* Never use AS keyword for table aliases.
			* Use <> for comparing if values are not equals and do not use !=

	==Double quotes==		==Double quotes==

← Older revision		Revision as of 15:32, 11 June 2014
Line 12:		Line 12:
	* Do not use right joins.		* Do not use right joins.
	* Always use AS keyword for column aliases.		* Always use AS keyword for column aliases.
			* Never use AS keyword for table aliases.

	==Double quotes==		==Double quotes==
Line 43:		Line 44:

	* [[Data manipulation API]]		* [[Data manipulation API]]
			* [[Database]]
	* [[Coding style]]		* [[Coding style]]

← Older revision		Revision as of 11:22, 14 June 2013
Line 23:		Line 23:
	==Parameter placeholders==		==Parameter placeholders==

	All variable query parameters must be specified via placeholders. It is possible to use three different types of placeholders: :named, ? and $1. It is recommended to use named parameters if there is more than one.		All variable query parameters must be specified via placeholders. It is possible to use three different types of placeholders: :named, ? and $1. It is recommended to use named parameters if there is more than one parameter.

	<code php>		<code php>

← Older revision		Revision as of 11:20, 14 June 2013
Line 38:		Line 38:
	==Subqueries==		==Subqueries==

	There are no strict rules for subquery indentation, see MDLSITE-1914.		There are no strict rules for subquery indentation, the deciding factor is good readability - see MDLSITE-1914.


	==See also==		==See also==

← Older revision		Revision as of 11:19, 14 June 2013
Line 35:		Line 35:

	[[File:sql_indentation.png]]		[[File:sql_indentation.png]]

			==Subqueries==

			There are no strict rules for subquery indentation, see MDLSITE-1914.


	==See also==		==See also==