Skip to content

lufrai/knex-rqlite

Repository files navigation

license npm Tests coverage code style PRs

Rqlite dialect for knex


Usage

First install knex and knex-rqlite: npm install knex rqlite-js @lufrai/knex-rqlite

Then to use the driver like this:

import Knex from "knex";
import { RqliteDialect } from "@lufrai/knex-rqlite";

const knex = Knex({
  client: RqliteDialect,
  connection: {
    host: "localhost",
    port: 4001
  }
});

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