Usage

Basic usage

To get the ball rollin' you first have to create an instance of Sequelize. Use it the following way:

var sequelize = new Sequelize('database', 'username'[, 'password'])

This will save the passed database credentials and provide all further methods. Furthermore you can specify a non-default host/port:

var sequelize = new Sequelize('database', 'username', 'password', {
  host: "my.server.tld",
  port: 12345
})

If you just don't have a password:

var sequelize = new Sequelize('database', 'username')
// or
var sequelize = new Sequelize('database', 'username', null)

You can also use a connection string:

var sequelize = new Sequelize('mysql://user:[email protected]:9821/dbname', {
  // Look to the next section for possible options
})

Options

Besides the host and the port, Sequelize comes with a whole bunch of options. Here they are:

var sequelize = new Sequelize('database', 'username', 'password', {
  // custom host; default: localhost
  host: 'my.server.tld',
 
  // custom port; default: 3306
  port: 12345,
 
  // custom protocol
  // - default: 'tcp'
  // - added in: v1.5.0
  // - postgres only, useful for heroku
  protocol: null,
 
  // disable logging; default: console.log
  logging: false,
 
  // max concurrent database requests; default: 50
  maxConcurrentQueries: 100,
 
  // the sql dialect of the database
  // - default is 'mysql'
  // - currently supported: 'mysql', 'sqlite', 'postgres'
  dialect: 'mysql',
 
  // you can also pass any dialect options to the underlying dialect library
  // - default is empty
  // - currently supported: 'mysql', 'mariadb'
  dialectOptions: {
    socketPath: '/Applications/MAMP/tmp/mysql/mysql.sock',
    supportBigNumbers: true,
    bigNumberStrings: true
  },
 
  // the storage engine for sqlite
  // - default ':memory:'
  storage: 'path/to/database.sqlite',
 
  // disable inserting undefined values as NULL
  // - default: false
  omitNull: true,
 
  // a flag for using a native library or not.
  // in the case of 'pg' -- set this to true will allow SSL support
  // - default: false
  native: true,
 
  // Specify options, which are used when sequelize.define is called.
  // The following example:
  //   define: {timestamps: false}
  // is basically the same as:
  //   sequelize.define(name, attributes, { timestamps: false })
  // so defining the timestamps for each model will be not necessary
  // Below you can see the possible keys for settings. All of them are explained on this page
  define: {
    underscored: false
    freezeTableName: false,
    syncOnAssociation: true,
    charset: 'utf8',
    collate: 'utf8_general_ci',
    classMethods: {method1: function() {}},
    instanceMethods: {method2: function() {}},
    timestamps: true
  },
 
  // similiar for sync: you can define this to always force sync for models
  sync: { force: true },
 
  // sync after each association (see below). If set to false, you need to sync manually after setting all associations. Default: true
  syncOnAssociation: true,
 
  // use pooling in order to reduce db connection overload and to increase speed
  // currently only for mysql and postgresql (since v1.5.0)
  pool: { maxConnections: 5, maxIdleTime: 30},
 
  // language is used to determine how to translate words into singular or plural form based on the [lingo project](https://github.com/visionmedia/lingo)
  // options are: en [default], es
  language: 'en'
})

Hint: You can also define a custom function for the logging part. Just pass a function. The first parameter will be the string that is logged.

Read replication

Sequelize supports read replication, i.e. having multiple servers that you can connect to when you want to do a SELECT query. When you do read replication, you specify one or more servers to act as read replicas, and one server to act as the write master, which handles all writes and updates and propagates them to the replicas (note that the actual replication process is not handled by Sequelize, but should be set up in MySql).

var sequelize = new Sequelize('database', null, null, {
  dialect: 'mysql',
  port: 3306
  replication: {
    read: [
      { host: '8.8.8.8', username: 'anotherusernamethanroot', password: 'lolcats!' },
      { host: 'localhost', username: 'root', password: null }
    ],
    write: { host: 'localhost', username: 'root', password: null }
  },
  pool: { // If you want to override the options used for the read pool you can do so here
    maxConnections: 20,
    maxIdleTime: 30000
  },
})

If you have any general settings that apply to all replicas you do not need to provide them for each instance. In the code above, database name and port is propagated to all replicas. The same will happen for user and password, if you leave them out for any of the replicas. Each replica has the following options:host,port,username,password,database

Sequelize uses a pool to manage connections to your replicas. The default options are:

{
  maxConnections: 10,
  minConnections: 0,
  maxIdleTime:    1000
}

If you want to modify these, you can pass pool as an options when instantiating Sequelize, as shown above.

Note: Read replication only works for MySQL at the moment!

