MySQL. Комментарии в глубину

Описание : в этой статье вы узнаете, как использовать комментарий MySQL для документирования оператора SQL или блока кода в MySQL.

Комментарии

Комментарии могут использоваться для документирования назначения оператора SQL или логики блока кода в хранимой процедуре. При разборе кода SQL, MySQL игнорирует часть комментариев. Он выполняет только часть SQL, за исключением исполняемого комментария, который мы обсудим в следующем разделе.

MySQL поддерживает три стиля комментариев:

1. От ‘–‘ до конца строки. Стиль двойного тире-комментария требует как минимум пробела или управляющего символа (пробел, табуляция, новая строка и т. д.) После второго тире.

   SELECT * FROM users; -- это комментарий

    

   Обратите внимание, что стандартный SQL не требует пробелов после второй черты. MySQL использует пробелы, чтобы избежать проблем с некоторыми конструкциями SQL, такими как:

   SELECT 10--1;

    

   Оператор возвращает 11. Если MySQL не использует пробелы, он возвращает 10.

    

2. От ‘#’до конца строки.

   SELECT
   lastName, firstName
   FROM
   employees
   WHERE
   reportsTo = 1002; # получить подчиненных

    

3. Комментарий в стиле C /**/ может занимать несколько строк. Этот стиль комментария используется для документирования блока кода SQL.

   /*
   Получить сотрудников торгового
   представителя в отчете
   */
   
   SELECT
   lastName, firstName
   FROM
   employees
   WHERE
   reportsTo = 1143
   AND jobTitle = 'Sales Rep';

    

Исполняемые комментарии

MySQL предоставляет исполняемые комментарии для поддержки переносимости между различными базами данных. Эти комментарии позволяют встраивать код SQL, который будет выполняться только в MySQL, но не в другие базы данных.

Ниже показан синтаксис исполняемого комментария:

/*! MySQL-specific code */

Например, следующий оператор использует исполняемый комментарий:

SELECT 1 /*! +1 */

Оператор возвращает 2 вместо 1. Однако он вернет 1, если вы выполните его в других системах баз данных.

Если вы хотите выполнить комментарий из определенной версии MySQL, вы используете следующий синтаксис:

/*!##### MySQL-specific code */

Строка ‘#####’ представляет минимальную версию MySQL, которая может выполнить комментарий. Первый # является основной версией, например, 5 или 8. Вторые 2 цифры (##) являются младшей версией. И последние 2 уровня патча.

Например, следующий комментарий является исполняемым только в MySQL 5.1.10 или более поздней версии:

CREATE TABLE t1 (
k INT AUTO_INCREMENT,
KEY (k)
) /*!50110 KEY_BLOCK_SIZE=1024; */

Из этой статье вы узнали, как использовать комментарий MySQL для документирования кода SQL в MySQL.

Читайте также

5 вещей, о которых следует помнить при выполнении SQL-запросов в производственной базе данных

4 года назад

Как скопировать или клонировать базу данных MySQL

2 года назад

Первичные и внешние ключи MySQL

3 года назад

Как установить Apache Cassandra в Ubuntu 20.04

4 года назад