sequelize-cli

What is sequelize-cli?

The sequelize-cli package is a command-line interface for Sequelize, a popular Node.js ORM (Object-Relational Mapper). It provides a set of commands to help manage your database schema, migrations, and seed data, making it easier to work with databases in a Node.js environment.

What are sequelize-cli's main functionalities?

Generating Models

This command generates a new model named 'User' with the specified attributes. It creates a model file and a corresponding migration file.

npx sequelize-cli model:generate --name User --attributes firstName:string,lastName:string,email:string

Running Migrations

This command runs all pending migrations, updating the database schema to match the latest state defined in your migration files.

npx sequelize-cli db:migrate

Creating Seed Data

This command generates a new seed file named 'demo-user'. Seed files are used to populate the database with initial data.

npx sequelize-cli seed:generate --name demo-user

Undoing Migrations

This command undoes the last executed migration, reverting the database schema to its previous state.

npx sequelize-cli db:migrate:undo

Running Seeders

This command runs all seed files, populating the database with the data defined in the seed files.

npx sequelize-cli db:seed:all

Other packages similar to sequelize-cli

knex

Knex.js is a SQL query builder for Node.js that supports multiple database types. It provides a similar migration and seeding functionality as sequelize-cli but does not include an ORM layer. Knex is more focused on query building and database schema management.

typeorm

TypeORM is an ORM for TypeScript and JavaScript (ES7, ES6, ES5). It supports multiple database types and provides a CLI for managing migrations and generating models. TypeORM offers a more feature-rich ORM experience compared to sequelize-cli.

mikro-orm

MikroORM is a TypeScript ORM for Node.js based on the Data Mapper, Unit of Work, and Identity Map patterns. It supports multiple databases and provides a CLI for managing migrations and seeding. MikroORM is designed to be lightweight and fast, with a focus on TypeScript support.

README

sequelize/cli

The Sequelize Command Line Interface (CLI)

Table of Contents

• Installation
• Contributing
• Documentation

Installation

Make sure you have Sequelize installed. Then install the Sequelize CLI to be used in your project with

npm install --save-dev sequelize-cli

And then you should be able to run the CLI with

npx sequelize --help

Usage

Sequelize CLI [Node: 10.21.0, CLI: 6.0.0, ORM: 6.1.0]

sequelize <command>

Commands:
  sequelize db:migrate                        Run pending migrations
  sequelize db:migrate:schema:timestamps:add  Update migration table to have timestamps
  sequelize db:migrate:status                 List the status of all migrations
  sequelize db:migrate:undo                   Reverts a migration
  sequelize db:migrate:undo:all               Revert all migrations ran
  sequelize db:seed                           Run specified seeder
  sequelize db:seed:undo                      Deletes data from the database
  sequelize db:seed:all                       Run every seeder
  sequelize db:seed:undo:all                  Deletes data from the database
  sequelize db:create                         Create database specified by configuration
  sequelize db:drop                           Drop database specified by configuration
  sequelize init                              Initializes project
  sequelize init:config                       Initializes configuration
  sequelize init:migrations                   Initializes migrations
  sequelize init:models                       Initializes models
  sequelize init:seeders                      Initializes seeders
  sequelize migration:generate                Generates a new migration file      [aliases: migration:create]
  sequelize model:generate                    Generates a model and its migration [aliases: model:create]
  sequelize seed:generate                     Generates a new seed file           [aliases: seed:create]

Options:
  --version  Show version number                                                  [boolean]
  --help     Show help                                                            [boolean]

Please specify a command

Contributing

All contributions are accepted as a PR.

• You can file issues by submitting a PR (with test) as a test case.
• Implement new feature by submitting a PR
• Improve documentation by submitting PR to Sequelize

Please read the contributing guidelines.

Documentation

• Migrations Documentation
• CLI Options
• Frequently Asked Questions