แปลง JSON เป็น Sequelize (JavaScript) แผน!

ป้อน JSON และแปลงเป็น Sequelize (JavaScript) แผน! รองรับ Sequelize sequelize.define, DataTypes, Node.js, Express
JSON
ผลลัพธ์
 

แปลง JSON เป็น Sequelize (JavaScript) แผน!

แปลงแถว JSON เป็นโมเดล Sequelize ที่นิยามด้วย sequelize.define() ทุกคอลัมน์ได้ไทป์ DataTypes และแฟล็ก allowNull และไฟล์ CommonJS มี primary key id, tableName และ timestamps: false ให้ครบ

เหมาะกับเซิร์ฟเวอร์ Express บน MySQL หรือ PostgreSQL ที่มีแถวตัวอย่างของตารางอยู่แล้ว (สเปรดชีตที่ export เป็น JSON หรือ response ของ API ภายนอก) แต่ยังไม่มีนิยามโมเดล

วิธีใช้

  1. วางหนึ่งแถวเป็นออบเจ็กต์หรือหลายแถวเป็นอาร์เรย์ ถ้าบางคอลัมน์ว่างในบางแถว ให้วางหลายแถวเพื่อให้ allowNull ออกมาถูกต้อง
  2. ใส่ ชื่อโมเดล (ค่าเริ่มต้น MyModel) ชื่อนี้ใช้ทั้งใน define และเป็นตัวแปรที่ export
  3. ผลลัพธ์สมมติว่า require('../db') คืน instance ของ Sequelize ให้ปรับ path นั้นให้ตรงกับโมดูลเชื่อมต่อของคุณ แล้วบันทึกไฟล์ไว้ใต้ models/

ตัวอย่าง

อินพุต (JSON)
[
  { "email": "kim@example.com", "nickname": "kim", "age": 31, "marketing_opt_in": true, "joined_at": "2023-11-02" },
  { "email": "ana@example.com", "nickname": "ana", "age": null, "marketing_opt_in": false, "joined_at": "2024-01-15" }
]
เอาต์พุต (Sequelize (JavaScript))
const { Sequelize, DataTypes } = require('sequelize');
const sequelize = require('../db');

const Member = sequelize.define('Member', {
  id: {
    type: DataTypes.INTEGER,
    autoIncrement: true,
    primaryKey: true
  },
  email: {
    type: DataTypes.STRING,
    allowNull: false
  },
  nickname: {
    type: DataTypes.STRING,
    allowNull: false
  },
  age: {
    type: DataTypes.INTEGER,
    allowNull: true
  },
  marketingOptIn: {
    type: DataTypes.BOOLEAN,
    allowNull: false,
    field: 'marketing_opt_in'
  },
  joinedAt: {
    type: DataTypes.DATEONLY,
    allowNull: false,
    field: 'joined_at'
  }
}, {
  tableName: 'MEMBER',
  timestamps: false
});

module.exports = Member;

age ของสมาชิกคนที่สองเป็น null จึงมีแค่ age ที่ได้ allowNull: true joined_at เก็บวันที่ที่ไม่มีเวลา จึงกลายเป็น DataTypes.DATEONLY และ attribute joinedAt ถูกผูกกลับไปยังคอลัมน์จริงด้วย field: 'joined_at'

