コメント構文

このドキュメントでは、TiDB でサポートされているコメント構文について説明します。

TiDB は次の 3 つのコメント スタイルをサポートしています。

• 行をコメントするには#使用します。

  SELECT 1+1;     # comments
  

  +------+
  | 1+1  |
  +------+
  |    2 |
  +------+
  1 row in set (0.00 sec)
  

• 行をコメントするには--使用します。

  SELECT 1+1;     -- comments
  

  +------+
  | 1+1  |
  +------+
  |    2 |
  +------+
  1 row in set (0.00 sec)
  

  このスタイルでは、 --後に少なくとも 1 つの空白が必要です。

  SELECT 1+1--1;
  

  +--------+
  | 1+1--1 |
  +--------+
  |      3 |
  +--------+
  1 row in set (0.01 sec)
  

• ブロックまたは複数行をコメント化するには/* */使用します。

  SELECT 1 /* this is an in-line comment */ + 1;
  

  +--------+
  | 1  + 1 |
  +--------+
  |      2 |
  +--------+
  1 row in set (0.01 sec)
  

  SELECT 1+
  /*
  /*> this is a
  /*> multiple-line comment
  /*> */
      1;
  

  +-------------------+
  | 1+
          1 |
  +-------------------+
  |                 2 |
  +-------------------+
  1 row in set (0.001 sec)
  

MySQL互換のコメント構文

MySQL と同様に、TiDB は C コメント スタイルのバリエーションをサポートしています。

/*! Specific code */

または

/*!50110 Specific code */

このスタイルでは、TiDB はコメント内のステートメントを実行します。

例えば：

SELECT /*! STRAIGHT_JOIN */ col1 FROM table1,table2 WHERE ...

TiDB では、別のバージョンを使用することもできます。

SELECT STRAIGHT_JOIN col1 FROM table1,table2 WHERE ...

コメントにサーバーのバージョン番号（たとえば/*!50110 KEY_BLOCK_SIZE=1024 */ ）が指定されている場合、MySQL では、このコメントの内容は MySQL バージョンが 5.1.10 以上の場合にのみ処理されることを意味します。ただし、TiDB では MySQL バージョン番号は機能せず、コメント内のすべての内容が処理されます。

TiDB固有のコメント構文

TiDB には独自のコメント構文 (つまり、TiDB 固有のコメント構文) があり、次の 2 つのタイプに分けられます。

• /*T! Specific code */ : この構文は TiDB によってのみ解析および実行され、他のデータベースでは無視されます。
• /*T![feature_id] Specific code */ : この構文は、異なるバージョンの TiDB 間の互換性を確保するために使用されます。TiDB は、現在のバージョンでfeature_idの対応する機能を実装している場合にのみ、このコメントの SQL フラグメントを解析できます。たとえば、 AUTO_RANDOM機能は v3.1.1 で導入されているため、このバージョンの TiDB は/*T![auto_rand] auto_random */ auto_randomに解析できます。10 AUTO_RANDOM機能は v3.0.0 で実装されていないため、上記の SQL ステートメント フラグメントは無視されます。/ **`/T![`文字内にスペースを残さないでください**。

オプティマイザコメント構文

別の種類のコメントは、オプティマイザーヒントとして特別に扱われます。

SELECT /*+ hint */ FROM ...;

TiDB がサポートするオプティマイザヒントの詳細については、 オプティマイザーのヒント参照してください。

注記：

MySQL クライアントでは、TiDB 固有のコメント構文はコメントとして扱われ、デフォルトでクリアされます。5.7.7 より前の MySQL クライアントでは、ヒントもコメントとして扱われ、デフォルトでクリアされます。クライアントを起動するときは、 --commentsオプションを使用することをお勧めします。たとえば、 mysql -h 127.0.0.1 -P 4000 -uroot --commentsです。

詳細についてはコメント構文参照してください。