Opaleye.Manipulation

Inserts, updates and deletes

Please note that you currently you can only INSERT or UPDATE with constant values, not the result of SELECTS. That is, you can generate SQL of the form

INSERT INTO thetable (John, 1);

but not

INSERT INTO thetable
   SELECT John,
   (SELECT num FROM thetable ORDER BY num DESC LIMIT 1) + 1;

Documentation

runInsertMany

Arguments

:: Connection

-> Table columns columns'

Table to insert into

-> [columns]

Rows to insert

-> IO Int64

Number of rows inserted

Insert rows into a table

runInsertManyReturning

Arguments

:: Default QueryRunner returned haskells

=> Connection

-> Table columnsW columnsR

Table to insert into

-> [columnsW]

Rows to insert

-> (columnsR -> returned)

Function f to apply to the inserted rows

-> IO [haskells]

Returned rows after f has been applied

Insert rows into a table and return a function of the inserted rows

runInsertManyReturning's use of the Default typeclass means that the compiler will have trouble inferring types. It is strongly recommended that you provide full type signatures when using runInsertManyReturning.

runUpdate

Arguments

:: Connection

-> Table columnsW columnsR

Table to update

-> (columnsR -> columnsW)

Update function to apply to chosen rows

-> (columnsR -> Column PGBool)

Predicate function f to choose which rows to update. runUpdate will update rows for which f returns TRUE and leave unchanged rows for which f returns FALSE.

-> IO Int64

The number of updated rows

Update rows in a table

runUpdateReturning

Arguments

:: Default QueryRunner returned haskells

=> Connection

-> Table columnsW columnsR

Table to update

-> (columnsR -> columnsW)

Update function to apply to chosen rows

-> (columnsR -> Column PGBool)

Predicate function f to choose which rows to update. runUpdate will update rows for which f returns TRUE and leave unchanged rows for which f returns FALSE.

-> (columnsR -> returned)

Functon g to apply to the updated rows

-> IO [haskells]

Returned rows after g has been applied

Update rows in a table and return a function of the updated rows

runUpdateReturning's use of the Default typeclass means that the compiler will have trouble inferring types. It is strongly recommended that you provide full type signatures when using runInsertReturning.

runDelete

Arguments

:: Connection

-> Table a columnsR

Table to delete rows from

-> (columnsR -> Column PGBool)

Predicate function f to choose which rows to delete. runDelete will delete rows for which f returns TRUE and leave unchanged rows for which f returns FALSE.

-> IO Int64

The number of deleted rows

Delete rows from a table

runInsertReturningExplicit :: QueryRunner returned haskells -> Connection -> Table columnsW columnsR -> columnsW -> (columnsR -> returned) -> IO [haskells]

You probably don't need this, but can just use runInsertReturning instead. You only need it if you want to run an INSERT RETURNING statement but need to be explicit about the QueryRunner.

runInsertManyReturningExplicit :: QueryRunner returned haskells -> Connection -> Table columnsW columnsR -> [columnsW] -> (columnsR -> returned) -> IO [haskells]

You probably don't need this, but can just use runInsertManyReturning instead. You only need it if you want to run an UPDATE RETURNING statement but need to be explicit about the QueryRunner.

runUpdateReturningExplicit :: QueryRunner returned haskells -> Connection -> Table columnsW columnsR -> (columnsR -> columnsW) -> (columnsR -> Column PGBool) -> (columnsR -> returned) -> IO [haskells]

You probably don't need this, but can just use runUpdateReturning instead. You only need it if you want to run an UPDATE RETURNING statement but need to be explicit about the QueryRunner.

runInsert :: Connection -> Table columns columns' -> columns -> IO Int64

Returns the number of rows inserted

This will be deprecated in a future release. Use runInsertMany instead.

runInsertReturning :: Default QueryRunner returned haskells => Connection -> Table columnsW columnsR -> columnsW -> (columnsR -> returned) -> IO [haskells]

runInsertReturning's use of the Default typeclass means that the compiler will have trouble inferring types. It is strongly recommended that you provide full type signatures when using runInsertReturning.

