11# PROJECT
2+
23> Generated by [ ` prisma-markdown ` ] ( https://github.com/samchon/prisma-markdown )
34
45- [ Articles] ( #articles )
56
67## Articles
8+
79``` mermaid
810erDiagram
911"attachment_files" {
@@ -63,27 +65,30 @@ erDiagram
6365```
6466
6567### ` attachment_files `
68+
6669Attachment File.
6770
6871Every attachment files that are managed in current system.
6972
7073For reference, it is possible to omit one of file name or extension like
7174` .gitignore ` or ` README ` case, but not possible to omit both of them.
7275
73- ** Properties**
74- - ` id ` :
75- - ` name `
76- > File name, except extension.
77- >
78- > If there's file ` .gitignore ` , then its name is an empty string.
79- - ` extension `
80- > Extension.
81- >
82- > Possible to omit like ` README ` case.
83- - ` url ` : URL path of the real file.
84- - ` created_at ` : Creation time of file.
76+ Properties as follows:
77+
78+ - ` id ` :
79+ - ` name `
80+ > File name, except extension.
81+ >
82+ > If there's file ` .gitignore ` , then its name is an empty string.
83+ - ` extension `
84+ > Extension.
85+ >
86+ > Possible to omit like ` README ` case.
87+ - ` url ` : URL path of the real file.
88+ - ` created_at ` : Creation time of file.
8589
8690### ` bbs_articles `
91+
8792Article entity.
8893
8994` bbs_articles ` is a super-type entity of all kinds of articles in the
@@ -105,38 +110,42 @@ the article is designed in this structure.
105110
106111In other words, to keep evidence, and prevent fraud.
107112
108- ** Properties**
109- - ` id ` :
110- - ` created_at ` : Creation time of article.
111- - ` deleted_at `
112- > Deletion time of article.
113- >
114- > To keep evidence, do not delete the article, but just mark it as
115- > deleted.
113+ Properties as follows:
114+
115+ - ` id ` :
116+ - ` created_at ` : Creation time of article.
117+ - ` deleted_at `
118+ > Deletion time of article.
119+ >
120+ > To keep evidence, do not delete the article, but just mark it as
121+ > deleted.
116122
117123### ` bbs_article_snapshots `
124+
118125Snapshot of article.
119126
120127` bbs_article_snapshots ` is a snapshot entity that contains the contents of
121128the article, as mentioned in [ bbs_articles] ( #bbs_articles ) , the contents of the
122129article are separated from the article record to keep evidence and prevent
123130fraud.
124131
125- ** Properties**
126- - ` id ` :
127- - ` bbs_article_id ` : Belong article's [ bbs_articles.id] ( #bbs_articles )
128- - ` format `
129- > Format of body.
130- >
131- > Same meaning with extension like ` html ` , ` md ` , ` txt ` .
132- - ` title ` : Title of article.
133- - ` body ` : Content body of article.
134- - ` created_at `
135- > Creation time of record.
136- >
137- > It means creation time or update time or article.
132+ Properties as follows:
133+
134+ - ` id ` :
135+ - ` bbs_article_id ` : Belong article's [ bbs_articles.id] ( #bbs_articles )
136+ - ` format `
137+ > Format of body.
138+ >
139+ > Same meaning with extension like ` html ` , ` md ` , ` txt ` .
140+ - ` title ` : Title of article.
141+ - ` body ` : Content body of article.
142+ - ` created_at `
143+ > Creation time of record.
144+ >
145+ > It means creation time or update time or article.
138146
139147### ` bbs_article_snapshot_files `
148+
140149Attachment file of article snapshot.
141150
142151` bbs_article_snapshot_files ` is an entity that shapes the attached files of
@@ -148,13 +157,15 @@ resolve the M: N relationship between [bbs_article_snapshots](#bbs_article_snaps
148157files, it has an additional ` sequence ` attribute, which we will continue to
149158see in this documents.
150159
151- ** Properties**
152- - ` id ` :
153- - ` bbs_article_snapshot_id ` : Belonged snapshot's [ bbs_article_snapshots.id] ( #bbs_article_snapshots )
154- - ` attachment_file_id ` : Belonged file's [ attachment_files.id] ( #attachment_files )
155- - ` sequence ` : Sequence of attachment file in the snapshot.
160+ Properties as follows:
161+
162+ - ` id ` :
163+ - ` bbs_article_snapshot_id ` : Belonged snapshot's [ bbs_article_snapshots.id] ( #bbs_article_snapshots )
164+ - ` attachment_file_id ` : Belonged file's [ attachment_files.id] ( #attachment_files )
165+ - ` sequence ` : Sequence of attachment file in the snapshot.
156166
157167### ` bbs_article_comments `
168+
158169Comment written on an article.
159170
160171` bbs_article_comments ` is an entity that shapes the comments written on an
@@ -169,21 +180,23 @@ the comment is modified.
169180Also, ` bbs_article_comments ` is expressing the relationship of the
170181hierarchical reply structure through the ` parent_id ` attribute.
171182
172- ** Properties**
173- - ` id ` :
174- - ` bbs_article_id ` : Belonged article's [ bbs_articles.id] ( #bbs_articles )
175- - ` parent_id `
176- > Parent comment's [ bbs_article_comments.id] ( #bbs_article_comments )
177- >
178- > Used to express the hierarchical reply structure.
179- - ` created_at ` : Creation time of comment.
180- - ` deleted_at `
181- > Deletion time of comment.
182- >
183- > Do not allow to delete the comment, but just mark it as deleted,
184- > to keep evidence.
183+ Properties as follows:
184+
185+ - ` id ` :
186+ - ` bbs_article_id ` : Belonged article's [ bbs_articles.id] ( #bbs_articles )
187+ - ` parent_id `
188+ > Parent comment's [ bbs_article_comments.id] ( #bbs_article_comments )
189+ >
190+ > Used to express the hierarchical reply structure.
191+ - ` created_at ` : Creation time of comment.
192+ - ` deleted_at `
193+ > Deletion time of comment.
194+ >
195+ > Do not allow to delete the comment, but just mark it as deleted,
196+ > to keep evidence.
185197
186198### ` bbs_article_comment_snapshots `
199+
187200Snapshot of comment.
188201
189202` bbs_article_comment_snapshots ` is a snapshot entity that contains the
@@ -192,31 +205,34 @@ contents of the comment.
192205As mentioned in [ bbs_article_comments] ( #bbs_article_comments ) , designed to keep evidence
193206and prevent fraud.
194207
195- ** Properties**
196- - ` id ` :
197- - ` bbs_article_comment_id ` : Belonged article's [ bbs_article_comments.id] ( #bbs_article_comments )
198- - ` format `
199- > Format of content body.
200- >
201- > Same meaning with extension like ` html ` , ` md ` , ` txt ` .
202- - ` body ` : Content body of comment.
203- - ` created_at `
204- > Creation time of record.
205- >
206- > It means creation time or update time or comment.
208+ Properties as follows:
209+
210+ - ` id ` :
211+ - ` bbs_article_comment_id ` : Belonged article's [ bbs_article_comments.id] ( #bbs_article_comments )
212+ - ` format `
213+ > Format of content body.
214+ >
215+ > Same meaning with extension like ` html ` , ` md ` , ` txt ` .
216+ - ` body ` : Content body of comment.
217+ - ` created_at `
218+ > Creation time of record.
219+ >
220+ > It means creation time or update time or comment.
207221
208222### ` bbs_article_comment_snapshot_files `
223+
209224Attachment file of comment snapshot.
210225
211226` bbs_article_comment_snapshot_files ` is an entity resolving the M: N
212227relationship between [ bbs_article_comment_snapshots] ( #bbs_article_comment_snapshots ) and
213228[ attachment_files] ( #attachment_files ) tables.
214229
215- ** Properties**
216- - ` id ` :
217- - ` bbs_article_comment_snapshot_id ` : Belonged snapshot's [ bbs_article_comment_snapshots.id] ( #bbs_article_comment_snapshots )
218- - ` attachment_file_id ` : Belonged file's [ attachment_files.id] ( #attachment_files )
219- - ` sequence `
220- > Sequence order.
221- >
222- > Sequence order of the attached file in the belonged snapshot.
230+ Properties as follows:
231+
232+ - ` id ` :
233+ - ` bbs_article_comment_snapshot_id ` : Belonged snapshot's [ bbs_article_comment_snapshots.id] ( #bbs_article_comment_snapshots )
234+ - ` attachment_file_id ` : Belonged file's [ attachment_files.id] ( #attachment_files )
235+ - ` sequence `
236+ > Sequence order.
237+ >
238+ > Sequence order of the attached file in the belonged snapshot.
0 commit comments