UNPKG

3.8 kBMarkdownView Raw
1# Sequelize
2
3[![npm version](https://badgen.net/npm/v/sequelize)](https://www.npmjs.com/package/sequelize)
4[![Travis Build Status](https://badgen.net/travis/sequelize/sequelize?icon=travis)](https://travis-ci.org/sequelize/sequelize)
5[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/9l1ypgwsp5ij46m3/branch/master?svg=true)](https://ci.appveyor.com/project/sushantdhiman/sequelize/branch/master)
6[![npm downloads](https://badgen.net/npm/dm/sequelize)](https://www.npmjs.com/package/sequelize)
7[![codecov](https://badgen.net/codecov/c/github/sequelize/sequelize?icon=codecov)](https://codecov.io/gh/sequelize/sequelize)
8[![Last commit](https://badgen.net/github/last-commit/sequelize/sequelize)](https://github.com/sequelize/sequelize)
9[![Merged PRs](https://badgen.net/github/merged-prs/sequelize/sequelize)](https://github.com/sequelize/sequelize)
10[![GitHub stars](https://badgen.net/github/stars/sequelize/sequelize)](https://github.com/sequelize/sequelize)
11[![Slack Status](https://sequelize-slack.herokuapp.com/badge.svg)](http://sequelize-slack.herokuapp.com/)
12[![node](https://badgen.net/npm/node/sequelize)](https://www.npmjs.com/package/sequelize)
13[![License](https://badgen.net/github/license/sequelize/sequelize)](https://github.com/sequelize/sequelize/blob/master/LICENSE)
14[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
15
16Sequelize is a promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server. It features solid transaction support, relations, eager and lazy loading, read replication and more.
17
18Sequelize follows [SEMVER](http://semver.org). Supports Node v6 and above to use ES6 features.
19
20New to Sequelize? Take a look at the [Tutorials and Guides](https://sequelize.org/master). You might also be interested in the [API Reference](https://sequelize.org/master/identifiers).
21
22## Table of Contents
23- [Installation](#installation)
24- [Documentation](#documentation)
25- [Responsible disclosure](#responsible-disclosure)
26- [Resources](#resources)
27
28## Installation
29
30```bash
31$ npm install --save sequelize # This will install v5
32
33# And one of the following:
34$ npm install --save pg pg-hstore # Postgres
35$ npm install --save mysql2
36$ npm install --save mariadb
37$ npm install --save sqlite3
38$ npm install --save tedious # Microsoft SQL Server
39```
40
41## Documentation
42- [v5 Documentation](https://sequelize.org/master)
43- [v4 Documentation](https://sequelize.org/v4)
44- [v3 Documentation](https://sequelize.org/v3)
45- [Contributing](https://github.com/sequelize/sequelize/blob/master/CONTRIBUTING.md)
46
47## Responsible disclosure
48If you have security issues to report please refer to our [Responsible Disclosure Policy](./SECURITY.md) for more details.
49
50## Resources
51- [Changelog](https://github.com/sequelize/sequelize/releases)
52- [Slack](http://sequelize-slack.herokuapp.com/)
53- [Stack Overflow](https://stackoverflow.com/questions/tagged/sequelize.js)
54
55### Tools
56- [Sequelize CLI](https://github.com/sequelize/cli)
57- [Sequelize & TypeScript](https://sequelize.org/master/manual/typescript.html)
58- [Enhanced TypeScript with decorators](https://github.com/RobinBuschmann/sequelize-typescript)
59- [Sequelize & GraphQL](https://github.com/mickhansen/graphql-sequelize)
60- [Add-ons & Plugins](https://sequelize.org/master/manual/resources.html)
61- [Sequelize & CockroachDB](https://github.com/cockroachdb/sequelize-cockroachdb)
62
63### Learning
64- [Getting Started](https://sequelize.org/master/manual/getting-started)
65- [Express Example](https://github.com/sequelize/express-example)
66
67### Translations
68- [English v3/v4/v5](https://sequelize.org) (OFFICIAL)
69- [中文文档 v4/v5](https://github.com/demopark/sequelize-docs-Zh-CN) (UNOFFICIAL)