Project: YugabyteDB (App Definition and Development / Database)
File: ysql-sequelize.md

title: Node.js Sequelize ORM example application headerTitle: Node.js ORM example application linkTitle: Node.js description: Node.js ORM example application that uses Sequelize and YSQL. menu: v2.18: identifier: nodejs-sequelize parent: orm-tutorials weight: 690 type: docs <ul class="nav nav-tabs-alt nav-tabs-yb"> <li > <a href="../ysql-sequelize/" class="nav-link active"> <i class="icon-postgres" aria-hidden="true"></i> Sequelize ORM </a> </li> <li> <a href="../ysql-prisma/" class="nav-link "> <i class="icon-postgres" aria-hidden="true"></i> Prisma ORM </a> </li> </ul> The following tutorial implements a REST API server using the ORM. The scenario is that of an e-commerce application. Database access in this application is managed through the Sequelize ORM. The application source is in the . You can customize a number of options using the properties file located at `config/config.json`. This tutorial assumes that you have: YugabyteDB up and running. Download and install YugabyteDB by following the steps in . version 16 or later. ```sh $ git clone https://github.com/YugabyteDB-Samples/orm-examples.git ``` ```sh $ cd ./node/sequelize/ ``` ```sh npm install ``` This configuration can be used while connecting to a YB Managed cluster or a local YB cluster with SSL enabled. Use the configuration in the following way in the `models/index.js` file when you create the sequelize object: ```js sequelize = new Sequelize("<dbname>", "<username>","<password>" , { dialect: 'postgres', port: 5433, host: "<host_name>", dialectOptions: { ssl: { rejectUnauthorized: true, ca: fs.readFileSync('<pathtoroot_crt>').toString(), } } }); ``` Start the Node.js API server at <http://localhost:8080> with DEBUG logs on. ```sh $ DEBUG=sequelize:* npm start ``` Create 2 users. ```sh $ curl --data '{ "firstName" : "John", "lastName" : "Smith", "email" : "jsmith@example.com" }' \ -v -X POST -H 'Content-Type:application/json' http://localhost:8080/users ``` ```sh $ curl --data '{ "firstName" : "Tom", "lastName" : "Stewart", "email" : "tstewart@example.com" }' \ -v -X POST -H 'Content-Type:application/json' http://localhost:8080/users ``` Create 2 products. ```sh $ curl \ --data '{ "productName": "Notebook", "description": "200 page notebook", "price": 7.50 }' \ -v -X POST -H 'Content-Type:application/json' http://localhost:8080/products ``` ```sh $ curl \ --data '{ "productName": "Pencil", "description": "Mechanical pencil", "price": 2.50 }' \ -v -X POST -H 'Content-Type:application/json' http://localhost:8080/products ``` Create 2 orders. ```sh $ curl \ --data '{ "userId": "2", "products": [ { "productId": 1, "units": 2 } ] }' \ -v -X POST -H 'Content-Type:application/json' http://localhost:8080/orders ``` ```sh $ curl \ --data '{ "userId": "2", "products": [ { "productId": 1, "units": 2 }, { "productId": 2, "units": 4 } ] }' \ -v -X POST -H 'Content-Type:application/json' http://localhost:8080/orders ``` ```sh $ ./bin/ysqlsh ``` ```output ysqlsh (11.2) Type "help" for help. yugabyte=# ``` ```plpgsql yugabyte=# SELECT count(*) FROM users; ``` ```output count 2 (1 row) ``` ```plpgsql yugabyte=# SELECT count(*) FROM products; ``` ```output count 2 (1 row) ``` ```plpgsql yugabyte=# SELECT count(*) FROM orders; ``` ```output count 2 (1 row) ``` ```sh $ curl http://localhost:8080/users ``` ```output.json { "content": [ { "userId": 2, "firstName": "Tom", "lastName": "Stewart", "email": "tstewart@example.com" }, { "userId": 1, "firstName": "John", "lastName": "Smith", "email": "jsmith@example.com" } ], ... } ``` ```sh $ curl http://localhost:8080/products ``` ```output.json { "content": [ { "productId": 2, "productName": "Pencil", "description": "Mechanical pencil", "price": 2.5 }, { "productId": 1, "productName": "Notebook", "description": "200 page notebook", "price": 7.5 } ], ... } ``` ```sh $ curl http://localhost:8080/orders ``` ```output.json { "content": [ { "orderTime": "2019-05-10T04:26:54.590+0000", "orderId": "999ae272-f2f4-46a1-bede-5ab765bb27fe", "user": { "userId": 2, "firstName": "Tom", "lastName": "Stewart", "email": "tstewart@example.com" }, "userId": null, "orderTotal": 25, "products": [] }, { "orderTime": "2019-05-10T04:26:48.074+0000", "orderId": "1598c8d4-1857-4725-a9ab-14deb089ab4e", "user": { "userId": 2, "firstName": "Tom", "lastName": "Stewart", "email": "tstewart@example.com" }, "userId": null, "orderTotal": 15, "products": [] } ], ... } ```