convert_tz
- 新しい関数ドキュメントを書く際には、ユーザーがテストできるように、CREATE TABLE、INSERT/ロードデータの例を含めて、完全な例データを提供してください。 - この記事では、
CONVERT_TZを例にとり、関数ドキュメントを書くための要件を説明します。
説明
日時の値をあるタイムゾーンから別のタイムゾーンに変換します。
この関数は v2.0 からサポートされています。
この関数が何をするのか、その使用シナリオ、詳細、類似の関数との違い、サポートされているバージョンについて説明します。
構文
DATETIME CONVERT_TZ(DATETIME dt, VARCHAR from_tz, VARCHAR to_tz)
この関数の構文です。構文はコードブロックで囲んでください。
パラメータ
-
dt: 変換する日時の値。DATETIME がサポートされています。 -
from_tz: 元のタイムゾーン。VARCHAR がサポートされています。タイムゾーンは 2 つの形式で表現できます。1 つは Time Zone Database（例: Asia/Shanghai）、もう 1 つは UTC オフセット（例: +08:00）です。 -
to_tz: 目的のタイムゾーン。VARCHAR がサポートされています。その形式はfrom_tzと同じです。
- フォーマットは
parameter:description+data type（サポートされているすべてのデータ型を列挙）です。- 説明には、パラメータの説明、値の形式、値の範囲、このパラメータが必須かどうか、異なるデータ型を使用する場合の形式と単位を含める必要があります。
- データ型は大文字で記載してください。例えば、DATETIME。
戻り値
DATETIME データ型の値を返します。
必要に応じて追加の注意事項を提供できます:
- 入力値が複数のデータ型をサポートしている場合の戻り値の型。
- 入力値のデータ型がサポートされていない場合に返されるエラーの型（例: NULL）。
使用上の注意
Time Zone Database については、tz database time zones（Wikipedia）を参照してください。
この関数を使用する際の注意点や注意事項を追加することもできます。（任意）
例
例 1: 上海の日時をロサンゼルスに変換します。
MySQL > select convert_tz('2019-08-01 13:21:03', 'Asia/Shanghai', 'America/Los_Angeles');
-> 2019-07-31 22:21:03 |
例 2: UTC+08:00 の日時をロサンゼルスに変換します。
MySQL > select convert_tz('2019-08-01 13:21:03', '+08:00', 'America/Los_Angeles');
+--------------------------------------------------------------------+
| convert_tz('2019-08-01 13:21:03', '+08:00', 'America/Los_Angeles') |
+--------------------------------------------------------------------+
| 2019-07-31 22:21:03 |
+--------------------------------------------------------------------+
- この関数を使用する一般的な例を提供し、各例の目的を説明して、ユーザーが例をすぐに理解できるようにします。
- ユーザーがテストできるように、CREATE TABLE、INSERT/ロード、クエリを含む完全なデータ例を含めてください。
- 例で複数のシナリオを説明する必要がある場合は、各シナリオにコメントを追加して、ユーザーが理解しやすくしてください。
- 例が複雑な場合は、返される結果を説明してください。
