Files

1.1 KiB
Raw Permalink Blame History

SQL Example Rules

Назначение

Секция показывает пример рабочего SQL для основного сценария использования таблицы.

Правила

  • SQL должен быть близок к рабочему, а не абстрактным псевдокодом;
  • если диалект БД не указан, допускается выбрать наиболее вероятный вариант и явно зафиксировать допущение;
  • пример должен отражать реальный сценарий документа: чтение, вставка, обновление или агрегация;
  • для read-сценариев по возможности показывать фильтрацию, сортировку и пагинацию;
  • если есть join, нужно кратко пояснить, зачем он нужен.

Формат

  • fenced code block с указанием sql;
  • под кодом 1-3 поясняющих bullets о ключевых условиях, индексах и параметрах.