mirror of
https://github.com/knex/knex.git
synced 2025-07-29 03:40:16 +00:00
7ef13ed32a
Also use SQLite so new users can more easily copy and paste and try it out right away Fixes #488
73 lines
2.3 KiB
Markdown
73 lines
2.3 KiB
Markdown
# [knex.js](http://knexjs.org) [](https://travis-ci.org/tgriesser/knex) [](https://coveralls.io/r/tgriesser/knex?branch=master)
|
|
|
|
A SQL query builder that is flexible, portable, and fun to use!
|
|
|
|
A batteries-included, multi-dialect (MySQL, PostgreSQL, SQLite3, 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
|
|
|
|
## 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',
|
|
connection: {
|
|
filename: './data.db'
|
|
}
|
|
});
|
|
|
|
// 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);
|
|
});
|
|
```
|