ฟีเจอร์ที่รองรับ

  • ไทป์คอลัมน์: จำนวนเต็ม → INTEGER (BIGINT เมื่อเกิน 2,147,483,647), ทศนิยม → DOUBLE, บูลีน → BOOLEAN, YYYY-MM-DD → DATEONLY, วันเวลา → DATE, ออบเจ็กต์และอาร์เรย์ → JSON, สตริงอื่น → STRING
  • เฉพาะตัวเลข JSON จริงเท่านั้นที่เป็นคอลัมน์ตัวเลข "01234" ที่อยู่ในเครื่องหมายคำพูดยังเป็น STRING
  • attribute เป็น camelCase และเมื่อใดที่ต่างจากคีย์ field: 'marketing_opt_in' จะจับคู่ attribute กับชื่อคอลัมน์เดิม
  • คีย์ id ใน JSON กลายเป็น primary key แทนที่จะเป็นคอลัมน์ซ้ำ: จำนวนเต็มได้ autoIncrement สตริงอย่าง UUID เป็นคีย์ STRING ธรรมดา ถ้าไม่มีจะเพิ่ม id แบบ INTEGER auto-increment ให้
  • ค่า null หรือค่าที่ขาดในแถวใดก็ตามจะตั้ง allowNull: true โดยไม่มีผลต่อไทป์ของคอลัมน์
  • โมเดลชื่อ UserProfile ได้ tableName: 'USER_PROFILE' และ timestamps: false จึงไม่คาดหวังคอลัมน์ createdAt/updatedAt

กรณีการใช้งาน

ผูกโมเดลเข้ากับตารางที่มีอยู่แล้ว

export ผลของ SELECT ... LIMIT 5 จาก DB client เป็น JSON แล้ววาง จะได้โค้ด define ที่สะท้อนลำดับคอลัมน์ การเป็น null และชื่อคอลัมน์แบบ snake_case ไว้แล้ว สะดวกสำหรับจับคู่ตารางเดียวโดยไม่ต้องติดตั้ง sequelize-auto

สร้างตารางทดสอบด้วย `sequelize.sync()`

ระหว่างทำ prototype ให้สร้างโมเดลจาก JSON ตัวอย่าง รัน sync() เพื่อสร้างตารางใน SQLite หรือ MySQL บนเครื่อง แล้วโหลด seed data ด้วย bulkCreate

ข้อควรระวังและข้อจำกัด

  • DataTypes.STRING มีค่าเริ่มต้นเป็น VARCHAR(255) ข้อความยาวให้เปลี่ยนเป็น DataTypes.TEXT
  • ค่า DATEONLY กลับมาเป็นสตริง '2023-11-02' ไม่ใช่ออบเจ็กต์ Date
  • DataTypes.JSON ใช้ได้บน MySQL, MariaDB, PostgreSQL และ SQLite แต่ไม่รองรับ MSSQL บน PostgreSQL ส่วนใหญ่ DataTypes.JSONB เป็นทางเลือกที่ดีกว่า
  • tableName เป็นตัวพิมพ์ใหญ่ (MEMBER) ในระบบที่แยกตัวพิมพ์อย่าง PostgreSQL หรือ MySQL บน Linux ต้องตรงกับชื่อตารางจริงทุกตัวอักษร
  • สำหรับจำนวนเงิน ให้เปลี่ยน DOUBLE เป็น DataTypes.DECIMAL(12, 2) เพื่อเลี่ยงการปัดเศษของ floating-point

คำถามที่พบบ่อย

ขอเป็นสไตล์ Model.init() แบบคลาสได้ไหม?

หน้านี้สร้างแค่ sequelize.define() ออบเจ็กต์ attribute เหมือนกันทั้งสองสไตล์ ให้ประกาศ class Member extends Model {} แล้วส่งออบเจ็กต์เดียวกันให้ Member.init(attributes, { sequelize, tableName: 'MEMBER' }) สำหรับ TypeScript ให้ใช้หน้า JSON → Sequelize (TS)

คอลัมน์เป็น allowNull: false แต่สตริงว่างยังเข้ามาได้

allowNull กันแค่ SQL NULL ถ้าจะปฏิเสธสตริงว่างด้วย ให้เพิ่ม validate: { notEmpty: true } ที่ attribute

ทำไมใส่ field ทุก attribute แทนที่จะใช้ underscored: true?

underscored แปลงได้แค่ camelCase เป็น snake_case จึงจับคู่คีย์อย่าง home-url หรือคอลัมน์ที่เป็น camelCase อยู่แล้วไม่ได้ field ที่ระบุชัดเจนเก็บคีย์ JSON ตรงตัวเป็นชื่อคอลัมน์ไม่ว่าจะเป็นสไตล์ใด