diff --git a/sections/installation.js b/sections/installation.js index fd81a460..f8bb0d4b 100644 --- a/sections/installation.js +++ b/sections/installation.js @@ -28,6 +28,7 @@ export default [ $ npm install pg $ npm install pg-native $ npm install sqlite3 + $ npm install better-sqlite3 $ npm install mysql $ npm install mysql2 $ npm install oracledb @@ -99,20 +100,36 @@ export default [ }, { type: "info", - content: "Note: When you use the SQLite3 adapter, there is a filename required, not a network connection. For example:" + content: "Note: When you use the SQLite3 or Better-SQLite3 adapter, there is a filename required, not a network connection. For example:" }, { type: "code", language: "js", content: ` const knex = require('knex')({ - client: 'sqlite3', + client: 'sqlite3', // or 'better-sqlite3' connection: { filename: "./mydb.sqlite" } }); ` }, + { + type: "info", + content: "Note: You can also run either SQLite3 or Better-SQLite3 with an in-memory database by providing `:memory:` as the filename. For example:" + }, + { + type: "code", + language: "js", + content: ` + const knex = require('knex')({ + client: 'sqlite3', // or 'better-sqlite3' + connection: { + filename: ":memory:" + } + }); + ` + }, { type: "info", content: "Note: When you use the SQLite3 adapter, you can set flags used to open the connection. For example:" diff --git a/sections/prelude.js b/sections/prelude.js index c65cc1b2..8ecf92ff 100644 --- a/sections/prelude.js +++ b/sections/prelude.js @@ -4,7 +4,7 @@ export default (version) => [ type: "text", content: [ ``, - "**Knex.js** (pronounced /kəˈnɛks/) is a \"batteries included\" SQL query builder for **PostgreSQL**, **CockroachDB**, **MSSQL**, **MySQL**, **MariaDB**, **SQLite3**, **Oracle**, and **Amazon Redshift** designed to be flexible, portable, and fun to use. It features both traditional node style [callbacks](#Interfaces-Callbacks) as well as a [promise](#Interfaces-Promises) interface for cleaner async flow control, [a stream interface](#Interfaces-Streams), full-featured [query](#Builder) and [schema](#Schema) builders, [**transaction support (with savepoints)**](#Transactions), connection [pooling](#Installation-pooling) and standardized responses between different query clients and dialects.", + "**Knex.js** (pronounced /kəˈnɛks/) is a \"batteries included\" SQL query builder for **PostgreSQL**, **CockroachDB**, **MSSQL**, **MySQL**, **MariaDB**, **SQLite3**, **Better-SQLite3**, **Oracle**, and **Amazon Redshift** designed to be flexible, portable, and fun to use. It features both traditional node style [callbacks](#Interfaces-Callbacks) as well as a [promise](#Interfaces-Promises) interface for cleaner async flow control, [a stream interface](#Interfaces-Streams), full-featured [query](#Builder) and [schema](#Schema) builders, [**transaction support (with savepoints)**](#Transactions), connection [pooling](#Installation-pooling) and standardized responses between different query clients and dialects.", "The project is [hosted on GitHub](https://github.com/knex/knex), and has a comprehensive [test suite](https://github.com/knex/knex/actions).", "Knex is available for use under the [MIT software license](https://github.com/knex/knex/blob/master/LICENSE).", "You can report bugs and discuss features on the [GitHub issues page](https://github.com/knex/knex/issues), add pages to the [wiki](https://github.com/knex/knex/wiki) or send tweets to [@kibertoad](https://twitter.com/kibertoad).",