Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 1.16 KB

README.md

File metadata and controls

48 lines (31 loc) · 1.16 KB
Raw

knex-rqlite

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:

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, which implemented the compatibility between knex-rqlite and knex 2.0 (#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