Postgres/MySQL/MariaDB/SQLite3 adapter for js-data. Main Site: http://js-data.io, API Reference Docs: http://api.js-data.io
Clone or download

README.md

js-data logo

js-data-sql

Slack NPM Tests Downloads Coverage

A Postgres/MySQL/MariaDB/SQLite3 adapter for the JSData Node.js ORM.

Installation

npm install --save js-data js-data-sql

And then you also need to install one of the following:

  • pg
  • sqlite3
  • mysql
  • mysql2
  • mariasql
  • strong-oracle
  • oracle
  • mssql

Usage

import { SqlAdapter } from 'js-data-sql';

// Create an instance of SqlAdapter
const adapter = new SqlAdapter({
  knexOpts: {
    client: 'mysql'
  }
});

// Other JSData setup hidden

// Register the adapter instance
store.registerAdapter('sql', adapter, { default: true });

JSData + SQL Tutorial

Start with the JSData + SQL tutorial or checkout the API Reference Documentation.

Need help?

Please post a question on Stack Overflow. This is the preferred method.

You can also chat with folks on the Slack Channel. If you end up getting your question answered, please still consider consider posting your question to Stack Overflow (then possibly answering it yourself). Thanks!

Want to contribute?

Awesome! You can get started over at the Contributing guide.

Thank you!

License

The MIT License (MIT)

Copyright (c) 2014-2017 js-data-sql project authors