Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.38 KB

README.md

File metadata and controls

52 lines (37 loc) · 1.38 KB
Raw

postgres-local CircleCI npm (scoped)

Run any version of Postgres locally

Usage

0. Install

$ yarn add @shelf/postgres-local --dev

1. Start Postgres

import {start} from '@shelf/postgres-local';

await start({
  seedPath: "schema.sql",
  version: 14,
  port: 5555,
  includeInstallation: true,
  debugMode: false
});
  • seedPath - absolute path to sql file with commands that will set up db structure before tests
  • includeInstallation
    • when this flag is true (default) macOS will run brew install and linux apt install to make sure postgres is installed
    • when false - package omit installing postgres and relly that it is already in place
  • debugMode - used for streaming terminal logs during executing start and stop methods

2. Stop Postgres

import {stop} from '@shelf/postgres-local';

await stop({version: 14});

Publish

$ git checkout master
$ yarn version
$ yarn publish
$ git push origin master --tags

License

MIT © Shelf