Ensuring your SQL code is easy to read is essential for spotting mistakes as well as easing the adoption process for whoever may have to read it next! This can be done through the addition of whitespace, line breaks and comments which will make the code easier on the eye and quicker to visually process.
For instance, compare these two lines of code! which one is quicker to get to grips with, A or B?
Here are some of the best practices to keep your SQL code neat and tidy:
- Each line should represent a single idea, column or clause, this way you are breaking up the thought process in each line.
2. Have consistency in the casing, keeping operations all in the UPPER case makes it easier to distinguish and find.
3. Have meaningful aliases. it should be descriptive and intuitive for a user who is picking up the code to know what it represents.
4. Use indentation to group off a section that links to the line before, this creates white space and shows the user when the code is narrowing down in detail for an operation.
5. When listing, use line breaks, tab in, and then a comma at the start. This creates whitespace and a line for the eye to follow down the list, thus it is clear if there is a missing comma or column name.
6. Write comments, this can allow you to explain why syntax is used in sections of the code, so the user can understand why it was written and what purpose it has.
That is all of my tips, hope that has helped you to scrub up on your SQL coding best practices.
