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 #64 from vanillajonathan/patch-6

Browse source
This commit is contained in:
Simon Holywell 2020-05-26 11:16:47 +10:00 committed by GitHub
commit 0894a32de4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
_includes/sqlstyle.guide.md
View file

@ -16,7 +16,7 @@ It is easy to include this guide in [Markdown format][dl-md] as a part of a
project's code base or reference it here for anyone on the project to freely project's code base or reference it here for anyone on the project to freely
read—much harder with a physical book. read—much harder with a physical book.
SQL style guide by [Simon Holywell][simon] is licensed under a [Creative Commons SQL style guide by [Simon Holywell][simon] is licensed under a [Creative Commons
Attribution-ShareAlike 4.0 International License][licence]. Attribution-ShareAlike 4.0 International License][licence].
Based on a work at [https://www.sqlstyle.guide/][sqlstyleguide]. Based on a work at [https://www.sqlstyle.guide/][sqlstyleguide].
@ -26,9 +26,9 @@ Based on a work at [https://www.sqlstyle.guide/][sqlstyleguide].
* Use consistent and descriptive identifiers and names. * Use consistent and descriptive identifiers and names.
* Make judicious use of white space and indentation to make code easier to read. * Make judicious use of white space and indentation to make code easier to read.
* Store [ISO-8601][iso-8601] compliant time and date information * Store [ISO 8601][iso-8601] compliant time and date information
(`YYYY-MM-DD HH:MM:SS.SSSSS`). (`YYYY-MM-DD HH:MM:SS.SSSSS`).
* Try to use only standard SQL functions instead of vendor-specific functions for * Try to only use standard SQL functions instead of vendor-specific functions for
reasons of portability. reasons of portability.
* Keep code succinct and devoid of redundant SQL—such as unnecessary quoting or * Keep code succinct and devoid of redundant SQL—such as unnecessary quoting or
parentheses or `WHERE` clauses that can otherwise be derived. parentheses or `WHERE` clauses that can otherwise be derived.
@ -68,7 +68,7 @@ UPDATE file_system
* Ensure the name is unique and does not exist as a * Ensure the name is unique and does not exist as a
[reserved keyword][reserved-keywords]. [reserved keyword][reserved-keywords].
* Keep the length to a maximum of 30 bytes—in practice this is 30 characters * Keep the length to a maximum of 30 bytes—in practice this is 30 characters
unless you are using multi-byte character set. unless you are using a multi-byte character set.
* Names must begin with a letter and may not end with an underscore. * Names must begin with a letter and may not end with an underscore.
* Only use letters, numbers and underscores in names. * Only use letters, numbers and underscores in names.
* Avoid the use of multiple consecutive underscores—these can be hard to read. * Avoid the use of multiple consecutive underscores—these can be hard to read.
@ -196,7 +196,7 @@ implementation detail. Rivers are [bad in typography][rivers], but helpful here.
``` ```
Notice that `SELECT`, `FROM`, etc. are all right aligned while the actual column Notice that `SELECT`, `FROM`, etc. are all right aligned while the actual column
names and implementation specific details are left aligned. names and implementation-specific details are left aligned.
Although not exhaustive always include spaces: Although not exhaustive always include spaces:
@ -314,9 +314,9 @@ SELECT CASE postcode
## Create syntax ## Create syntax
When declaring schema information it is also important to maintain human When declaring schema information it is also important to maintain human-readable
readable code. To facilitate this ensure that the column definitions are code. To facilitate this ensure that the column definitions are ordered and
ordered and grouped together where it makes sense to do so. grouped together where it makes sense to do so.
Indent column definitions by four (4) spaces within the `CREATE` definition. Indent column definitions by four (4) spaces within the `CREATE` definition.
@ -420,7 +420,7 @@ CREATE TABLE staff (
* [Entity–Attribute–Value][eav] (EAV) tables—use a specialist product intended for * [Entity–Attribute–Value][eav] (EAV) tables—use a specialist product intended for
handling such schema-less data instead. handling such schema-less data instead.
* Splitting up data that should be in one table across many tables because of * Splitting up data that should be in one table across many tables because of
arbitrary concerns such as time-based archiving or location in a multi-national arbitrary concerns such as time-based archiving or location in a multinational
organisation. Later queries must then work across multiple tables with `UNION` organisation. Later queries must then work across multiple tables with `UNION`
rather than just simply querying one table. rather than just simply querying one table.
@ -1297,7 +1297,7 @@ These are some suggested column data types to use for maximum compatibility betw
#### Additional types #### Additional types
* Boolean * BOOLEAN
* INTERVAL * INTERVAL
* XML * XML