Dialects

With the release of Sequelizev1.6.0, the library got independent from specific dialects. That mean, that you'll have to add the respective dialect library yourself. Another option is the use of the sequelize packages that ship the dialect libraries as well.

MySQL

In order to get Sequelize working nicely together with MySQL, you'll need to install[email protected]~2.0.0-alpha7. Once that's done you can use it like this:

var sequelize = new Sequelize('database', 'username', 'password', {
  // mysql is the default dialect, but you know...
  // for demo purporses we are defining it nevertheless :)
  // so: we want mysql!
  dialect: 'mysql'
})

Also possible is the use ofsequelize-mysql. Just install it vianpm install sequelize-mysqland use it like this:

var Sequelize = require('sequelize-mysql').sequelize
var mysql     = require('sequelize-mysql').mysql
 
var sequelize = new Sequelize('database', 'username', 'password', {
  // mysql is the default dialect, but you know...
  // for demo purporses we are defining it nevertheless :)
  // so: we want mysql!
  dialect: 'mysql'
})

Note: You can pass options directly to dialect library by setting the dialectOptions parameter. See Options for examples (currently only mysql and mariadb are supported).

SQLite

For SQLite compatibility you'll need[email protected]~2.1.5. Configure Sequelize like this:

var sequelize = new Sequelize('database', 'username', 'password', {
  // sqlite! now!
  dialect: 'sqlite',
 
  // the storage engine for sqlite
  // - default ':memory:'
  storage: 'path/to/database.sqlite'
})

If you want to use the bundled version, runnpm install sequelize-sqliteand use the following code:

var Sequelize = require('sequelize-sqlite').sequelize
var sqlite    = require('sequelize-sqlite').sqlite
 
 var sequelize = new Sequelize('database', 'username', 'password', {
  dialect: 'sqlite',
  storage: 'path/to/database.sqlite'
})

PostgreSQL

The library for PostgreSQL is[email protected]~2.0.0. You'll just need to define the dialect:

var sequelize = new Sequelize('database', 'username', 'password', {
  // gimme postgres, please!
  dialect: 'postgres'
})

In order to use the bundled version, use thisnpm install sequelize-postgresand require the lib this way:

var Sequelize = require('sequelize-postgres').sequelize
var postgres  = require('sequelize-postgres').postgres
 
 var sequelize = new Sequelize('database', 'username', 'password', {
  dialect: 'postgres'
})

Executing raw SQL queries

As there are often use cases in which it is just easier to execute raw / already prepared SQL queries, you can utilize the functionsequelize.query.

Here is how it works:

// Arguments for raw queries
sequelize.query('your query', [, callee], [, options], [, replacements])
 
// Quick example
sequelize.query("SELECT * FROM myTable").success(function(myTableRows) {
  console.log(myTableRows)
})
 
// Callee is the model definition. This allows you to easily map a query
// to a predefined model for sequelizejs e.g:
sequelize.query('SELECT * FROM projects', Projects).success(function(projects){
  console.log(projects) // Each record will now be mapped to the Projects DAO/factory.
});
 
/*
Options is an object with the following keys:
{
  logging: console.log, // A function (or false) for logging your queries
  plain: false,         // If plain is true, then sequelize will only return the first record of the result set. In case of false it will all records.
  raw: false            // Set this to true if you don't have a model definition for your query
}
*/
 
// Note the second argument being null!
// Even if we declared a callee here, the raw: true would supersede and return a raw object.
sequelize.query('SELECT * FROM projects', null, {raw: true}).success(function(projects) {
  console.log(projects)
})
 
/*
Replacements in a query can be done in two different ways, either using named parameters (starting with :), or unnamed, represented by a ?
 
The syntax used depends on the fourth argument passed to the function:
  * If an array is passed, ? will be replaced in the order that they appear in the array
  * If an object is passed, :key will be replaced with the keys from that object. If the object contains keys not found in the query or vice verca,
    an exception will be thrown.
*/
sequelize.query('SELECT * FROM projects WHERE status = ?', null, {raw: true}, ['active']).success(function(projects) {
  console.log(projects)
})
 
sequelize.query('SELECT * FROM projects WHERE status = :status ', null, {raw: true}, { status: 'active' }).success(function(projects) {
  console.log(projects)
})

One note: If the attribute names of the table contain dots, the resulting objects will get a nesting:

sequelize.query('select 1 as `foo.bar.baz`').success(function(rows) {
  console.log(JSON.stringify(rows))
 
  /*
    [{
      "foo": {
        "bar": {
          "baz": 1
        }
      }
    }]
  */
})
© Sascha Depold, et al. 2006 - 2022