bun | ||
src | ||
test | ||
.gitignore | ||
.prettierrc.cjs | ||
.tool-versions | ||
bun.lockb | ||
docker-compose.yml | ||
jsconfig.json | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md | ||
spago.lock | ||
spago.yaml |
postgresql
Purescript PostgreSQL driver
Table of Contents
Getting Started
Install with:
> spago install postgresql
# (npm | yarn | bun) install pg
Next, create a pool Config
object:
-- from a connection string:
pgConfig =
{ connectionString: "postgresql://postgres:password@localhost:5432/postgres"
}
-- or explicitly:
pgConfig =
{ username: "postgres"
, password: "password"
, host: "localhost"
, port: 5432
, database: "postgres"
}
Then in an Aff
, use runPostgres
to connect to the database and execute
queries:
module Main where
import Prelude
import Effect (Effect)
import Effect.Class (liftEffect)
import Effect.Aff (launchAff_)
import Effect.Console (log)
import Control.Monad.Postgres (runPostgres, query)
import Effect.Postgres.Error.Except as PG.X
main :: Effect Unit
main =
launchAff_ do
msg <- PG.X.run $ runPostgres pgConfig $ query "select 'hello, world!'"
liftEffect $ log msg -- logs 'hello, world!'
runPostgres
creates a connection pool, then executes a
PostgresT
monad, which is an Aff
with access
to a connection pool.
runPostgres :: forall a. <partial config> -> PostgresT Aff a -> Aff a
query
accepts any q
that can be turned into a query
(here just a String
), and unmarshals the result into a
destination type r
.
query
is from MonadSession
, which PostgresT
implements:
class MonadSession m where
query :: forall q r. AsQuery q => FromRows r => q -> m r
-- ...
Data
Scalar values are serialized & deserialized using the Serialize
/ Deserialize
typeclasses.
Implemented for Int
, String
, DateTime
, Buffer
, BigInt
, Boolean
, Number
, Array
, Range
s, Maybe
, Null
and Unit
.
There aren't any typeclass instances for unmarshalling rows by design. The rationale: as apps grow we often need to ask more of a relational database than just CRUD operations. Queries tend to be somewhat living, with joins and columns being added and removed, so it should be easy to modify queries and reflect the change in the purescript type they're unmarshalled into.
The lib does this by transforming the js row array Array<Array<unknown>>
with FromRows
("how many rows do you expect?"), then each row with FromRow
, then each value with Deserialize
.
Starting with querying directly into the loose rows as Array (Array Raw)
:
a :: Array (Array Raw) <- query "select a, b, c from (values (1, 'foo', true), (4, 'bar', false)) as foo(a, b, c)"
liftEffect $ log $ show a -- [[1, "foo", true], [4, "bar", false]]
We can tell the query to deserialize the rows as Int /\ String /\ Boolean
(postgres shape of (int, text, boolean)
):
a :: Array (Int /\ String /\ Boolean) <- query "select a, b, c from (values (1, 'foo', true), (4, 'bar', false)) as foo(a, b, c)"
liftEffect $ log $ show a -- [Tuple 1 (Tuple "foo" true), Tuple 1 (Tuple "foo" true)]
From there we could unmarshal to Maybe
to get 0 or 1, or directly into the row type if expect at least 1 row:
a :: Maybe (Int /\ String /\ Boolean) <- query "select a, b, c from (values (1, 'foo', true), (4, 'bar', false)) as foo(a, b, c)"
liftEffect $ log $ show a -- Just (Tuple 1 (Tuple "foo" true))
b :: Int /\ String /\ Boolean <- query "select 1, 'foo', true"
liftEffect $ log $ show b -- Tuple 1 (Tuple "foo" true)
c :: Maybe (Int /\ String /\ Boolean) <- query "select null, null, null limit 0"
liftEffect $ log $ show c -- Nothing
FromRows row
supports Array row
, Maybe row
or just row
(failing if 0 returned).
FromRow row
supports Array a
, Tuple a b
, Maybe a
, or a
(where a
/ b
are Deserialize
)
The idea is that you can deserialize query results directly to the purescript type you care about:
a :: Int <- query "select 1"
- because there's no outer
Array
, we're saying this just returns 1 row. because there's no innerArray
, we're saying the row just has 1 value; the int!
- because there's no outer
a :: Array Int <- query "select foo.a from (values (1), (2), (3)) as foo(a)"
- Now there's an outer
Array
, so we expect the query to yield multiple rows of shape(int)
- Now there's an outer
a :: Array (Maybe Int) <- query "select foo.a from (values (1), (null), (3)) as foo(a)"
- Some of them are
NULL
!
- Some of them are
a :: Int /\ Int <- query "select 1, 2"
- 1 row of
(int, int)
- 1 row of
a :: Array (Int /\ String) <- query "select id, email from users"
- Multiple rows of
(int, string)
- Multiple rows of
a :: Maybe (String /\ String /\ String) <- query $ "select first_name, last_name, email from users where id = $1" /\ userId
- 0 or 1 rows of
(text, text, text)
- 0 or 1 rows of
Data - Ranges
Postgres ranges are represented with Range
.
Range
s can be created with:
mempty
- an unbounded rangeRange.lt
a
-(,a)
Range.lte
a
-(,a]
Range.gt
a
-(a,)
Range.gte
a
-[a,)
and combined with append
:
mempty <> lt 100 -- (,100)
gte 10 <> lt 100 -- [10,100)
Queries
Queries can be executed with any type that implements AsQuery
,
which converts it into a Query
:
newtype Query = Query { text :: String, values :: Array Raw, name :: Maybe String }
class AsQuery a where
asQuery :: a -> Effect Query
AsQuery
is implemented for:
Query
String
String /\ n
wheren
is:
Queries - Builder
For complex parameterized queries, there is a provided Query.Builder
:
runPostgres {} do
exec_ "create table person (id int, first_name text, last_name text, age int, born timestamptz);"
exec_
$ Query.Builder.build
$ do
id <- Query.Builder.param 1
firstName <- Query.Builder.param "Henry"
lastName <- Query.Builder.param "Cavill"
age <- Query.Builder.param 38
born <- Query.Builder.param "1985-05-05"
pure
$ intercalate "\n"
[ "insert into person (id, first_name, last_name, age, born)"
, "values"
, "("
, intercalate ", " [id, firstName, lastName, age, born])
, ")"
]
Query.Builder.param
accepts any Rep
value and returns a string (ex. "$2"
)
that will reference that value in the query.
Query.Builder.build
renders the query to Query
Errors
Errors are wrapped in Error
:
data Error
= Deserializing Query Foreign.MultipleErrors
| Serializing Foreign.MultipleErrors
| Executing Query Effect.Error
| Connecting Effect.Error
| Disconnecting Effect.Error
| Other Effect.Error
Most operations in this library return a Except
, which is just
ExceptT
pinned to NonEmptyArray Error
.
This can be unlifted to Aff
with Except.run
.
Monads
Monads - PostgresT
PostgresT
is a monadic context with a connection Pool
. It allows running transaction
s, simple queries and more.
Running in Aff
main :: Effect Unit
main =
launchAff_ do
hi <- PG.X.run $ runPostgres {} $ query "select 'hi!'"
liftEffect $ log hi
Executing a transaction
dbMain :: PostgresT Aff Unit
dbMain = do
transaction do
exec_ """
create table persons
( id int primary key generated always as identity
, name text not null unique
);
"""
exec_ $ "insert into persons (name) values ($1);" /\ "Henry"
pure unit
Simple queries
dbMain :: PostgresT Aff Int
dbMain = exec_ $ "insert into persons (name) values ($1);" /\ "Sarah"
-- equivalent to:
-- dbMain = session $ exec_ ...
Executing cursor queries
dbMain :: PostgresT Aff Int
dbMain =
cursor @(Int /\ String) "people_cursor" "select id, name from persons" do
a <- fetchOne -- Just (1 /\ "Henry")
b <- fetchOne -- Just (2 /\ "Sarah")
void $ move (MoveRelative -2)
c <- fetchAll -- [1 /\ "Henry", 2 /\ "Sarah"]
d <- fetchOne -- Nothing
Monads - SessionT
SessionT
is a context that can run queries using a specific Client
.
Sessions can be started in PostgresT
, which will ask the Pool
for a Client
,
then release the Client
after the session completes.
Within sessions, queries can be performed with query
, exec
and exec_
.
Monads - CursorT
CursorT
is a transaction SessionT
with access to a named server-side cursor.
node-postgres
style
You may also choose to use the Aff
API directly, which closely mirrors
the api of node-postgres
:
Client
- create with
Client.make
orClient.connected
- execute queries with
Client.query
,Client.queryRaw
orClient.exec
- release with
Client.end
- create with
Pool
- create with
Pool.make
- issue clients with
Pool.connect
- release clients with
Pool.release
orPool.destroy
- release with
Pool.end
- create with