Nonbili.Postgres.Pool

data Pool

pg.Pool object.

data Client

Pooled client boject.

newPool :: Config -> Effect Pool

Create a new pool with configuration.

connect :: Pool -> Aff Client

Acquire a client from the pool. Remember to release the client after, otherwise pool clients will be exhausted quickly. It's recommend to use withTransaction, which handles releasing client for you.

end :: Pool -> Aff Unit

Disconnect all active clients. Useful at the end of a script to exit the process.

release :: Client -> Aff Unit

Release a client. When using withTransaction, no need to release manually.

withTransaction :: forall a. Pool -> (Client -> Aff a) -> Aff a

Acquire a client from the pool, then run queries as a transaction.

execute :: forall p. ToQueryParams p => Client -> String -> p -> Aff Unit

Same as query, but ignore all return values.

type Result a = Either String { rowCount :: Int, rows :: Array a }

• rows - decodeJson is used to get a
• rowCount - number of rows processed by the last command See https://node-postgres.com/api/result.

query :: forall a p. ToQueryParams p => DecodeJson a => Client -> String -> p -> Aff (Result a)

pg will construct SQL from provided query string and params. Check ToQueryParams for supported params.