Skip to content

Commit

Permalink
make doc
Browse files Browse the repository at this point in the history
  • Loading branch information
majimaccho committed Jun 4, 2024
1 parent 9756adb commit f4851e2
Show file tree
Hide file tree
Showing 39 changed files with 191 additions and 147 deletions.
14 changes: 8 additions & 6 deletions sample/adjust/public.post_comment_stars.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,6 @@ CREATE MATERIALIZED VIEW post_comment_stars AS (

</details>

## Referenced Tables

- [public.comments](public.comments.md)
- [public.comment_stars](public.comment_stars.md)
- [public.users](public.users.md)

## Columns

| Name | Type | Default | Nullable | Children | Parents | Comment |
Expand All @@ -37,6 +31,14 @@ CREATE MATERIALIZED VIEW post_comment_stars AS (
| created | timestamp without time zone | | true | | | |
| updated | timestamp without time zone | | true | | | |

## Referenced Tables

| Name | Columns | Comment | Type |
| ----------------------------------------------- | ------- | ------------------------------------------ | ---------- |
| [public.comments](public.comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |
| [public.comment_stars](public.comment_stars.md) | 6 | | BASE TABLE |
| [public.users](public.users.md) | 6 | Users table | BASE TABLE |

## Relations

![er](public.post_comment_stars.svg)
Expand Down
14 changes: 8 additions & 6 deletions sample/adjust/public.post_comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,6 @@ CREATE VIEW post_comments AS (

</details>

## Referenced Tables

- [public.posts](public.posts.md)
- [public.comments](public.comments.md)
- [public.users](public.users.md)

## Columns

| Name | Type | Default | Nullable | Children | Parents | Comment |
Expand All @@ -43,6 +37,14 @@ CREATE VIEW post_comments AS (
| created | timestamp without time zone | | true | | | comments.created |
| updated | timestamp without time zone | | true | | | comments.updated |

## Referenced Tables

| Name | Columns | Comment | Type |
| ------------------------------------- | ------- | ------------------------------------------ | ---------- |
| [public.posts](public.posts.md) | 8 | Posts table | BASE TABLE |
| [public.comments](public.comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |
| [public.users](public.users.md) | 6 | Users table | BASE TABLE |

## Relations

![er](public.post_comments.svg)
Expand Down
2 changes: 1 addition & 1 deletion sample/adjust/schema.json

Large diffs are not rendered by default.

14 changes: 8 additions & 6 deletions sample/detect_relations/post_comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2

</details>

## Referenced Tables

- [posts](posts.md)
- [comments](comments.md)
- [users](users.md)

## Columns

| Name | Type | Default | Nullable | Children | Parents | Comment |
Expand All @@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
| created | datetime | | true | | | comments.created |
| updated | datetime | | true | | | comments.updated |

## Referenced Tables

| Name | Columns | Comment | Type | Labels |
| ---- | ------- | ------- | ---- | ------ |
| [posts](posts.md) | 7 | Posts table | BASE TABLE | `green` `red` `blue` |
| [comments](comments.md) | 6 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE | |
| [users](users.md) | 6 | Users table | BASE TABLE | |

## Relations

![er](post_comments.svg)
Expand Down
2 changes: 1 addition & 1 deletion sample/detect_relations/schema.json

Large diffs are not rendered by default.

14 changes: 8 additions & 6 deletions sample/detect_relations_singular/post_comment.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ CREATE VIEW post_comment AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2`

</details>

## Referenced Tables

- [post](post.md)
- [comment](comment.md)
- [user](user.md)

## Columns

| Name | Type | Default | Nullable | Children | Parents | Comment |
Expand All @@ -31,6 +25,14 @@ CREATE VIEW post_comment AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2`
| created | datetime | | true | | | comment.created |
| updated | datetime | | true | | | comment.updated |

## Referenced Tables

| Name | Columns | Comment | Type | Labels |
| ---- | ------- | ------- | ---- | ------ |
| [post](post.md) | 7 | Post table | BASE TABLE | `green` `red` `blue` |
| [comment](comment.md) | 6 | Comment<br>Multi-line<br>table<br>comment | BASE TABLE | |
| [user](user.md) | 6 | User table | BASE TABLE | |

## Relations

![er](post_comment.svg)
Expand Down
2 changes: 1 addition & 1 deletion sample/detect_relations_singular/schema.json

Large diffs are not rendered by default.

14 changes: 8 additions & 6 deletions sample/dict/post_comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2

</details>

## Referenced Tables

- [posts](posts.md)
- [comments](comments.md)
- [users](users.md)

## カラム一覧

| 名前 | タイプ | デフォルト値 | Nullable | 子テーブル | 親テーブル | コメント |
Expand All @@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
| created | datetime | | true | | | |
| updated | datetime | | true | | | |

## Referenced Tables

| 名前 | カラム一覧 | コメント | タイプ |
| ------------------------- | --------------- | ---------------------------------------------- | ------------- |
| [posts](posts.md) | 7 | Posts table | BASE TABLE |
| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |
| [users](users.md) | 6 | Users table | BASE TABLE |

## ER図

![er](post_comments.svg)
Expand Down
2 changes: 1 addition & 1 deletion sample/dict/schema.json

Large diffs are not rendered by default.

14 changes: 8 additions & 6 deletions sample/exclude/post_comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2

</details>

## Referenced Tables

- [posts](posts.md)
- [comments](comments.md)
- [users](users.md)

## Columns

| Name | Type | Default | Nullable | Children | Parents | Comment |
Expand All @@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
| created | datetime | | true | | | comments.created |
| updated | datetime | | true | | | comments.updated |

## Referenced Tables

| Name | Columns | Comment | Type |
| ---- | ------- | ------- | ---- |
| [posts](posts.md) | 7 | Posts table | BASE TABLE |
| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |
| [users](users.md) | 6 | Users table | BASE TABLE |

## Relations

![er](post_comments.svg)
Expand Down
2 changes: 1 addition & 1 deletion sample/exclude/schema.json

Large diffs are not rendered by default.

14 changes: 8 additions & 6 deletions sample/font/post_comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2

</details>

## Referenced Tables

- [posts](posts.md)
- [comments](comments.md)
- [users](users.md)

## Columns

| Name | Type | Default | Nullable | Children | Parents | Comment |
Expand All @@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
| created | datetime | | true | | | comments.created |
| updated | datetime | | true | | | comments.updated |

## Referenced Tables

| Name | Columns | Comment | Type |
| ---- | ------- | ------- | ---- |
| [posts](posts.md) | 7 | エントリ | BASE TABLE |
| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE |
| [users](users.md) | 6 | Users table | BASE TABLE |

## Relations

![er](post_comments.png)
Expand Down
2 changes: 1 addition & 1 deletion sample/font/schema.json

Large diffs are not rendered by default.

14 changes: 8 additions & 6 deletions sample/hide/post_comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2

</details>

## Referenced Tables

- [posts](posts.md)
- [comments](comments.md)
- [users](users.md)

## Columns

| Name | Type | Default | Nullable | Comment |
Expand All @@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
| created | datetime | | true | comments.created |
| updated | datetime | | true | comments.updated |

## Referenced Tables

| Name | Columns | Comment | Type | Labels |
| ---- | ------- | ------- | ---- | ------ |
| [posts](posts.md) | 7 | Posts table | BASE TABLE | `green` `red` `blue` |
| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE | |
| [users](users.md) | 6 | Users table | BASE TABLE | |

## Relations

![er](post_comments.svg)
Expand Down
2 changes: 1 addition & 1 deletion sample/hide/schema.json

Large diffs are not rendered by default.

14 changes: 8 additions & 6 deletions sample/hide_not_related_column/post_comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2

</details>

## Referenced Tables

- [posts](posts.md)
- [comments](comments.md)
- [users](users.md)

## Columns

| Name | Type | Default | Nullable | Children | Parents | Comment |
Expand All @@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
| created | datetime | | true | | | comments.created |
| updated | datetime | | true | | | comments.updated |

## Referenced Tables

| Name | Columns | Comment | Type | Labels |
| ---- | ------- | ------- | ---- | ------ |
| [posts](posts.md) | 7 | Posts table | BASE TABLE | `green` `red` `blue` |
| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE | |
| [users](users.md) | 6 | Users table | BASE TABLE | |

## Relations

![er](post_comments.svg)
Expand Down
2 changes: 1 addition & 1 deletion sample/hide_not_related_column/schema.json

Large diffs are not rendered by default.

14 changes: 8 additions & 6 deletions sample/mariadb/post_comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ CREATE VIEW post_comments AS ((select `c`.`id` AS `id`,`p`.`title` AS `title`,`u

</details>

## Referenced Tables

- [posts](posts.md)
- [comments](comments.md)
- [users](users.md)

## Columns

| Name | Type | Default | Nullable | Children | Parents | Comment |
Expand All @@ -31,6 +25,14 @@ CREATE VIEW post_comments AS ((select `c`.`id` AS `id`,`p`.`title` AS `title`,`u
| created | datetime | | true | | | comments.created |
| updated | datetime | NULL | true | | | comments.updated |

## Referenced Tables

| Name | Columns | Comment | Type | Labels |
| ---- | ------- | ------- | ---- | ------ |
| [posts](posts.md) | 7 | Posts table | BASE TABLE | `green` `red` `blue` |
| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE | |
| [users](users.md) | 6 | Users table | BASE TABLE | |

## Relations

![er](post_comments.svg)
Expand Down
2 changes: 1 addition & 1 deletion sample/mariadb/schema.json

Large diffs are not rendered by default.

14 changes: 8 additions & 6 deletions sample/mermaid/post_comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2

</details>

## Referenced Tables

- [posts](posts.md)
- [comments](comments.md)
- [users](users.md)

## Columns

| Name | Type | Default | Nullable | Children | Parents | Comment |
Expand All @@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
| created | datetime | | true | | | comments.created |
| updated | datetime | | true | | | comments.updated |

## Referenced Tables

| Name | Columns | Comment | Type | Labels |
| ---- | ------- | ------- | ---- | ------ |
| [posts](posts.md) | 7 | Posts table | BASE TABLE | `green` `red` `blue` |
| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE | |
| [users](users.md) | 6 | Users table | BASE TABLE | |

## Relations

```mermaid
Expand Down
2 changes: 1 addition & 1 deletion sample/mermaid/schema.json

Large diffs are not rendered by default.

10 changes: 6 additions & 4 deletions sample/mssql/name with spaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,18 @@ CREATE VIEW "name with spaces" AS (

</details>

## Referenced Tables

- [posts](posts.md)

## Columns

| Name | Type | Default | Nullable | Children | Parents | Comment |
| ---- | ---- | ------- | -------- | -------- | ------- | ------- |
| title | varchar(255) | | false | | | |

## Referenced Tables

| Name | Columns | Comment | Type | Labels |
| ---- | ------- | ------- | ---- | ------ |
| [posts](posts.md) | 6 | | BASIC TABLE | `green` `red` `blue` |

## Relations

![er](name%20with%20spaces.svg)
Expand Down
14 changes: 8 additions & 6 deletions sample/mssql/post_comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,6 @@ CREATE VIEW post_comments AS (

</details>

## Referenced Tables

- [posts](posts.md)
- [comments](comments.md)
- [users](users.md)

## Columns

| Name | Type | Default | Nullable | Children | Parents | Comment |
Expand All @@ -37,6 +31,14 @@ CREATE VIEW post_comments AS (
| created | date | | true | | | comments.created |
| updated | date | | true | | | comments.updated |

## Referenced Tables

| Name | Columns | Comment | Type | Labels |
| ---- | ------- | ------- | ---- | ------ |
| [posts](posts.md) | 6 | | BASIC TABLE | `green` `red` `blue` |
| [comments](comments.md) | 6 | | BASIC TABLE | |
| [users](users.md) | 6 | Users table | BASIC TABLE | |

## Relations

![er](post_comments.svg)
Expand Down
14 changes: 8 additions & 6 deletions sample/mysql/post_comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2

</details>

## Referenced Tables

- [posts](posts.md)
- [comments](comments.md)
- [users](users.md)

## Columns

| Name | Type | Default | Nullable | Children | Parents | Comment |
Expand All @@ -31,6 +25,14 @@ CREATE VIEW post_comments AS (select `c`.`id` AS `id`,`p`.`title` AS `title`,`u2
| created | datetime | | true | | | comments.created |
| updated | datetime | | true | | | comments.updated |

## Referenced Tables

| Name | Columns | Comment | Type | Labels |
| ---- | ------- | ------- | ---- | ------ |
| [posts](posts.md) | 7 | Posts table | BASE TABLE | `green` `red` `blue` |
| [comments](comments.md) | 7 | Comments<br>Multi-line<br>table<br>comment | BASE TABLE | |
| [users](users.md) | 6 | Users table | BASE TABLE | |

## Relations

![er](post_comments.svg)
Expand Down
2 changes: 1 addition & 1 deletion sample/mysql/schema.json

Large diffs are not rendered by default.

Loading

0 comments on commit f4851e2

Please sign in to comment.