Sequelize is an easy-to-use MySQL object-relationship-mapper for node.js
JavaScript
Pull request Compare This branch is 14 commits ahead, 6882 commits behind sequelize:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
doc @ 3c0dc39
examples
lib
spec
.gitignore
.gitmodules
.travis.yml
LICENSE
README.md
changelog.md
index.js
package.json

README.md

Sequelize

The Sequelize library provides easy access to a MySQL database by mapping database entries to objects and vice versa. To put it in a nutshell... it's an ORM (Object-Relational-Mapper). The library is written entirely in JavaScript and can be used in the Node.JS environment.

v1.2.1

I highly recommend to read this article about the changes in sequelize 1.2.1, which changes some defaults and some interfaces.

Features

  • Schema definition
  • Schema synchronization/dropping
  • Easy definition of class/instance methods
  • Instance saving/updating/dropping
  • Asynchronous library
  • Associations
  • Importing definitions from single files

Documentation, Examples and Updates

You can find the documentation and announcements of updates on the project's website. If you want to know about latest development and releases, follow me on Twitter. Also make sure to take a look at the examples in the repository. The website will contain them soon, as well. For a (more or less) complete overview of changes in 1.0.0. take a look at this blogpost. An article about changes in 1.2.1. can be found here

Collaboration

I'm glad to get pull request if any functionality is missing or something is buggy. But please ... run the tests before you send me the pull request.

Tests

In order to run the tests, just do npm install, which will install expresso and jasmine. I am switching from expresso to jasmine, so please add according tests to your pull requests. This is how you start the tests:

node_modules/.bin/expresso -s test/**/*
node_modules/.bin/jasmine-node spec/

Current build status on travis-ci: Build Status