git init

Author: Tzuhui

.dockerignore

@@ -0,0 +1,9 @@
+*.md
+test/**
+.eslintrc.json
+apidoc.json
+.github*
+.vscode*
+.git
+.cache
+pgdata

.env.example

@@ -0,0 +1,3 @@
+POSTGRES_USER=testHexschool
+POSTGRES_PASSWORD=pgStartkit4test
+POSTGRES_DB=test

.github/workflows/check.yml

@@ -0,0 +1,52 @@
+name: Check
+on:
+  push:
+
+jobs:
+  test-migrate :
+    name: Run Migrate Test
+    runs-on: ubuntu-latest
+    env:
+      DB_USERNAME: root
+      DB_DATABASE: test
+      DB_PASSWORD: test
+      DB_HOST: localhost
+    services:
+      postgres:
+        image: postgres:16.4-alpine3.20
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_USER: ${{ env.DB_USERNAME }}
+          POSTGRES_PASSWORD: ${{ env.DB_PASSWORD }}
+          POSTGRES_DB: ${{ env.DB_DATABASE }}
+    steps:
+    - name: Checkout to Repo Directory
+      uses: actions/checkout@v4
+    - name: Use Node.js 22
+      uses: actions/setup-node@v4
+      with:
+        node-version: '22'
+        cache: 'npm'
+    - name: Restore cache node modules
+      id: cache
+      uses: actions/cache/restore@v4
+      with:
+        path: ./node_modules
+        key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
+    - name: Install dependencies
+      if: steps.cache.outputs.cache-hit != 'true'
+      run: npm ci --production
+    - name: update cache node modules
+      if: steps.cache.outputs.cache-hit != 'true'
+      uses: actions/cache/save@v4
+      with:
+        path: ./node_modules
+        key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
+    - name: test migrate
+      run: npm run init && npm run migrate
+        
+        
+        

.gitignore

@@ -0,0 +1,131 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+pgdata

README.md

@@ -0,0 +1,83 @@
+# db-migrate-startkit
+
+## 事前準備
+
+下載安裝Docker Desktop
+* [Windows版](https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe?utm_source=docker&utm_medium=webreferral&utm_campaign=dd-smartbutton&utm_location=module&_gl=1*1x0tato*_gcl_au*NDk4NzQwNjM1LjE3MjczMzQ0NDY.*_ga*MTkxMzI2NzM5NC4xNjU5OTM4NTcy*_ga_XJWPQMJYHQ*MTcyNzMzMzcxNy4xNTYuMS4xNzI3MzM0NDY4LjM3LjAuMA..)
+* Mac版
+  * [Intel處理器](https://desktop.docker.com/mac/main/amd64/Docker.dmg?utm_source=docker&utm_medium=webreferral&utm_campaign=dd-smartbutton&utm_location=module&_gl=1*sjadaf*_gcl_au*NDk4NzQwNjM1LjE3MjczMzQ0NDY.*_ga*MTkxMzI2NzM5NC4xNjU5OTM4NTcy*_ga_XJWPQMJYHQ*MTcyNzMzMzcxNy4xNTYuMS4xNzI3MzM0NDY4LjM3LjAuMA..)
+  * [M系列處理器](https://desktop.docker.com/mac/main/arm64/Docker.dmg?utm_source=docker&utm_medium=webreferral&utm_campaign=dd-smartbutton&utm_location=module&_gl=1*sjadaf*_gcl_au*NDk4NzQwNjM1LjE3MjczMzQ0NDY.*_ga*MTkxMzI2NzM5NC4xNjU5OTM4NTcy*_ga_XJWPQMJYHQ*MTcyNzMzMzcxNy4xNTYuMS4xNzI3MzM0NDY4LjM3LjAuMA..)
+
+下載並安裝Node.js
+* [下載連結](https://nodejs.org/zh-tw)
+
+下載並安裝Dbeaver Community
+* [Windows版](https://dbeaver.io/files/dbeaver-ce-latest-x86_64-setup.exe)
+* Mac版
+  * [Intel處理器](https://dbeaver.io/files/dbeaver-ce-latest-macos-x86_64.dmg)
+  * [M系列處理器](https://dbeaver.io/files/dbeaver-ce-latest-macos-aarch64.dmg)
+
+## 開始使用
+
+### 安裝套件
+
+>執行前請確保已經安裝了Node.js
+
+打開終端機並輸入以下指令
+```
+$ npm i
+```
+
+### 新增一組遷移
+在終端機輸入以下指令來新增一組遷移，your_file_name請替換成任何你要的檔案名稱，檔案名稱之間不可有空白
+```
+$ npm run create your_file_name
+```
+執行後程式將自動產生一組遷移在migrations資料夾下，一組遷移將包含3個檔案，檔案皆以日期時間加上剛剛輸入的文字命名：
+
+範例如下：
+```
+2024092600000-your_file_name-up.sql
+2024092600000-your_file_name-down.sql
+2024092600000-your_file_name.js
+```
+* 2024092600000-your_file_name-up.sql：執行遷移時會被執行的sql檔案
+
+* 2024092600000-your_file_name-down.sql：執行遷移失敗時，才會被執行的sql檔案，一般作為還原up檔執行到一半的sql用，不需要可空白
+
+* 2024092600000-your_file_name.js：執行此組遷移的程式檔案，請勿修改
+
+那些遷移檔案內容的小技巧：
+* 每組遷移盡量保持單一職責，例如需要新增表並寫入資料，建議拆分成兩組遷移，一組新增表，一組寫入資料
+* 不修改已經執行過的遷移，如有需要，應該新增新的遷移來修改
+
+### 首次在本機開啟資料庫並執行遷移
+
+> 請確保Docker Desktop已經正常啟動，並能夠看到容器頁面(Containers)
+
+打開終端機並輸入以下指令，程式將自動啟動資料庫，並運行遷移
+```
+$ npm run start
+```
+
+啟動後，請檢查Docker Desktop程式界面中裡是否新增db-migrate-startkit的容器堆疊，該堆疊裡了有兩個容器：
+* db_migrate-1：執行遷移檔案的容器，執行後會自動關閉（狀態（STATUS）為Exited）。請務必進入檢查查看遷移的執行結果，確保遷移執行成功。
+* postgres-1：資料庫容器，狀態應為Running
+
+啟動時，程式將自動產生pgdata資料夾，用以保存資料庫的資料，如將其刪除，將清空所有資料。
+
+程式執行遷移時，將依照遷移檔案的日期，由遠至近執行，且每組遷移只會執行一次，先前執行成功過的遷移不會被再次執行。
+
+### 重新啟動資料庫
+```
+$ npm run restart
+```
+### 關閉資料庫
+```
+$ npm run stop
+```
+
+### 關閉資料庫並清除資料
+```
+$ npm run clean
+```

database.json

@@ -0,0 +1,13 @@
+{
+  "defaultEnv": "pg",
+  "sql-file" : true,
+  "pg": {
+    "host": {"ENV": "DB_HOST"},
+    "port": 5432,
+    "user": {"ENV": "DB_USERNAME"},
+    "password" : {"ENV": "DB_PASSWORD"},
+    "database": {"ENV": "DB_DATABASE"},
+    "driver": "pg",
+    "multipleStatements": true
+  }
+}

docker-compose.yml

@@ -0,0 +1,41 @@
+version: "3.8"
+volumes:
+  pgData:
+services:
+  postgres: 
+    image: postgres:16.4-alpine3.20
+    environment:
+      - POSTGRES_USER=${POSTGRES_USER}
+      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
+      - POSTGRES_DB=${POSTGRES_DB}
+    volumes:
+      - pgData:/var/lib/postgresql/data
+    ports:
+      - 5432:5432
+    deploy:
+      replicas: 1
+    networks:
+      - dbnetwork
+    healthcheck:
+      test: ["CMD-SHELL", "sh -c 'pg_isready -U ${POSTGRES_USER} -d ${POSTGRES_DB}'"]
+      interval: 10s
+      timeout: 3s
+      retries: 3
+  db_migrate:
+    build:
+      dockerfile: ./migrate.Dockerfile
+    environment:
+      - DB_HOST=postgres
+      - DB_DATABASE=${POSTGRES_DB}
+      - DB_USERNAME=${POSTGRES_USER}
+      - DB_PASSWORD=${POSTGRES_PASSWORD}
+    depends_on:
+      postgres:
+        condition: service_healthy
+    deploy:
+      replicas: 1
+    networks:
+      - dbnetwork
+networks:
+  dbnetwork:
+    name: db-network

migrate.Dockerfile

@@ -0,0 +1,5 @@
+ FROM node:20-alpine3.19
+ WORKDIR /
+ COPY . /
+ RUN npm ci --production
+ CMD npm run init && npm run migrate