Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nakatsu-kouki committed Jun 12, 2024
1 parent 8d56b36 commit 7846647
Showing 1 changed file with 11 additions and 28 deletions.
39 changes: 11 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 値可能性。<br/> この値は、NULL 値をカラムに格納できる場合は YES で、<br/>格納できない場合は NO。 |
| Constraints | 制約のタイプ。<br/>値は、UNIQUE, PRIMARY KEY, FOREIGN KEY または (MySQL 8.0.16) CHECK。 |
| Referenced | FOREIGN KEY が参照しているテーブルの名前。 |
| Default | カラムのデフォルト値。 |
| Extra | カラムについての追加情報。<br/>AUTO_INCREMENT 属性、ON UPDATE CURRENT_TIMESTAMP 属性、<br/>生成されたカラムの STORED GENERATED または VIRTUAL GENERATED、<br/>式のデフォルト値を持つカラムの DEFAULT_GENERATED。 |
| Comment | カラムのコメント。 |

## モチベーション

Expand All @@ -119,4 +102,4 @@ royleはドキュメントを生成するときにmysqlのテーブル情報を

## document

[コードについて](https://github.com/digeon-inc/royle/blob/main/doc/DOC.md)
[コードについて](https://github.com/digeon-inc/royle/blob/main/doc/DOC.md)

0 comments on commit 7846647

Please # to comment.