@ailo/knex-utils v4.0.40

@ailo/knex-utils

Utilities to be used in node.js repos using knex.

Usage

First, add it as a dependency:

yarn add @ailo/knex-utils

Then, depending on what you need:

Knex singleton instance (KnexRef)

See /src/KnexRef/KnexRef.ts.

Add ailorn column type to postgres

// database/migrations/123_create_ailorn_column_type.js
const { V2AilornColumnTypeMigration } = require("@ailo/knex-utils");
module.exports = V2AilornColumnTypeMigration;

Migrating from V1 to V2 ailorn column type to postgres

// database/migrations/123_create_ailorn_column_type.js
const { V1ToV2AilornColumnTypeMigration } = require("@ailo/knex-utils");
module.exports = V1ToV2AilornColumnTypeMigration;

You will also need to change your initial ailorn column migration to import from V1AilornColumnTypeMigration rather than CreateAilornColumnTypeMigration, which has been removed.

Test Utils (e.g. useKnex)

// database/migrations/tests/1002_rename_user_to_person.test.ts
import { useKnex } from "@ailo/knex-utils/build/main/test-utils";
import { testMigrationConfig } from "knexConfig";
import moment from "moment";
import { up } from "../1002_rename_user_to_person";

const knexRef = useKnex({
  knexConfig: testMigrationConfig,
  migrateTo: "1001",
});

it("db migration 1002_rename_user_to_person works", async () => {
  const knex = knexRef.current;

  await knex("user").insert({
    name: "john",
  });
  await up(knex);

  const [user] = await knex("person").select("id", "name");
  expect(user.name).toEqual("john");
});

local-db shell file

yarn local-db
yarn local-db test

History Table DB migration utils

See /src/history-utils/README.md.

Transaction utils

See /src/transactions/README.md.

Development

yarn
yarn start

Testing

yarn lint # prettier and eslint
yarn test # unit tests
yarn test:watch # unit tests in watch mode

Releasing

yarn release