mirror/sqlstyle.guide
1
0
Fork 0
mirror of https://github.com/treffynnon/sqlstyle.guide.git synced 2025-03-09 12:49:51 -05:00
Code Activity

Merge pull request #2 from lumoslabs/indentation_update

Browse source 
Indentation rules
This commit is contained in:
apurvis 2016-05-28 16:32:53 +08:00
commit a472e83fb2
1 changed files with 60 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

71
_includes/sqlstyle.guide.md
View file

@ -153,6 +153,37 @@ WHERE p.release_date > '2014-09-30';
To make the code easier to read it is important that the correct amount of To make the code easier to read it is important that the correct amount of
spacing is used. Do not crowd code or remove natural language spaces. spacing is used. Do not crowd code or remove natural language spaces.
### Indentation
To ensure that SQL is readable it is important that standards of indentation
are followed.
**ONLY** the fundamental keywords - `SELECT`, `FROM`, `WHERE`, `GROUP BY`, `HAVING`, `LIMIT`,
and `ORDER BY`should be fully left justified.
For single `SELECT`s, you can use the single line form:
```sql
SELECT first_name
FROM rappers
```
If you are `SELECT`ing more than one column, place all selects on their own line indented 2
spaces in a block after the `SELECT` keyword.
```sql
SELECT
first_name,
last_name,
is_still_tippin_on_four_fours,
is_still_wrapped_in_four_vogues
FROM rappers
WHERE first_name = 'Mike'
AND last_name = 'Jones'
```
This allows the reader to quickly scan for the important building blocks of the query.
#### Spaces #### Spaces
Although not exhaustive always include spaces: Although not exhaustive always include spaces:
@ -163,7 +194,10 @@ Although not exhaustive always include spaces:
comma or semicolon. comma or semicolon.
```sql ```sql
SELECT a.title, a.release_date, a.recording_date SELECT
a.title,
a.release_date,
a.recording_date
FROM albums AS a FROM albums AS a
WHERE a.title = 'Charcoal Lane' WHERE a.title = 'Charcoal Lane'
OR a.title = 'The New Danger'; OR a.title = 'The New Danger';
@ -198,7 +232,8 @@ WHERE title = 'The New Danger';
``` ```
```sql ```sql
SELECT a.title, SELECT
a.title,
a.release_date, a.release_date,
a.recording_date, a.recording_date,
a.production_date a.production_date
@ -207,27 +242,6 @@ WHERE a.title = 'Charcoal Lane'
OR a.title = 'The New Danger'; OR a.title = 'The New Danger';
``` ```
### Indentation
To ensure that SQL is readable it is important that standards of indentation
are followed.
**ONLY** the fundamental keywords - `SELECT`, `FROM`, `WHERE`, `GROUP BY`, `HAVING`, `LIMIT`,
and `ORDER BY`should be fully left justified. Other clauses should be indented to the end of
that keyword.
```sql
SELECT first_name,
last_name,
is_still_tippin_on_four_fours,
is_still_wrapped_in_four_vogues
FROM rappers
WHERE first_name = 'Mike'
AND last_name = 'Jones'
```
This allows the reader to quickly scan for the important building blocks of the query.
#### Joins #### Joins
Joins should be indented 2 spaces right from the `FROM` keyword Joins should be indented 2 spaces right from the `FROM` keyword
@ -277,13 +291,16 @@ FROM my_tmp_table
#### Sub-queries #### Sub-queries
In PostgreSQL you should probably be doing subqueries with `WITH` clauses. In PostgreSQL you should probably be writing subqueries with `WITH` clauses and mostly avoiding the
use of inline subqueries.
Sub-queries should be left aligned 2 spaces to the right of the opening parentheses and then In MySQL or other query engines that do not support `WITH`, sub-queries should be left aligned 2
laid out using the same style as a `WITH` statement w/r/t parentheses. spaces to the right of the opening parentheses and then laid out using the same style as a `WITH`
statement w/r/t parentheses.
```sql ```sql
SELECT r.last_name, SELECT
r.last_name,
( (
SELECT MAX(YEAR(championship_date)) SELECT MAX(YEAR(championship_date))
FROM champions AS c FROM champions AS c