/effect-pg

node-pg wrapper for effect-ts

Primary LanguageTypeScriptMIT LicenseMIT

effect-pg

node-pg wrapper for effect.

Under development

Quickstart

Install the package using

pnpm install effect-pg effect

The following example assumes you have a postgres running. Setup the environment variables as follows.

$ export POSTGRES_USER=<USER>
$ export POSTGRES_PASSWORD=<PASSWORD>
$ export POSTGRES_DATABASE=<PASSWORD>

Optionally, also set POSTGRES_HOST and POSTGRES_NAME. The example below will create a new users table, insert a single row and fetch the row. The persisted row is immediately fetched and logged out.

import { Schema } from "@effect/schema"
import { Effect, pipe } from "effect"
import { PgLayer, PgQuery } from "effect-pg"

const User = Schema.Struct({ name: Schema.String })

const createUsersTable = PgQuery.all(
  "CREATE TABLE IF NOT EXISTS users (name TEXT NOT NULL)"
)
const insertUser = PgQuery.all("INSERT INTO users (name) VALUES ($1)")
const selectUser = PgQuery.one("SELECT * FROM users", User)

pipe(
  createUsersTable(),
  Effect.flatMap(() => insertUser("patrik")),
  Effect.flatMap(() => selectUser()),
  Effect.flatMap((result) => Effect.log(`User: ${JSON.stringify(result)}`)),
  Effect.provide(PgLayer.Client),
  Effect.provide(PgLayer.setConfig()),
  Effect.runPromise
)

Contributing

Local development

Spawn a postgres instance.

$ docker run -d -p 5432:5432 --name test-postgres -e POSTGRES_PASSWORD=test -e POSTGRES_USER=test postgres

Create a .env file.

TEST_POSTGRES_USER=test
TEST_POSTGRES_DATABASE=test
TEST_POSTGRES_PASSWORD=test

Run tests.

pnpm test