Loopback Connector for MySQL
Go to file
Simon Ho 77a4811903 Update README.md 2015-03-17 22:26:09 -07:00
example Reformat code 2014-02-12 16:57:06 -08:00
lib Merge pull request #78 from strongloop/feature/allow-object-id 2015-03-09 15:55:43 -07:00
test Allow models backed by MySQL to reference mongodb ObjectID 2015-03-04 22:55:33 -08:00
.gitignore Prevent extra files from going into npm 2013-12-13 10:25:53 -08:00
.travis.yml Upd node version for travis 2013-03-27 20:32:13 +04:00
CHANGES.md 1.6.0 2015-02-20 17:11:00 -08:00
CONTRIBUTING.md Fix bad CLA URL in CONTRIBUTING.md 2014-12-29 08:27:46 -08:00
LICENSE Update to dual MIT/StrongLoop license 2014-02-17 16:35:08 -08:00
Makefile Remove blanket 2013-11-20 09:23:53 -08:00
NOTICE.md Add NOTICE and update READE 2013-10-30 23:02:12 -07:00
README.md Update README.md 2015-03-17 22:26:09 -07:00
docs.json Reformat code 2014-02-12 16:57:06 -08:00
index.js Init 2012-12-14 18:01:44 +04:00
package.json 1.6.0 2015-02-20 17:11:00 -08:00

README.md

loopback-connector-mysql

loopback-connector-mysql is the MySQL connector module for loopback-datasource-juggler.

For complete documentation, see StrongLoop Documentation | MySQL Connector.

Installation

npm install loopback-connector-mysql --save

Basic use

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 DataSource = require('loopback-datasource-juggler').DataSource;
        var dataSource = new DataSource('mysql', {
            host: 'localhost',
            port: 3306,
            database: 'mydb',
            username: 'myuser',
            password: 'mypass'
        });
    

    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

The tests in this repository are mainly integration tests. This means you will need to run them using our preconfigured test server.

  1. Ask a core developer for instructions on how to set up test server credentials on your machine
  2. npm test