Модуль 01 · урок 8
Коментарі та форматування SQL
Через місяць ти відкриваєш свій же запит і не пам'ятаєш, навіщо він. А колега взагалі його не зрозуміє. Код читають частіше, ніж пишуть.
Навіщо охайність
SQL пишуть раз, а читають багато разів — і ти за місяць, і колеги. Тож запит має легко читатися людиною. (Зараз це може здаватися зайвим, оскільки до цього часу були лише прості запити, але вони бувають і складніші)
Коментарі
Коментарі СКБД ігнорує, але вони пояснюють намір:
-- однорядковий коментар
/* багаторядковий
коментар */
Форматування
Добре відформатований запит читається з першого погляду:
-- Топ-5 товарів за запасом
SELECT name, stock
FROM products
ORDER BY stock DESC
LIMIT 5;
-- Топ-5 товарів за запасом
select name, stock FROM products
ORDER by stock desc LIMIT 5;
Перший запит читається легше, ніж другий, хоча по суті вони є однаковими.
Звички, що допомагають:
- ключові слова — великими літерами (
SELECT,FROM,ORDER BY); - кожну велику секцію — з нового рядка;
- відступи для вкладеності.
Регістр ключових слів на роботу запиту не впливає — це суто для людей. Але великі літери роблять структуру помітною.
Твоя черга
Перед тобою неохайний запит в один рядок. Перепиши його чисто — і додай коментар, що він робить.
Підсумок
--однорядковий,/* ... */багаторядковий коментар.- Ключові слова —
UPPERCASEза домовленістю. - Форматування не змінює результат — лише читабельність.