You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
78 lines
3.5 KiB
78 lines
3.5 KiB
3 years ago
|
# Sequelize
|
||
|
|
|
||
|
|
[](https://www.npmjs.com/package/sequelize)
|
||
|
|
[](https://travis-ci.org/sequelize/sequelize)
|
||
|
|
[](https://ci.appveyor.com/project/sushantdhiman/sequelize/branch/master)
|
||
|
|
[](https://codecov.io/gh/sequelize/sequelize)
|
||
|
|
[](https://www.bountysource.com/teams/sequelize/issues?utm_source=Sequelize&utm_medium=shield&utm_campaign=bounties_received)
|
||
|
|
[](http://sequelize-slack.herokuapp.com/)
|
||
|
|
[](https://www.npmjs.com/package/sequelize)
|
||
|
|
|
||
|
|
[](https://github.com/sequelize/sequelize/blob/master/LICENSE)
|
||
|
|
[](https://github.com/semantic-release/semantic-release)
|
||
|
|
[](https://greenkeeper.io/)
|
||
|
|
|
||
|
|
Sequelize is a promise-based Node.js ORM for Postgres, MySQL, SQLite and Microsoft SQL Server. It features solid transaction support, relations, read replication and more.
|
||
|
|
|
||
|
|
## Table of Contents
|
||
|
|
- [Installation](#installation)
|
||
|
|
- [Features](#features)
|
||
|
|
- [Responsible disclosure](#responsible-disclosure)
|
||
|
|
- [Documentation](#documentation)
|
||
|
|
- [Resources](#resources)
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ npm install --save sequelize
|
||
|
|
|
||
|
|
# And one of the following:
|
||
|
|
$ npm install --save pg pg-hstore
|
||
|
|
$ npm install --save mysql2
|
||
|
|
$ npm install --save sqlite3
|
||
|
|
$ npm install --save tedious # MSSQL
|
||
|
|
```
|
||
|
|
|
||
|
|
Sequelize follows [SEMVER](http://semver.org). Supports Node v4 and above to use ES6 features.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
- Schema definition
|
||
|
|
- Schema synchronization/dropping
|
||
|
|
- 1:1, 1:M & N:M Associations
|
||
|
|
- Through models
|
||
|
|
- Promises
|
||
|
|
- Hooks/callbacks/lifecycle events
|
||
|
|
- Prefetching/association including
|
||
|
|
- Transactions
|
||
|
|
- Migrations
|
||
|
|
- CLI ([sequelize-cli](https://github.com/sequelize/cli))
|
||
|
|
|
||
|
|
## Responsible disclosure
|
||
|
|
If you have any security issue to report, contact project maintainers privately. You can find contact information [here](https://github.com/sequelize/sequelize/blob/master/CONTACT.md)
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
- [Contributing](https://github.com/sequelize/sequelize/blob/master/CONTRIBUTING.md)
|
||
|
|
- [v4 Documentation](http://docs.sequelizejs.com)
|
||
|
|
- [v3 Documentation](https://sequelize.readthedocs.io/en/v3/)
|
||
|
|
- [v3 to v4 Upgrade Guide](http://docs.sequelizejs.com/manual/tutorial/upgrade-to-v4.html)
|
||
|
|
|
||
|
|
## Resources
|
||
|
|
- [Changelog](https://github.com/sequelize/sequelize/releases)
|
||
|
|
- [Slack](http://sequelize-slack.herokuapp.com/)
|
||
|
|
- [Google Groups](https://groups.google.com/forum/#!forum/sequelize)
|
||
|
|
|
||
|
|
### Tools
|
||
|
|
- [Add-ons & Plugins](https://github.com/sequelize/sequelize/wiki/Add-ons-&-Plugins)
|
||
|
|
- [Sequelize & TypeScript](https://github.com/RobinBuschmann/sequelize-typescript)
|
||
|
|
|
||
|
|
### Learning
|
||
|
|
- [Getting Started](http://docs.sequelizejs.com/manual/installation/getting-started)
|
||
|
|
- [Express Example](https://github.com/sequelize/express-example)
|
||
|
|
|
||
|
|
|
||
|
|
### Translations
|
||
|
|
- [English v4](http://docs.sequelizejs.com) (OFFICIAL)
|
||
|
|
- [中文文档 v4](https://github.com/demopark/sequelize-docs-Zh-CN) (UNOFFICIAL)
|
||
|
|
|