A brief tutorial on using the LoopBack MySQL connector.
Page Contents

loopback-example-database

A tutorial for basic database related features.

Overview

Topics covered

  • Data sources
    • Creating
    • Configuring
  • Models
    • Creating
  • Automigration
  • Discovery

Database specific tutorials

Database specific tutorials are on separate branches. The master branch contains the tutorial for MongoDB.

Branch Connector
master MongoDB
mssql Microsoft SQL Server
mysql MySQL
oracle Oracle
postgresql PostgreSQL

For example, to view the MySQL example:

git clone https://github.com/strongloop/loopback-example-database
cd loopback-example-database
git checkout mysql

Prerequisites

Before starting this tutorial, make sure you have the following installed:

  • Node
  • LoopBack CLI tools; see lb

Running the example

git clone https://github.com/strongloop/loopback-example-database
cd loopback-example-database
npm install
npm start

Tutorial - MySQL

1. Create a new LoopBack app

App info

  • Name: loopback-example-database
  • Dir to contain the project: loopback-example-database
lb app loopback-example-database
... # follow the prompts

2. Install the LoopBack MySQL connector

cd loopback-example-database
npm install --save loopback-connector-mysql

3. Create a data source

Data source info

  • Data source name: accountDS
  • Select the connector for accountDS: MySQL
lb datasource accountDS
... # follow the prompts

This creates a new data source named accountDS that uses the MySQL connector.

4. Configure the data source

For the purposes of this example, we will use a preconfigured StrongLoop MySQL server. Edit server/datasources.json to set the MySQL configs:

{
  ...
  "accountDS": {
    "name": "accountDS",
    "connector": "mysql",
    "host": "demo.strongloop.com",
    "port": 3306,
    "database": "loopback-example-mysql",
    "username": "demo",
    "password": "L00pBack"
  }
}

Feel free to use your own local MySQL instance. Simply change the configs above to match your own.

5. Create a new model

Model Info

  • Model name: Account
  • Attach Account to: accountDS (mysql)
  • Base class: PersistedModel
  • Expose via REST: Yes
  • Custom plural form: *Leave blank*
  • Properties:
    • email
      • String
      • Not required
    • createdAt
      • Date
      • Not required
    • lastModifiedAt
      • Date
      • Not required
lb model Account
... # follow the prompts

6. Create the collection with sample data - Automigration

With the account model configured, we can generate the corresponding MySQL table using the info from the Account metadata in common/models/account.json via auto-migration.

Start by creating a dir to store general-purpose scripts:

mkdir bin

Inside that dir, create a script named automigrate.js. To create the Account collection and create two sample accounts, run:

node bin/automigrate.js

WARNING

The automigrate function creates a new collection if it doesn’t exist. If the collection already exists, it will be destroyed and it’s data will be deleted. If you want to keep this data, use autoupdate instead.

You should see:

Created: { email: 'john.doe@ibm.com',
  createdAt: Thu Oct 22 2015 17:58:09 GMT-0700 (PDT),
  lastModifiedAt: Thu Oct 22 2015 17:58:09 GMT-0700 (PDT),
  id: 562986213ea33440575c6588 }
Created: { email: 'jane.doe@ibm.com',
  createdAt: Thu Oct 22 2015 17:58:09 GMT-0700 (PDT),
  lastModifiedAt: Thu Oct 22 2015 17:58:09 GMT-0700 (PDT),
  id: 562986213ea33440575c6587 }

7. View data using the explorer

Projects scaffolded via slc loopback come with loopback-component-explorer preconfigured. From the project root, start the server:

node .

Then to view the existing account data, browse to localhost:3000/explorer and click:

  • GET /Accounts
  • Try it out!

You should see:

[
  {
    "email": "john.doe@ibm.com",
    "createdAt": "2015-10-23T00:58:09.280Z",
    "lastModifiedAt": "2015-10-23T00:58:09.280Z",
    "id": "562986213ea33440575c6587"
  },
  {
    "email": "jane.doe@ibm.com",
    "createdAt": "2015-10-23T00:58:09.280Z",
    "lastModifiedAt": "2015-10-23T00:58:09.280Z",
    "id": "562986213ea33440575c6588"
  }
]

Try out some of the other endpoints to get a feel for how explorer works.

8. Add a script to perform discover the database schema

Discovery is the process of reverse engineering a LoopBack model from an existing database schema.

Create a script name discover-schema.js. Then run this script to discover the schema from the existing Account table:

node bin/discover-schema

You should see:

{
  "name": "Account",
  "options": {
    "idInjection": false,
    "mysql": {
      "schema": "loopback-example-mysql",
      "table": "Account"
    }
  },
  "properties": {
    "id": {
      "type": "Number",
      "required": true,
      "length": null,
      "precision": 10,
      "scale": 0,
      "id": 1,
      "mysql": {
        "columnName": "id",
        "dataType": "int",
        "dataLength": null,
        "dataPrecision": 10,
        "dataScale": 0,
        "nullable": "N"
      }
    },
    "email": {
      "type": "String",
      "required": false,
      "length": 512,
      "precision": null,
      "scale": null,
      "mysql": {
        "columnName": "email",
        "dataType": "varchar",
        "dataLength": 512,
        "dataPrecision": null,
        "dataScale": null,
        "nullable": "Y"
      }
    },
    "createdat": {
      "type": "Date",
      "required": false,
      "length": null,
      "precision": null,
      "scale": null,
      "mysql": {
        "columnName": "createdAt",
        "dataType": "datetime",
        "dataLength": null,
        "dataPrecision": null,
        "dataScale": null,
        "nullable": "Y"
      }
    },
    "lastmodifiedat": {
      "type": "Date",
      "required": false,
      "length": null,
      "precision": null,
      "scale": null,
      "mysql": {
        "columnName": "lastModifiedAt",
        "dataType": "datetime",
        "dataLength": null,
        "dataPrecision": null,
        "dataScale": null,
        "nullable": "Y"
      }
    }
  }
}

9. Add a script to discover and build models

When retrieving the scheme is not enough, you can discover and build LoopBack models in one step.

Create a sript named discover-and-build-models.js. Then run:

node bin/discover-and-build-models

You should see:

Found: [ { id: 1,
    email: 'john.doe@ibm.com',
    createdat: Fri Oct 23 2015 15:07:51 GMT-0700 (PDT),
    lastmodifiedat: Fri Oct 23 2015 15:07:51 GMT-0700 (PDT) },
  { id: 2,
    email: 'jane.doe@ibm.com',
    createdat: Fri Oct 23 2015 15:07:51 GMT-0700 (PDT),
    lastmodifiedat: Fri Oct 23 2015 15:07:51 GMT-0700 (PDT) } ]

See the official docs for more info.

More LoopBack examples

Tags: example_app