visuddhinanda 4 лет назад
Родитель
Сommit
db36afafa9
2 измененных файлов с 53 добавлено и 32 удалено
  1. 19 13
      documents/zh/api/article.md
  2. 34 19
      documents/zh/api/readme.md

+ 19 - 13
documents/zh/api/article.md

@@ -1,29 +1,33 @@
 # article
 
-## article文章
+## article 文章
+
 ```table
 CREATE TABLE article (
-    id           INTEGER PRIMARY KEY,
-    uuid         CHAR (36) ,
-    title        TEXT (50) NOT NULL,
+    id SERIAL PRIMARY KEY,
+    uuid         VARCHAR (36) ,
+    title        VARCHAR (50) NOT NULL,
     subtitle     VARCHAR (32),
     summary      VARCHAR (255),
     content      TEXT,
     owner_id     INTEGER,
-    owner        CHAR (36),
-    setting      TEXT,
+    owner        VARCHAR (36),
+    setting      JSON,
     status       INTEGER   NOT NULL DEFAULT (10),
-    create_at  BIGINT,
-    update_at  BIGINT,
-    delete_at  BIGINT
+	version     INTEGER NOT NULL DEFAULT (1),
+    created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    updated_at  TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    deleted_at  TIMESTAMP
 );
 
 ```
-`uuid` 旧表中的主键 
 
-`setting` json格式。文章设置
+`uuid` 旧表中的主键
+
+`setting` json 格式。文章设置
 
 ## article_list 关联表
+
 ```table
 CREATE TABLE article_list (
     id            INTEGER      PRIMARY KEY AUTOINCREMENT,
@@ -34,13 +38,15 @@ CREATE TABLE article_list (
     title         VARCHAR (64) NOT NULL,
 );
 ```
-article 和 collect的关联表
+
+article 和 collect 的关联表
 
 `level`在目录中的层级 1-8
 
 `title`在目录中的文章标题
 
 ## 文集
+
 ```table
 CREATE TABLE collect (
     id INTEGER PRIMARY KEY,
@@ -58,4 +64,4 @@ CREATE TABLE collect (
 );
 ```
 
-uuid 旧表中的主键 
+uuid 旧表中的主键

+ 34 - 19
documents/zh/api/readme.md

@@ -1,34 +1,38 @@
 # 后端开发文档
+
 ## 开发环境
-- golang
-- PostgreSQL
-- Redis
-- ES
 
-给vscode用的go
+-   golang
+-   PostgreSQL
+-   Redis
+-   ES
+
+给 vscode 用的 go
+
 ```
 sudo apt install yarnpkg golang-go
 ```
-## 文档资源
 
+## 文档资源
 
 ## 依赖
-https://github.com/go-redis/redis
 
+https://github.com/go-redis/redis
 
 ## 目录
-* [版本](channel.md)
-* [课程](course.md)
-* [字典](dict.md)
-* [工作组](group.md)
-* [语料库](palicanon.md)
-* [术语](term.md)
-* [译文](translation.md)
-* [文章文集](article.md)
-* [用户](user.md)
-* [逐词解析](wbw.md)
-* [全文搜索](search.md)
-* [其他工具表](others.md)
+
+-   [版本](channel.md)
+-   [课程](course.md)
+-   [字典](dict.md)
+-   [工作组](group.md)
+-   [语料库](palicanon.md)
+-   [术语](term.md)
+-   [译文](translation.md)
+-   [文章文集](article.md)
+-   [用户](user.md)
+-   [逐词解析](wbw.md)
+-   [全文搜索](search.md)
+-   [其他工具表](others.md)
 
 ```mermaid
 graph LR
@@ -60,3 +64,14 @@ collection_edit --> collection
 article_edit  --> article
 ```
 
+## 数据表设计
+
+数据表应包含如下字段
+
+```
+    id SERIAL PRIMARY KEY,
+    version     INTEGER NOT NULL DEFAULT (1),
+    created_at  TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    updated_at  TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    deleted_at  TIMESTAMP //可选
+```