Initial additions

Author: rhedgpeth

README.md

@@ -0,0 +1,91 @@
+## Quick Start: Sequelize (Node.js) and MariaDB
+
+This repository will walk you through the process of quickly getting started with [Sequelize](https://sequelize.org/), a promise-based Node.js object-relational mapping (ORM) library, to connect to and communicate with a [MariaDB](https://mariadb.com) using the [MariaDB Node.js connector](https://github.com/mariadb-corporation/mariadb-connector-nodejs).
+
+## Requirements
+
+* [Node.js](https://nodejs.org/en/download/)
+* [MariaDB](https://mariadb.com) - to get started with MariaDB check out [this guide](https://github.com/mariadb-developers/mariadb-getting-started)!
+
+## Getting Started 
+
+1.) Clone this repo.
+
+```bash
+$ git clone https://github.com/mariadb-developers/nodejs-sequelize-quickstart.git
+```
+
+2.) Create the database schema and load test data using the [schema.sql file](schema.sql). 
+
+You can do this by either copying, pasting and executing the SQL in [schema.sql](schema.sql) or with the MariaDB command-line client (from within the `nodejs-sequelize-quickstart` directory, which you just pulled down).
+
+_For example:_
+```bash 
+$ mariadb --host 127.0.0.1 --user root --pRootPassword123! < schema.sql
+```
+
+3.) Step in to the [src](src) directory and install the MariaDB Node.js driver (connector) using [npm](npmjs.com).
+
+
+```bash
+$ npm install mariadb sequelize
+```
+
+4.) Within [src](src), create an environment file (e.g. `$ touch .env`) and add _your_ database connection settings.
+
+_For example:_
+``` 
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_USER=root
+DB_PASS=RootPassword123!
+DB_NAME=demo
+```
+
+5.) Update the connection configuration to point to _your_ database in the JavaScript sample files. For example, [here](src/db.js#L4-L11).
+
+6.) Execute the sample JavaScript files using the `node` [CLI command](https://nodejs.org/api/cli.html).
+
+_For example:_
+```bash
+$ node src/queries/customers_basic.js
+
+$ node src/queries/customers_relationships.js
+
+$ node src/queries/orders.js
+
+...
+```
+
+**The scripts:**
+
+* [customers_basics.js](src/queries/customers_basics.js) - select all customers using a [Sequelize model](https://sequelize.org/master/manual/model-basics.html) and `findAll` function.
+
+* [customers_relationaships.js] - - select all customers using a [Sequelize model](https://sequelize.org/master/manual/model-basics.html) and `findAll` function, which includes loaded child models based configured [associations](https://sequelize.org/master/manual/assocs.html) (in [db.js](src/db.js#L18-L24)).
+
+* [orders.js] - select all orders using a [Sequelize model](https://sequelize.org/master/manual/model-basics.html) and `findAll` function, which includes loaded child models based configured [associations](https://sequelize.org/master/manual/assocs.html) (in [db.js](src/db.js#L18-L24)).
+
+## Helpful Resources
+
+* [Quick Start: Node.js and MariaDB](https://github.com/mariadb-developers/nodejs-quickstart) - Start here if you're just getting started with Node.js and MariaDB!
+* [Official MariaDB Documentation](https://mariadb.com/docs)
+* [MariaDB Connector/Node.js Source Code](https://github.com/mariadb-corporation/mariadb-connector-nodejs)
+* [MariaDB Quickstart Guide](https://github.com/mariadb-developers/mariadb-getting-started)
+* [Official Sequelize Documentation](https://sequelize.org/master/index.html)
+
+## Support and Contribution
+
+Please feel free to submit PR's, issues or requests to this project directly.
+
+If you have any other questions, comments, or looking for more information on MariaDB please check out:
+
+* [MariaDB Developer Hub](https://mariadb.com/developers)
+* [MariaDB Community Slack](https://r.mariadb.com/join-community-slack)
+
+Or reach out to us directly via:
+
+* [[email protected]](mailto:[email protected])
+* [MariaDB Twitter](https://twitter.com/mariadb)
+
+## License <a name="license"></a>
+[![License](https://img.shields.io/badge/License-MIT-blue.svg?style=plastic)](https://opensource.org/licenses/MIT)

schema.sql

@@ -0,0 +1,40 @@
+/* Create schema*/
+CREATE DATABASE `demo`;
+
+USE `demo`;
+
+CREATE TABLE `customers` (
+    `id` INT UNSIGNED NOT NULL AUTO_INCREMENT,
+    `first_name` VARCHAR(100) NOT NULL,
+    `last_name` VARCHAR(100) NOT NULL,
+    PRIMARY KEY (`id`)
+);
+
+CREATE TABLE `products` (
+    `id` INT UNSIGNED NOT NULL AUTO_INCREMENT,
+    `name` VARCHAR(50) NOT NULL,
+    `amount` DECIMAL(15,2) NOT NULL,
+    PRIMARY KEY (`id`)
+);
+
+CREATE TABLE `orders` (s
+    `id` INT UNSIGNED NOT NULL AUTO_INCREMENT,
+    `customer_id` INT UNSIGNED NOT NULL,
+    `product_id` INT UNSIGNED NOT NULL,
+    `quantity` INT UNSIGNED NOT NULL,
+    PRIMARY KEY (`id`),
+    KEY `FK_Customer` (`customer_id`),
+    KEY `FK_Product` (`product_id`),
+    CONSTRAINT `FK_Customer` FOREIGN KEY (`customer_id`) REFERENCES `customers` (`id`) ON DELETE CASCADE ON UPDATE CASCADE,
+    CONSTRAINT `FK_Product` FOREIGN KEY (`product_id`) REFERENCES `products` (`id`) ON DELETE CASCADE ON UPDATE CASCADE
+);
+
+/* Load test data */
+INSERT INTO customers (`first_name`, `last_name`) VALUES 
+    ('Jane', 'Brown'), ('Ryan', 'Hall'), ('Mary', 'Stark');
+
+INSERT INTO products (`name`, `amount`) VALUES
+    ('T-shirt', 19.99), ('Hat', 9.99);
+
+INSERT INTO orders (customer_id, product_id, quantity) VALUES
+    (1, 1, 1), (2, 1, 3), (3, 2, 2);

src/db.js

@@ -0,0 +1,26 @@
+require('dotenv').config();
+
+const Sequelize = require("sequelize");
+const sequelize = new Sequelize(process.env.DB_NAME, process.env.DB_USER, process.env.DB_PASS, {
+  host: process.env.DB_HOST,
+  port: process.env.DB_PORT,
+  dialect: 'mariadb',
+  define: {
+    timestamps: false
+  }
+});
+
+const db = {};
+
+db.Sequelize = Sequelize;
+db.sequelize = sequelize;
+
+db.customers = require("./models/customer.model.js")(sequelize, Sequelize);
+db.products = require("./models/product.model.js")(sequelize, Sequelize);
+db.orders = require("./models/order.model.js")(sequelize, Sequelize);
+
+db.customers.hasMany(db.orders,{ as: 'orders', foreignKey: 'customer_id' });
+db.orders.belongsTo(db.products,{ as: 'product', foreignKey: 'product_id' });
+db.orders.belongsTo(db.customers,{ as: 'customer', foreignKey: 'customer_id' });
+
+module.exports = db;

src/models/customer.model.js

@@ -0,0 +1,17 @@
+module.exports = (sequelize, Sequelize) => {
+    const Customer = sequelize.define("customer", {
+        id: {
+            type: Sequelize.INTEGER,
+            primaryKey: true,
+            autoIncrement: true
+        },
+        first_name: {
+            type: Sequelize.STRING
+        },
+        last_name: {
+            type: Sequelize.STRING
+        }
+    });
+    
+    return Customer;
+};

src/models/order.model.js

@@ -0,0 +1,20 @@
+module.exports = (sequelize, Sequelize) => {
+    const Order = sequelize.define("order", {
+        id: {
+            type: Sequelize.INTEGER,
+            primaryKey: true,
+            autoIncrement: true
+        },
+        customer_id: {
+            type: Sequelize.INTEGER
+        },
+        product_id: {
+            type: Sequelize.INTEGER
+        },
+        quantity: {
+            type: Sequelize.INTEGER
+        }
+    });
+    
+    return Order;
+};

src/models/product.model.js

@@ -0,0 +1,17 @@
+module.exports = (sequelize, Sequelize) => {
+    const Product = sequelize.define("product", {
+        id: {
+            type: Sequelize.INTEGER,
+            primaryKey: true,
+            autoIncrement: true
+        },
+        name: {
+            type: Sequelize.STRING
+        },
+        amount: {
+            type: Sequelize.DECIMAL
+        }
+    });
+    
+    return Product;
+};

src/queries/customers_basic.js

@@ -0,0 +1,9 @@
+const db = require("./db.js");
+const Customer = db.customers;
+
+async function asyncFunction() {
+    const customers = await Customer.findAll();
+    console.log(JSON.stringify(customers));
+}
+
+asyncFunction();

src/queries/customers_relationships.js

@@ -0,0 +1,25 @@
+const db = require("../db_sequelize.js");
+const Customer = db.customers;
+const Order = db.orders;
+const Product = db.products;
+
+Customer.findAll({
+        include: [
+            {
+                model: Order,
+                as: 'orders',
+                attributes: ['id','quantity'],
+                include: [{
+                    model: Product,
+                    as: 'product',
+                    attributes: ['id','name','amount']
+                }]
+            }
+        ]
+    })
+    .then(results => {
+        console.log(JSON.stringify(results));
+    })
+    .catch(err => {
+        console.log(err);
+    });

src/queries/orders.js

@@ -0,0 +1,25 @@
+const db = require("../db_sequelize.js");
+const Order = db.orders;
+const Customer = db.customers;
+const Product = db.products;
+
+Order.findAll({
+        include: [
+            {
+                model: Customer,
+                as: 'customer',
+                attributes: ['id','first_name','last_name']
+            },
+            {
+                model: Product,
+                as: 'product',
+                attributes: ['id','name','amount']
+            },
+        ]
+    })
+    .then(results => {
+        console.log(JSON.stringify(results));
+    })
+    .catch(err => {
+        console.log(err);
+    });