Skip to content

Commit

Permalink
Make it easier to find how to execute Pg actions (#663)
Browse files Browse the repository at this point in the history
  • Loading branch information
LaurentRDC committed Jul 9, 2024
1 parent ccbea07 commit b2e83c4
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
4 changes: 4 additions & 0 deletions beam-postgres/ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

* Better error messages on column type mismatches (#696).

## Documentation

* Make `runBeamPostgres` and `runBeamPostgresDebug` easier to find (#663).

# 0.5.3.1

## Added features
Expand Down
5 changes: 3 additions & 2 deletions beam-postgres/Database/Beam/Postgres.hs
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ module Database.Beam.Postgres
( -- * Beam Postgres backend
Postgres(..), Pg, liftIOWithHandle

-- ** Executing actions against the backend
, runBeamPostgres, runBeamPostgresDebug

-- ** Postgres syntax
, PgCommandSyntax, PgSyntax
, PgSelectSyntax, PgInsertSyntax
Expand All @@ -41,8 +44,6 @@ module Database.Beam.Postgres

, module Database.Beam.Postgres.PgSpecific

, runBeamPostgres, runBeamPostgresDebug

-- ** Postgres extension support
, PgExtensionEntity, IsPgExtension(..)
, pgCreateExtension, pgDropExtension
Expand Down
2 changes: 2 additions & 0 deletions beam-postgres/Database/Beam/Postgres/Connection.hs
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,8 @@ data FetchMode
-- @beam-postgres@ also provides functions that let you run queries without
-- 'MonadBeam'. These functions may be more efficient and offer a conduit
-- API. See "Database.Beam.Postgres.Conduit" for more information.
--
-- You can execute 'Pg' actions using 'runBeamPostgres' or 'runBeamPostgresDebug'.
newtype Pg a = Pg { runPg :: F PgF a }
deriving (Monad, Applicative, Functor, MonadFree PgF)

Expand Down

0 comments on commit b2e83c4

Please sign in to comment.