From 7846647e2bd8dc2bdab094b7e8d36a5d15bf1539 Mon Sep 17 00:00:00 2001 From: nakatsu-kouki <134385872+nakatsu-kouki@users.noreply.github.com> Date: Thu, 13 Jun 2024 02:25:12 +0900 Subject: [PATCH] Update README.md --- README.md | 39 +++++++++++---------------------------- 1 file changed, 11 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index e22e99a..b1e4a61 100644 --- a/README.md +++ b/README.md @@ -78,33 +78,16 @@ royle --host mysql --password password --port 3306 --user docker --database temp ### 生成したドキュメントの表について -#### Name -カラムの名前。 - -#### TYPE -カラムのデータ型。 - -#### Nullable -カラムの NULL 値可能性。 この値は、NULL 値をカラムに格納できる場合は YES で、格納できない場合は NO - -#### Constraints -制約のタイプ。 値は、UNIQUE, PRIMARY KEY, FOREIGN KEY または (MySQL 8.0.16) CHECK - -#### Referenced -FOREIGN KEY が参照しているテーブルの名前。 - -#### Default -カラムのデフォルト値。 - -#### Extra -カラムについての追加情報。 -- AUTO_INCREMENT 属性 -- ON UPDATE CURRENT_TIMESTAMP 属性 -- 生成されたカラムの STORED GENERATED または VIRTUAL GENERATED -- 式のデフォルト値を持つカラムの DEFAULT_GENERATED - -#### Comment -カラムのコメント。 +| 列名 | 説明 | +|-------------|------------------------------| +| Name | カラムの名前。 | +| TYPE | カラムのデータ型。 | +| Nullable | カラムの NULL 値可能性。
この値は、NULL 値をカラムに格納できる場合は YES で、
格納できない場合は NO。 | +| Constraints | 制約のタイプ。
値は、UNIQUE, PRIMARY KEY, FOREIGN KEY または (MySQL 8.0.16) CHECK。 | +| Referenced | FOREIGN KEY が参照しているテーブルの名前。 | +| Default | カラムのデフォルト値。 | +| Extra | カラムについての追加情報。
AUTO_INCREMENT 属性、ON UPDATE CURRENT_TIMESTAMP 属性、
生成されたカラムの STORED GENERATED または VIRTUAL GENERATED、
式のデフォルト値を持つカラムの DEFAULT_GENERATED。 | +| Comment | カラムのコメント。 | ## モチベーション @@ -119,4 +102,4 @@ royleはドキュメントを生成するときにmysqlのテーブル情報を ## document -[コードについて](https://github.com/digeon-inc/royle/blob/main/doc/DOC.md) \ No newline at end of file +[コードについて](https://github.com/digeon-inc/royle/blob/main/doc/DOC.md)