/sequelize-yugabytedb

Sequelize, promise-based Node.js ORM

Primary LanguageJavaScriptApache License 2.0Apache-2.0

sequelize-yugabytedb

Use the below command to install sequelize-yugabytedb package in your project

npm install sequelize-yugabytedb 

Steps to run the tests

  1. Make sure you have a YugabyteDB cluster up and running on your machine.
    Note: The tests are assuming the localhost and 5433 as default host and port for YugabyteDB cluster.
  2. Go to YugabyteDB installation directory and create a database test_sequelize:
    $ ./bin/ysqlsh -c "CREATE DATABASE test_sequelize"
    
  3. Move back to sequelize-yugabytedb directory and install dependencies by running:
    $ npm install
    
  4. To run the test, simply do:
    $ npm test
    

We will soon add a link to product documentation for using the package once uploaded in yugabyte docs.

If you encounter any bugs please file it in sequelize-yugabytedb project