loopback-connector-mysql/README.md

Loopback MySQL Connector

MySQL connector for Loopback Data.

Usage

To use it you need loopback-datasource-juggler.

1. Setup dependencies in package.json:

   {
     ...
     "dependencies": {
       "loopback-datasource-juggler": "latest",
       "loopback-connector-mysql": "latest"
     },
     ...
   }
   

2. Use:

       var Schema = require('loopback-datasource-juggler').Schema;
       var schema = new Schema('mysql', {
           database: 'myapp_test',
           username: 'root'
       });
   

   You can optionally pass a few additional parameters supported by node-mysql, most particularly password and collation. Collation currently defaults to utf8_general_ci. The collation value will also be used to derive the connection charset.

Running tests

npm test

Using the dataType field/column option with MySQL

The loopback-datasource-juggler MySQL adapter now supports using the dataType column/property attribute to specify what MySQL column type is used for many loopback-datasource-juggler types.

The following type-dataType combinations are supported:

• Number

  *

  integer

  * tinyint * smallint * mediumint * int * bigint

  Use the limit option to alter the display width.

  Example: { count : { type: Number, dataType: 'smallInt' }}

  • floating point types

    * float * double

    Use the precision and scale options to specify custom precision. Default is (16,8).

    Example: { average : { type: Number, dataType: 'float', precision: 20, scale: 4 }}

  • fixed-point exact value types

    * decimal * numeric

    Use the precision and scale options to specify custom precision. Default is (9,2).

    These aren't likely to function as true fixed-point.

    Example: { stdDev : { type: Number, dataType: 'decimal', precision: 12, scale: 8 }}

• String / Schema.Text / Schema.JSON

  * varchar * char * text * mediumtext * tinytext * longtext

  Example: { userName : { type: String, dataType: 'char', limit: 24 }}

  Example: { biography : { type: String, dataType: 'longtext' }}

• Date

  * datetime * timestamp

  Example: { startTime : { type: Date, dataType: 'timestamp' }}

• Enum

  Enums are special. Create an Enum using Enum factory:

    var MOOD = schema.EnumFactory('glad', 'sad', 'mad');
    MOOD.SAD;    // 'sad'
    MOOD(2);     // 'sad'
    MOOD('SAD'); // 'sad'
    MOOD('sad'); // 'sad'

• { mood: { type: MOOD }}
• { choice: { type: schema.EnumFactory('yes', 'no', 'maybe'), null: false }}

MIT License

Copyright (C) 2012 by Anatoliy Chakkaev

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.