Repository files navigation

Postgres/MySQL/MariaDB/SQLite3 adapter forjs-data.

DSSqlAdapter

npm install --save knex js-data js-data-sql.

You also need to install the driver for the database you want to connect to.

npm install --save <mysql|mariasql|pg|sqlite3>

varJSData=require('js-data');varDSSqlAdapter=require('js-data-sql');varstore=newJSData.DS();varadapter=newDSSqlAdapter({client:'mysql',// or "pg" or "sqlite3"connection:{host:'123.45.67.890',user:'ubuntu',password:'welcome1234'}});store.registerAdapter('sql',adapter,{default:true});// "store" will now use the Sql adapter for all async operations

Read about usingJSData on the Server.

CHANGELOG.md

• Slack Channel - Better than IRC!
• Announcements
• Mailing List - Ask your questions!
• Issues - Found a bug? Feature request? Submit an issue!
• GitHub - View the source code for js-data.
• Contributing Guide

First, support is handled via theSlack Channel andtheMailing List. Ask your questionsthere.

When submitting issues on GitHub, please include as much detail as possible tomake debugging quick and easy.

• good - Your versions of js-data, js-data-sql, etc., relevant consolelogs/error, code examples that revealed the issue
• better - Aplnkr,fiddle, orbin that demonstrates the issue
• best - A Pull Request that fixes the issue, including test coverage for theissue and the fix

Github Issues.

1. Contribute to the issue/discussion that is the reason you'll be developing inthe first place
2. Fork js-data-sql
3. git clone git@github.com:<you>/js-data-sql.git
4. cd js-data-sql; npm install;
5. Write your code, including relevant documentation and tests
6. Runnpm test (build and test)

• You need Node 4.x that includes generator support without a flag
• The tests expect a database to be running follows, but can be overridden by passing the applicable environment variable as indicated (ex.DB_HOST=192.168.99.100 npm test).
  • DB_HOST:localhost
  • DB_NAME:circle_test
  • DB_USER:ubuntu
• You may usedocker/docker-compose to create MySql and Postgres containers to test against
  • docker-compose up -d
    • Start containers namedjs-data-sql-mysql andjs-data-sql-pg
  • MySQL
    • Environment variables
      • DB_CLIENT =mysql
      • DB_USER =root
      • DB_HOST =IP of docker-machine if not localhost
    • Populate schema
      • DB_CLIENT=mysql DB_USER=root npm run migrate-db
      • Also setDB_HOST if different fromlocalhost
    • Run tests
    • npm run mocha-mysql
      • SetDB_HOST if different fromlocalhost
    • Run cli
      • docker exec -it js-data-sql-mysql mysql circle_test
  • Postgres
    • Environment variables
      • DB_CLIENT =pg
      • DB_USER =ubuntu
      • DB_HOST =IP of docker-machine if not localhost
    • Populate schema
      • DB_CLIENT=pg npm run migrate-db
      • Also setDB_HOST if different fromlocalhost
    • Run tests
      • npm run mocha-pg
      • Also setDB_HOST if different fromlocalhost
    • docker exec -it js-data-sql-pg psql -U ubuntu -d circle_test
      • Run cli
  • All databases
    • Run all tests against MySQL and Postgres
      • npm run mocha-all
      • Also setDB_HOST if different fromlocalhost

1. Your code will be linted and checked for formatting, the tests will be run
2. Thedist/ folder & files will be generated, do NOT commitdist/*! Theywill be committed when a release is cut.
3. Submit your PR and we'll review!
4. Thanks!

Here's how to make a release on themaster branch:

1. Bumppackage.json to the appropriate version.
2. npm test must succeed.
3. This time, the builtdist/js-data-sql.js filewill be committed, so stage its changes.
4. Mention the release version in the commit message, e.g.Stable Version 1.2.3
5. Push to master.
6. Create a git tag. Name it the version of the release, e.g.1.2.3

• Easiest way is to just create a GitHub Release, which will create the tag for you. Name the Release and the git tag the same thing.

1. git fetch origin if you tagged it via GitHub Release, so you can get the tag on your local machine.
2. npm publish . (Make sure you got the version bumped correctly!)

The MIT License (MIT)

Copyright (c) 2014-2015 Jason Dobry

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

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

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, 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 THESOFTWARE.