Sequelize

Install dependencies

npm install sequelize sqlite3
# or
yarn add sequelize sqlite3

Getting Started

Define models

import { Sequelize, DataTypes } from 'sequelize';

const sequelize = new Sequelize('sqlite::memory:');
const User = sequelize.define('User', {
  username: DataTypes.STRING,
  birthday: DataTypes.DATE,
});

Defining Models

Persist and query

const jane = await User.create({
  username: 'janedoe',
  birthday: new Date(1980, 6, 20),
});

const users = await User.findAll();

Querying Models

Data Modeling

Define your models with ease and make optional use of automatic database synchronization.

const Wishlist = sequelize.define("Wishlist", {
  title: DataTypes.STRING,
});
const Wish = sequelize.define("Wish", {
  title: DataTypes.STRING,
  quantity: DataTypes.NUMBER,
});

// Automatically create all tables
await sequelize.sync();

Associations

Define associations between models and let Sequelize handle the heavy lifting.

Wish.belongsTo(Wishlist);
Wishlist.hasMany(Wish);

const wishlist = await Wishlist.findOne();
const wishes = await wishlist.getWishes();
const wish = await wishlist.createWish({ 
  title: 'Toys', quantity: 3,
});

await wishlist.removeWish(wish);

Soft deletion

Mark data as deleted instead of removing it once and for all from the database.

const User = sequelize.define("User", 
  { username: DataTypes.STRING },
  { paranoid: true },
});

const user = await User.findOne();

await user.destroy();
await User.findAll(); // non-deleted only
await User.findAll({ paranoid: false }); // all

Ready to get started with Sequelize?

Transactions, migrations, strong typing, JSON querying, lifecycle events (hooks), and more.
Learn more about the many features Sequelize has to offer!

Getting Started