mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
d10d0f544f
A release-readiness QA pass over the whole product. The commits split into defects a user would hit and gates that were reporting green while measuring nothing. ## Fixes that change behaviour Rate limiting was bypassable on every install: TRUST_PROXY defaulted to true, so request.ip came from a client-set header and a forged X-Forwarded-For got past the login limiter. The default is now a private-network trust list. A transient Postgres outage stranded in-flight jobs, leaving finished output on disk with no row pointing at it. A reconciler now resolves those rows and adopts the bytes rather than dropping the work. A Redis connection that moved to a new address wedged every read-blocked consumer, so completions stopped signalling while health still answered 200. Socket timeouts plus subscriber pings recover it. Installing more than one AI bundle left the shared venv multi-versioned and silently broke three tools. The installer now reconciles distributions to one version each. Converting an image to JXL at quality 1 through 4 returned a 500, because libjxl 0.7 rejects the distance those values compute. The quality is floored at what the encoder honours. A missing ffmpeg was also reported to the user as a corrupt upload; it now says the engine is unavailable. RAW uploads reached an unpatched LibRaw on arm64, so it is built from source at 0.22.2, and the release scan was split so it can fail on an unfixed critical instead of hiding it behind ignore-unfixed. ## Gates that could not fail Two mutation lanes ran zero mutants because Stryker crawled the gitignored docs build; coverage discarded its whole report on any failing test; the lint gate skipped root tests, scripts, and two workspaces; and several generated matrices counted a host missing ffmpeg as a passing tool. Each now measures what it claims. Full evidence and the outstanding release items are tracked locally and are not part of this branch.
206 lines
14 KiB
Markdown
206 lines
14 KiB
Markdown
---
|
|
description: "สคีมาฐานข้อมูล PostgreSQL ตาราง การย้ายข้อมูล และขั้นตอนการสำรองข้อมูลสำหรับ SnapOtter"
|
|
i18n_source_hash: a68264552836
|
|
i18n_provenance: machine
|
|
i18n_output_hash: ec41785970af
|
|
i18n_hash_version: 2
|
|
---
|
|
|
|
# ฐานข้อมูล {#database}
|
|
|
|
SnapOtter ใช้ PostgreSQL 17 กับ [Drizzle ORM](https://orm.drizzle.team/) (pg-core / node-postgres) สำหรับการจัดเก็บข้อมูลอย่างถาวร สคีมาถูกกำหนดไว้ใน `apps/api/src/db/schema.ts`
|
|
|
|
การเชื่อมต่อถูกกำหนดค่าผ่านตัวแปรสภาพแวดล้อม `DATABASE_URL` (ค่าเริ่มต้น `postgres://snapotter:snapotter@postgres:5432/snapotter`) ใน Docker Compose คอนเทนเนอร์ Postgres จะเก็บข้อมูลไว้ใน named volume `SnapOtter-pgdata`
|
|
|
|
## ตาราง {#tables}
|
|
|
|
### users {#users}
|
|
|
|
เก็บบัญชีผู้ใช้ สร้างขึ้นโดยอัตโนมัติเมื่อรันครั้งแรกจาก `DEFAULT_USERNAME` และ `DEFAULT_PASSWORD`
|
|
|
|
| คอลัมน์ | ชนิด | หมายเหตุ |
|
|
|---|---|---|
|
|
| `id` | uuid | คีย์หลัก |
|
|
| `username` | varchar | ไม่ซ้ำ จำเป็น |
|
|
| `passwordHash` | varchar | scrypt hash |
|
|
| `role` | varchar | `admin`, `editor` หรือ `user` |
|
|
| `mustChangePassword` | boolean | ธงบังคับรีเซ็ตรหัสผ่าน |
|
|
| `createdAt` | timestamp | เวลาที่สร้าง |
|
|
| `updatedAt` | timestamp | เวลาที่อัปเดตล่าสุด |
|
|
|
|
### sessions {#sessions}
|
|
|
|
เซสชันการเข้าสู่ระบบที่ใช้งานอยู่ แต่ละแถวผูกโทเคนเซสชันกับผู้ใช้
|
|
|
|
| คอลัมน์ | ชนิด | หมายเหตุ |
|
|
|---|---|---|
|
|
| `id` | varchar | คีย์หลัก (โทเคนเซสชัน) |
|
|
| `userId` | uuid | คีย์นอกไปยัง `users.id` |
|
|
| `expiresAt` | timestamp | เวลาหมดอายุ |
|
|
| `createdAt` | timestamp | เวลาที่สร้าง |
|
|
|
|
### teams {#teams}
|
|
|
|
กลุ่มสำหรับจัดระเบียบผู้ใช้ ผู้ดูแลสามารถกำหนดผู้ใช้ให้กับทีมได้
|
|
|
|
| คอลัมน์ | ชนิด | คำอธิบาย |
|
|
|--------|------|-------------|
|
|
| `id` | uuid | คีย์หลัก |
|
|
| `name` | varchar (ไม่ซ้ำ สูงสุด 50 อักขระ) | ชื่อทีม |
|
|
| `createdAt` | timestamp | เวลาที่สร้าง |
|
|
|
|
### api_keys {#api-keys}
|
|
|
|
คีย์ API สำหรับการเข้าถึงแบบโปรแกรม คีย์ดิบจะแสดงเพียงครั้งเดียวตอนสร้าง เก็บเฉพาะ hash เท่านั้น
|
|
|
|
| คอลัมน์ | ชนิด | หมายเหตุ |
|
|
|---|---|---|
|
|
| `id` | uuid | คีย์หลัก |
|
|
| `userId` | uuid | คีย์นอกไปยัง `users.id` |
|
|
| `keyHash` | varchar | scrypt hash ของคีย์ |
|
|
| `name` | varchar | ป้ายชื่อที่ผู้ใช้กำหนด |
|
|
| `createdAt` | timestamp | เวลาที่สร้าง |
|
|
| `lastUsedAt` | timestamp | อัปเดตทุกครั้งที่มีการร้องขอที่ผ่านการยืนยันตัวตน |
|
|
|
|
คีย์จะขึ้นต้นด้วย `si_` ตามด้วยอักขระเลขฐานสิบหก 96 ตัว (สุ่ม 48 ไบต์)
|
|
|
|
### pipelines {#pipelines}
|
|
|
|
ชุดเครื่องมือที่บันทึกไว้ซึ่งผู้ใช้สร้างขึ้นใน UI
|
|
|
|
| คอลัมน์ | ชนิด | หมายเหตุ |
|
|
|---|---|---|
|
|
| `id` | uuid | คีย์หลัก |
|
|
| `name` | varchar | ชื่อ pipeline |
|
|
| `description` | varchar | คำอธิบายที่ไม่บังคับ |
|
|
| `steps` | jsonb | อาร์เรย์ของอ็อบเจกต์ `{ toolId, settings }` |
|
|
| `createdAt` | timestamp | เวลาที่สร้าง |
|
|
|
|
### user_files {#user-files}
|
|
|
|
คลังไฟล์ถาวร โดยค่าเริ่มต้น การแก้ไขที่บันทึกไว้จะถูกแทรกเป็นแถวรากอิสระ ("บันทึกเป็นไฟล์ใหม่": `version` 1, `parentId` เป็น null ดังนั้นไฟล์ต้นฉบับยังคงอยู่ในรายการ) หรือเป็นเวอร์ชันที่เชื่อมโยงกับแถวแม่เมื่อคุณเขียนทับไฟล์ต้นฉบับ (กำหนด `parentId`, เพิ่มค่า `version` และแทนที่ไฟล์เดิม) คอลัมน์ `toolChain` บันทึกเครื่องมือที่นำมาใช้
|
|
|
|
| คอลัมน์ | ชนิด | คำอธิบาย |
|
|
|--------|------|-------------|
|
|
| `id` | uuid | คีย์หลัก |
|
|
| `userId` | uuid | FK ไปยัง users (CASCADE DELETE) |
|
|
| `originalName` | varchar | ชื่อไฟล์อัปโหลดต้นฉบับ |
|
|
| `storedName` | varchar | ชื่อไฟล์บนดิสก์ |
|
|
| `mimeType` | varchar | ชนิด MIME |
|
|
| `size` | integer | ขนาดไฟล์เป็นไบต์ |
|
|
| `width` | integer | ความกว้างของภาพเป็นพิกเซล |
|
|
| `height` | integer | ความสูงของภาพเป็นพิกเซล |
|
|
| `version` | integer | หมายเลขเวอร์ชัน (1 = ต้นฉบับ) |
|
|
| `parentId` | uuid หรือ null | FK ไปยัง user_files (เวอร์ชันแม่) |
|
|
| `toolChain` | jsonb | รหัสเครื่องมือที่นำมาใช้ตามลำดับเพื่อสร้างเวอร์ชันนี้ |
|
|
| `createdAt` | timestamp | เวลาที่สร้าง |
|
|
|
|
### jobs {#jobs}
|
|
|
|
ติดตามงานประมวลผลสำหรับการรายงานความคืบหน้าและการล้างข้อมูล
|
|
|
|
| คอลัมน์ | ชนิด | หมายเหตุ |
|
|
|---|---|---|
|
|
| `id` | uuid | คีย์หลัก |
|
|
| `type` | varchar | ตัวระบุเครื่องมือหรือ pipeline |
|
|
| `status` | varchar | `queued`, `processing`, `completed` หรือ `failed` |
|
|
| `progress` | real | เศษส่วน 0.0-1.0 |
|
|
| `inputFiles` | jsonb | อาร์เรย์ของพาธไฟล์อินพุต |
|
|
| `outputPath` | varchar | พาธไปยังไฟล์ผลลัพธ์ |
|
|
| `settings` | jsonb | การตั้งค่าเครื่องมือที่ใช้ |
|
|
| `error` | varchar | ข้อความข้อผิดพลาดหากล้มเหลว |
|
|
| `createdAt` | timestamp | เวลาที่สร้าง |
|
|
| `completedAt` | timestamp | เวลาที่เสร็จสิ้น |
|
|
|
|
### settings {#settings}
|
|
|
|
ที่เก็บแบบคีย์-ค่าสำหรับการตั้งค่าทั้งเซิร์ฟเวอร์ที่ผู้ดูแลสามารถเปลี่ยนได้จาก UI
|
|
|
|
| คอลัมน์ | ชนิด | หมายเหตุ |
|
|
|---|---|---|
|
|
| `key` | varchar | คีย์หลัก |
|
|
| `value` | varchar | ค่าการตั้งค่า |
|
|
| `updatedAt` | timestamp | เวลาที่อัปเดตล่าสุด |
|
|
|
|
### roles {#roles}
|
|
|
|
บทบาทกำหนดเองพร้อมสิทธิ์แบบละเอียด
|
|
|
|
| คอลัมน์ | ชนิด | หมายเหตุ |
|
|
|---|---|---|
|
|
| `id` | uuid | คีย์หลัก |
|
|
| `name` | varchar | ชื่อบทบาทที่ไม่ซ้ำ |
|
|
| `description` | varchar | คำอธิบายที่ไม่บังคับ |
|
|
| `permissions` | jsonb | อาร์เรย์ของสตริงสิทธิ์ |
|
|
| `createdAt` | timestamp | เวลาที่สร้าง |
|
|
|
|
### audit_log {#audit-log}
|
|
|
|
บันทึกการกระทำที่เกี่ยวข้องกับความปลอดภัย
|
|
|
|
| คอลัมน์ | ชนิด | หมายเหตุ |
|
|
|---|---|---|
|
|
| `id` | uuid | คีย์หลัก |
|
|
| `userId` | uuid | FK ไปยัง users |
|
|
| `action` | varchar | ชนิดการกระทำ |
|
|
| `details` | jsonb | ข้อมูลเฉพาะการกระทำ |
|
|
| `createdAt` | timestamp | เวลาที่กระทำ |
|
|
|
|
### user_preferences {#user-preferences}
|
|
|
|
สถานะ UI ของผู้ใช้แต่ละคน โดยใช้ชื่อการตั้งค่าเป็นคีย์ เก็บเครื่องมือที่ปักหมุดบนหน้าหลัก ซึ่งเขียนผ่าน `PUT /api/v1/preferences`
|
|
|
|
| คอลัมน์ | ชนิด | หมายเหตุ |
|
|
|---|---|---|
|
|
| `userId` | text | FK ไปยัง users ลบแบบต่อเนื่อง เป็นคีย์หลักร่วมกับ `key` |
|
|
| `key` | text | ชื่อการตั้งค่า เป็นคีย์หลักร่วมกับ `userId` |
|
|
| `value` | jsonb | ข้อมูลของการตั้งค่า |
|
|
| `updatedAt` | timestamp | เวลาที่เขียนล่าสุด |
|
|
|
|
## การย้ายข้อมูล (Migrations) {#migrations}
|
|
|
|
Drizzle จัดการการย้ายสคีมา ไฟล์การย้ายข้อมูลอยู่ใน `apps/api/drizzle/` ระหว่างการพัฒนา:
|
|
|
|
```bash
|
|
cd apps/api
|
|
npx drizzle-kit generate # generate a migration from schema changes
|
|
npx drizzle-kit migrate # apply pending migrations
|
|
```
|
|
|
|
ในโปรดักชัน การย้ายข้อมูลที่ค้างอยู่จะถูกนำมาใช้โดยอัตโนมัติเมื่อเริ่มต้น
|
|
|
|
## สำรองและกู้คืน {#backup-and-restore}
|
|
|
|
ฐานข้อมูลเชิงสัมพันธ์อยู่ในโวลุ่ม `SnapOtter-pgdata` ของคอนเทนเนอร์ Postgres ไม่ใช่โวลุ่ม `/data` ของแอป
|
|
|
|
**การสำรองข้อมูลแบบลอจิคัลพร้อมการตรวจสอบความถูกต้อง (แนะนำ)**
|
|
|
|
```bash
|
|
# Dump into PostgreSQL's portable custom archive format
|
|
docker exec SnapOtter-postgres \
|
|
pg_dump --format=custom --no-owner -U snapotter snapotter > snapotter.dump
|
|
test -s snapotter.dump
|
|
docker exec -i SnapOtter-postgres pg_restore --list < snapotter.dump >/dev/null
|
|
|
|
# Restore into a fresh/disposable target first and fail on the first SQL error
|
|
docker exec -i SnapOtter-postgres \
|
|
pg_restore --exit-on-error --clean --if-exists --no-owner \
|
|
-U snapotter -d snapotter < snapotter.dump
|
|
```
|
|
|
|
ดัมพ์ฐานข้อมูลนี้ไม่มีอ็อบเจ็กต์ไลบรารีที่บันทึกไว้ใน `/data/files` หรือสถานะ BullMQ แบบทนทานใน Redis สำรองและกู้คืนข้อมูลเหล่านั้นด้วยขั้นตอนการประสานงานใน [Security & Hardening](/th/guide/security#backup-and-recovery)
|
|
|
|
**สแนปชอตวอลุ่มเย็น**
|
|
|
|
```bash
|
|
# Stop every service first, then use your storage platform to snapshot the
|
|
# PostgreSQL, app-data, and Redis volumes as one crash-consistent set.
|
|
docker compose -f docker/docker-compose.yml stop
|
|
```
|
|
|
|
อย่าคัดลอกไดเร็กทอรีข้อมูล PostgreSQL แบบสดด้วย `tar` เขียนคำนำหน้าชื่อวอลุ่มตามโปรเจ็กต์ ดังนั้นแก้ไข ID วอลุ่มที่ติดตั้งจาก `docker inspect` หรือแพลตฟอร์มพื้นที่จัดเก็บข้อมูลของคุณ แทนที่จะใช้ป้ายกำกับตัวอักษร `SnapOtter-pgdata`
|
|
|
|
### การย้ายข้อมูลจาก 1.x (SQLite) {#migrating-from-1-x-sqlite}
|
|
|
|
การอัปเกรดจาก SnapOtter 1.x มีคู่มือของตัวเอง ดู [การอัปเกรดจาก 1.x ไปยัง 2.0](./upgrading) สรุปสั้นๆ ให้ใช้ volume `/data` ที่มีอยู่เดิมซ้ำ และ 2.0 จะตรวจจับและนำเข้า `/data/snapotter.db` โดยอัตโนมัติเมื่อบูตครั้งแรก (หรือกำหนด `SQLITE_MIGRATE_PATH` เพื่อชี้ไปยังไฟล์นั้นอย่างชัดเจน) สำรอง volume `/data` ทั้งหมดก่อน ไม่ใช่แค่ `snapotter.db`: 1.x ใช้โหมด SQLite WAL ดังนั้นคอนเทนเนอร์ที่หยุดทำงานมักจะทิ้งข้อมูลส่วนใหญ่ไว้ใน `snapotter.db-wal` ข้างๆ `snapotter.db` ที่แทบจะว่างเปล่า
|