Skip to content

Commit d490eec

Browse files
committed
feat: 更新 README
1 parent 09a51bb commit d490eec

File tree

1 file changed

+0
-27
lines changed

1 file changed

+0
-27
lines changed

README.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -28,29 +28,6 @@
2828
$ npm i
2929
```
3030

31-
### 新增一組遷移
32-
在終端機輸入以下指令來新增一組遷移,your_file_name請替換成任何你要的檔案名稱,檔案名稱之間不可有空白
33-
```
34-
$ npm run create your_file_name
35-
```
36-
執行後程式將自動產生一組遷移在migrations資料夾下,一組遷移將包含3個檔案,檔案皆以日期時間加上剛剛輸入的文字命名:
37-
38-
範例如下:
39-
```
40-
2024092600000-your_file_name-up.sql
41-
2024092600000-your_file_name-down.sql
42-
2024092600000-your_file_name.js
43-
```
44-
* 2024092600000-your_file_name-up.sql:執行遷移時會被執行的sql檔案
45-
46-
* 2024092600000-your_file_name-down.sql:執行遷移失敗時,才會被執行的sql檔案,一般作為還原up檔執行到一半的sql用,不需要可空白
47-
48-
* 2024092600000-your_file_name.js:執行此組遷移的程式檔案,請勿修改
49-
50-
那些遷移檔案內容的小技巧:
51-
* 每組遷移盡量保持單一職責,例如需要新增表並寫入資料,建議拆分成兩組遷移,一組新增表,一組寫入資料
52-
* 不修改已經執行過的遷移,如有需要,應該新增新的遷移來修改
53-
5431
### 首次在本機開啟資料庫並執行遷移
5532

5633
> 請確保Docker Desktop已經正常啟動,並能夠看到容器頁面(Containers)
@@ -64,10 +41,6 @@ $ npm run start
6441
* db_migrate-1:執行遷移檔案的容器,執行後會自動關閉(狀態(STATUS)為Exited)。請務必進入檢查查看遷移的執行結果,確保遷移執行成功。
6542
* postgres-1:資料庫容器,狀態應為Running
6643

67-
啟動時,程式將自動產生pgdata資料夾,用以保存資料庫的資料,如將其刪除,將清空所有資料。
68-
69-
程式執行遷移時,將依照遷移檔案的日期,由遠至近執行,且每組遷移只會執行一次,先前執行成功過的遷移不會被再次執行。
70-
7144
### 重新啟動資料庫
7245
```
7346
$ npm run restart

0 commit comments

Comments
 (0)