Module

Effect.Aff.Postgres.Client

Package: purescript-postgresql
Repository: cakekindel/purescript-postgresql

#connected Source

connected :: forall r missing trash. Union r missing (Config trash) => Record r -> Except Aff Client

Create a client and immediately connect it to the database

The config parameter r is Config with all keys optional.

This is a shorthand for (voidRight <*> connect) =<< liftEffect (make cfg)

#connect Source

connect :: Client -> Aff Unit

Connects the client to the database

https://node-postgres.com/apis/client#clientconnect

#end Source

end :: Client -> Except Aff Unit

Disconnects the client from the database

https://node-postgres.com/apis/client#clientend

#exec Source

exec :: forall q. AsQuery q => q -> Client -> Except Aff Int

Performs a query that we expect to not yield any rows, returning the number of rows affected by the statement.

https://node-postgres.com/apis/client#clientquery

#execWithStdin Source

execWithStdin :: String -> Client -> Except Effect (Writable ())

#queryWithStdout Source

queryWithStdout :: String -> Client -> Except Effect (Readable ())

#query Source

query :: forall q r. AsQuery q => FromRows r => q -> Client -> Except Aff r

Performs a query that we expect to yield rows, returning them unmarshalled into destination type r.

https://node-postgres.com/apis/client#clientquery

#queryRaw Source

queryRaw :: forall q. AsQuery q => q -> Client -> Except Aff Result

Performs a query, returning the raw Result object

https://node-postgres.com/apis/client#clientquery

#__connect Source

__connect :: Client -> Effect (Promise Unit)

FFI binding to Client#connect

#__end Source

__end :: Client -> Effect (Promise Unit)

FFI binding to Client#end

#__query Source

__query :: QueryRaw -> Client -> Effect (Promise Result)

FFI binding to Client#query

#__execStreamStdin Source

__execStreamStdin :: String -> Client -> Effect (Writable ())

FFI binding to import('pg-copy-streams').from

#__execStreamStdout Source

__execStreamStdout :: String -> Client -> Effect (Readable ())

FFI binding to import('pg-copy-streams').to

Re-exports from Effect.Postgres.Client

#NotificationRaw Source

type NotificationRaw = { channel :: String, payload :: Nullable String, processId :: Number }

FFI

#Notification Source

type Notification = { channel :: String, payload :: Maybe String, processId :: Number }

A notification raised by NOTIFY

#Config Source

type Config :: Row Type -> Row Typetype Config r = (applicationName :: String, connectionString :: String, connectionTimeout :: Milliseconds, database :: String, host :: String, idleInTransactionTimeout :: Milliseconds, password :: String, port :: Number, queryTimeout :: Milliseconds, statementTimeout :: Milliseconds, user :: String | r)

Client connection config

#ClientConfigRaw Source

data ClientConfigRaw

FFI

#Client Source

data Client

Database connection

#notificationE Source

notificationE :: EventHandle Client (Notification -> Effect Unit) (EffectFn1 NotificationRaw Unit)

https://node-postgres.com/apis/client#notification

#noticeE Source

noticeE :: EventHandle1 Client Error

https://node-postgres.com/apis/client#notice

#make Source

make :: forall @r @missing @trash. Union r missing (Config trash) => Record r -> Effect Client

Creates a new client, not yet connected to the database.

The config parameter r is Config with all keys optional.

https://node-postgres.com/apis/client#new-client

#errorE Source

errorE :: EventHandle1 Client Error

https://node-postgres.com/apis/client#error

#endE Source

endE :: EventHandle0 Client

https://node-postgres.com/apis/client#end

#__uncfg Source

__uncfg :: { unwrapMillis :: Milliseconds -> Number } -> Foreign -> ClientConfigRaw

FFI

#__make Source

__make :: ClientConfigRaw -> Effect Client

FFI