https://github.com/gsandf/knex-expo

A partial fork of Knex to work with Expo and React Native
https://github.com/gsandf/knex-expo

Last synced: about 1 month ago
JSON representation

A partial fork of Knex to work with Expo and React Native

• Host: GitHub
• URL: https://github.com/gsandf/knex-expo
• Owner: gsandf
• License: mit
• Created: 2018-04-20T14:51:28.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-09-23T17:30:20.000Z (about 5 years ago)
• Last Synced: 2024-08-12T09:58:50.533Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 11.2 MB
• Stars: 3
• Watchers: 6
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [knex.js](http://knexjs.org)

[![npm version](http://img.shields.io/npm/v/knex.svg)](https://npmjs.org/package/knex)

[![Build Status](https://travis-ci.org/tgriesser/knex.svg?branch=master)](https://travis-ci.org/tgriesser/knex)

[![Coverage Status](https://coveralls.io/repos/tgriesser/knex/badge.svg?branch=master)](https://coveralls.io/r/tgriesser/knex?branch=master)

[![Dependencies Status](https://david-dm.org/tgriesser/knex.svg)](https://david-dm.org/tgriesser/knex)

[![Gitter chat](https://badges.gitter.im/tgriesser/knex.svg)](https://gitter.im/tgriesser/knex)

**This is a port to Expo for react-native. Require `expo-sqlite`

to be installed and configured first.**

**[SQLite Expo Docs](https://docs.expo.io/versions/v33.0.0/sdk/sqlite/)**

Because there are limited tools for the Expo platform,

we only support "sqlite" driver.

> **A SQL query builder that is _flexible_, _portable_, and _fun_ to use!**

A batteries-included, multi-dialect (MSSQL, MySQL, PostgreSQL, SQLite3, Oracle(including Oracle Wallet Authentication), WebSQL) query builder for

Node.js and the Browser, featuring:

* [transactions](http://knexjs.org/#Transactions)

* [connection pooling](http://knexjs.org/#Installation-pooling)

* [streaming queries](http://knexjs.org/#Interfaces-Streams)

* both a [promise](http://knexjs.org/#Interfaces-Promises) and [callback](http://knexjs.org/#Interfaces-Callbacks) API

* a [thorough test suite](https://travis-ci.org/tgriesser/knex)

* the ability to [run in the Browser](http://knexjs.org/#Installation-browser)

[Read the full documentation to get started!](http://knexjs.org)

For support and questions, join the `#bookshelf` channel on freenode IRC

For an Object Relational Mapper, see:

* http://bookshelfjs.org

* https://github.com/Vincit/objection.js

To see the SQL that Knex will generate for a given query, see: [Knex Query Lab](http://michaelavila.com/knex-querylab/)

## Examples

We have several examples [on the website](http://knexjs.org). Here is the first one to get you started:

```js

var knex = require('knex')({

  dialect: 'sqlite3'

});

// Create a table

knex.schema

  .createTable('users', function(table) {

    table.increments('id');

    table.string('user_name');

  })

  // ...and another

  .createTable('accounts', function(table) {

    table.increments('id');

    table.string('account_name');

    table

      .integer('user_id')

      .unsigned()

      .references('users.id');

  })

  // Then query the table...

  .then(function() {

    return knex.insert({ user_name: 'Tim' }).into('users');

  })

  // ...and using the insert id, insert into the other table.

  .then(function(rows) {

    return knex.table('accounts').insert({ account_name: 'knex', user_id: rows[0] });

  })

  // Query both of the rows.

  .then(function() {

    return knex('users')

      .join('accounts', 'users.id', 'accounts.user_id')

      .select('users.user_name as user', 'accounts.account_name as account');

  })

  // .map over the results

  .map(function(row) {

    console.log(row);

  })

  // Finally, add a .catch handler for the promise chain

  .catch(function(e) {

    console.error(e);

  });

```