This will be deprecated in a future release. Use runInsertManyReturning instead.

arrangeInsert :: Table columns a -> columns -> SqlInsert

For internal use only. Do not use. Will be removed in a subsequent release.

arrangeInsertSql :: Table columns a -> columns -> String

For internal use only. Do not use. Will be removed in a subsequent release.

arrangeInsertMany :: Table columns a -> NonEmpty columns -> SqlInsert

For internal use only. Do not use. Will be removed in a subsequent release.

arrangeInsertManySql :: Table columns a -> NonEmpty columns -> String

For internal use only. Do not use. Will be removed in a subsequent release.

arrangeUpdate :: Table columnsW columnsR -> (columnsR -> columnsW) -> (columnsR -> Column PGBool) -> SqlUpdate

For internal use only. Do not use. Will be removed in a subsequent release.

arrangeUpdateSql :: Table columnsW columnsR -> (columnsR -> columnsW) -> (columnsR -> Column PGBool) -> String

For internal use only. Do not use. Will be removed in a subsequent release.

arrangeDelete :: Table a columnsR -> (columnsR -> Column PGBool) -> SqlDelete

For internal use only. Do not use. Will be removed in a subsequent release.

arrangeDeleteSql :: Table a columnsR -> (columnsR -> Column PGBool) -> String

For internal use only. Do not use. Will be removed in a subsequent release.

arrangeInsertManyReturning :: Unpackspec returned ignored -> Table columnsW columnsR -> NonEmpty columnsW -> (columnsR -> returned) -> Returning SqlInsert

For internal use only. Do not use. Will be removed in a subsequent release.

arrangeInsertManyReturningSql :: Unpackspec returned ignored -> Table columnsW columnsR -> NonEmpty columnsW -> (columnsR -> returned) -> String

For internal use only. Do not use. Will be removed in a subsequent release.

arrangeUpdateReturning :: Unpackspec returned ignored -> Table columnsW columnsR -> (columnsR -> columnsW) -> (columnsR -> Column PGBool) -> (columnsR -> returned) -> Returning SqlUpdate

For internal use only. Do not use. Will be removed in a subsequent release.

arrangeUpdateReturningSql :: Unpackspec returned ignored -> Table columnsW columnsR -> (columnsR -> columnsW) -> (columnsR -> Column PGBool) -> (columnsR -> returned) -> String

For internal use only. Do not use. Will be removed in a subsequent release.

data Unpackspec columns columns'

Instances

Profunctor Unpackspec

Methods

dimap :: (a -> b) -> (c -> d) -> Unpackspec b c -> Unpackspec a d

lmap :: (a -> b) -> Unpackspec b c -> Unpackspec a c

rmap :: (b -> c) -> Unpackspec a b -> Unpackspec a c

(#.) :: Coercible * c b => (b -> c) -> Unpackspec a b -> Unpackspec a c

(.#) :: Coercible * b a => Unpackspec b c -> (a -> b) -> Unpackspec a c

ProductProfunctor Unpackspec

Methods

empty :: Unpackspec () ()

(***!) :: Unpackspec a b -> Unpackspec a' b' -> Unpackspec (a, a') (b, b')

SumProfunctor Unpackspec

Methods

(+++!) :: Unpackspec a b -> Unpackspec a' b' -> Unpackspec (Either a a') (Either b b')

Default Unpackspec (Column a) (Column a)

Methods

def :: Unpackspec (Column a) (Column a)

Functor (Unpackspec a)

Methods

fmap :: (a -> b) -> Unpackspec a a -> Unpackspec a b

(<$) :: a -> Unpackspec a b -> Unpackspec a a

Applicative (Unpackspec a)

Methods

pure :: a -> Unpackspec a a

(<*>) :: Unpackspec a (a -> b) -> Unpackspec a a -> Unpackspec a b

(*>) :: Unpackspec a a -> Unpackspec a b -> Unpackspec a b

(<*) :: Unpackspec a a -> Unpackspec a b -> Unpackspec a a