https://github.com/rqlite/knex-rqlite

rqlite dialect for Knex.js
https://github.com/rqlite/knex-rqlite

database javascript knex rqlite sqlite typescript

Last synced: about 1 year ago
JSON representation

rqlite dialect for Knex.js

• Host: GitHub
• URL: https://github.com/rqlite/knex-rqlite
• Owner: rqlite
• License: mit
• Created: 2020-02-24T17:29:39.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-27T16:28:44.000Z (over 1 year ago)
• Last Synced: 2025-04-02T21:42:37.244Z (about 1 year ago)
• Topics: database, javascript, knex, rqlite, sqlite, typescript
• Language: TypeScript
• Size: 2.81 MB
• Stars: 12
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# [knex-rqlite](https://github.com/rqlite/knex-rqlite)

[![](assets/badge.license.svg)](https://opensource.org/licenses/MIT)

[![](assets/badge.npm.svg)](https://www.npmjs.com/package/knex-rqlite)

![](assets/badge.coverage.svg)

[![](assets/badge.style.svg)](https://prettier.io/)

Rqlite dialect for knex

---

## Usage

First install knex and knex-rqlite: `npm install knex rqlite-js knex-rqlite`

Then to use the driver like this:

```js

import Knex from "knex";

import { RqliteDialect, typeConfig } from "knex-rqlite";

const knex = Knex({

  client: RqliteDialect,

  connection: typeConfig({

    host: "localhost",

    port: 4001,

  }),

});

```

## Credits

A special thanks goes to the team [@redaxle](https://github.com/redaxle), which implemented the compatibility between knex-rqlite and knex 2.0 ([#17](https://github.com/rqlite/knex-rqlite/pull/17))!

## Known problems

- This knex dialect **doesn't support transactions** yet

- Look into TODO.md to find a list of coming features

## E2E tests

The tests can be run with `./scripts/test.js`

**This requires a running rqlite server on port 4001 and will drop&change the table rqliteDialect-e2e**

## Building

`./scripts/build`