Safe Haskell	None
Language	Haskell2010

Opaleye.Manipulation

Contents

Manipulation functions
Explicit versions
Deprecated versions
Other

Description

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;

Synopsis

Manipulation functions

runInsertMany Source #

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 Source #

Arguments

:: Default QueryRunner columnsReturned haskells
=> Connection
-> Table columnsW columnsR	Table to insert into
-> [columnsW]	Rows to insert
-> (columnsR -> columnsReturned)	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 Source #

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 rows updated

Update rows in a table.

Be careful: providing Nothing to a column created by optional updates the column to its default value. Many users have been confused by this because they assume it means that the column is to be left unchanged.

runUpdateReturning Source #

Arguments

:: Default QueryRunner columnsReturned 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 -> columnsReturned)	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

Be careful: providing Nothing to a column created by optional updates the column to its default value. Many users have been confused by this because they assume it means that the column is to be left unchanged.

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 Source #

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 rows deleted

Delete rows from a table

Explicit versions

runInsertReturningExplicit :: QueryRunner columnsReturned haskells -> Connection -> Table columnsW columnsR -> columnsW -> (columnsR -> columnsReturned) -> IO [haskells] Source #

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 columnsReturned haskells -> Connection -> Table columnsW columnsR -> [columnsW] -> (columnsR -> columnsReturned) -> IO [haskells] Source #

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 columnsReturned haskells -> Connection -> Table columnsW columnsR -> (columnsR -> columnsW) -> (columnsR -> Column PGBool) -> (columnsR -> columnsReturned) -> IO [haskells] Source #

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.

Deprecated versions

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

Returns the number of rows inserted

This will be deprecated in version 0.6. Use runInsertMany instead.

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

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 version 0.6. Use runInsertManyReturning instead.

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