@openai-link/egg-sequelize-ts

Statement

Long Time Non-updated!!!

This repo is just an upgrade for egg-sequelize-ts, as egg-sequelize-ts uses very old sequelize and typescript related packages.

Purpose

Use typescript and sequelize to build models (ORM) in egg.js

Install

1npm i --save @openai-link/egg-sequelize-ts
2# or
3yarn add @openai-link/egg-sequelize-ts

Use

• Enable plugin in config/plugin.ts

1    sequelize: {
2        enable: true,
3        package: '@openai-link/egg-sequelize-ts'
4    }

• Edit your configurations in conif/config.{env}.ts

1config.sequelize = {
2  dialect: "mysql",
3  host: "127.0.0.1",
4  port: 3306,
5  database: "database",
6};

Example

Create a model (table) User

1// app/model/User.ts
2
3/**
4 * @desc User Table
5 */
6import {
7  AutoIncrement,
8  Column,
9  DataType,
10  Model,
11  PrimaryKey,
12  Table,
13} from "sequelize-typescript";
14@Table({
15  modelName: "user",
16})
17export class User extends Model {
18  @PrimaryKey
19  @AutoIncrement
20  @Column({
21    type: DataType.INTEGER(11),
22    comment: "用户ID",
23    comment: "user id",
24  })
25  id: number;
26
27  @Column({
28    comment: "用户姓名",
29  })
30  name: string;
31
32  @Column({
33    comment: "用户邮箱",
34  })
35  email: string;
36
37  @Column({
38    comment: "用户手机号码",
39  })
40  phone: string;
41
42  @Column({
43    field: "created_at",
44  })
45  createdAt: Date;
46
47  @Column({
48    field: "updated_at",
49  })
50  updatedAt: Date;
51}
52export default () => User;

1// app/service/user.js
2import { Service } from "egg";
3import { Sequelize } from "sequelize-typescript";
4
5class UserService extends Service {
6  async index() {
7    const { or } = Sequelize.Op;
8    this.ctx.model.User.create({
9      name: "A",
10      email: "devilyouwei@gmail.com",
11      phone: "7322680284",
12    });
13    const users = await this.ctx.model.User.findOne({
14      where: {
15        [or]: [{ name, phone }, { id }],
16      },
17    });
18    this.ctx.body = users;
19  }
20}