Database.PostgreSQL.Store

Errand

data Errand a

An interaction with the database

Instances

Monad Errand

Methods

(>>=) :: Errand a -> (a -> Errand b) -> Errand b

(>>) :: Errand a -> Errand b -> Errand b

return :: a -> Errand a

fail :: String -> Errand a

Functor Errand

Methods

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

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

Applicative Errand

Methods

pure :: a -> Errand a

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

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

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

MonadIO Errand

Methods

liftIO :: IO a -> Errand a

MonadError ErrandError Errand

Methods

throwError :: ErrandError -> Errand a

catchError :: Errand a -> (ErrandError -> Errand a) -> Errand a

runErrand :: Connection -> Errand a -> IO (Either ErrandError a)

Run an errand.

execute :: Query a -> Errand Result

Execute a query and return the internal raw result.

execute' :: Query a -> Errand Int

Same as execute but instead of a Result it returns the number of affected rows.

query :: Entity a => Query a -> Errand [a]

Execute a query and process its result set.

queryWith :: Query a -> RowParser a -> Errand [a]

Execute a query and process its result set using the provided RowParser.

insert :: TableEntity a => a -> Errand Bool

Insert a row into a Table.

insertMany :: TableEntity a => [a] -> Errand Int

Insert many rows into a Table.

deleteAll :: TableEntity a => proxy a -> Errand Int

Delete all rows of a Table.

findAll :: TableEntity a => Errand [a]

Find every row of a Table.

create :: TableEntity a => proxy a -> Errand ()

Create the given Table type.

Query

data Query a

Query

Constructors

Query

Fields

• queryStatement :: ByteString
• queryParams :: [TypedValue]

Instances

Eq (Query a)

Methods

(==) :: Query a -> Query a -> Bool

(/=) :: Query a -> Query a -> Bool

Ord (Query a)

Methods

compare :: Query a -> Query a -> Ordering

(<) :: Query a -> Query a -> Bool

(<=) :: Query a -> Query a -> Bool

(>) :: Query a -> Query a -> Bool

(>=) :: Query a -> Query a -> Bool

max :: Query a -> Query a -> Query a

min :: Query a -> Query a -> Query a

Show (Query a)

Methods

showsPrec :: Int -> Query a -> ShowS

show :: Query a -> String

showList :: [Query a] -> ShowS

FromQueryBuilder (Query a)

Methods

buildQuery :: QueryBuilder -> Query a

pgsq :: QuasiQuoter

Generate queries conveniently. See BuildQuery to find out which types can be produced.

castQuery :: Query a -> Query b

Cast the query's result type.

Entity

class Entity a where

An entity that is used as a parameter or result of a query.

Methods

insertEntity :: a -> QueryBuilder

Insert an instance of a into the query.

insertEntity :: (GenericEntity a, GEntity (AnalyzeEntity a)) => a -> QueryBuilder

Insert an instance of a into the query.

parseEntity :: RowParser a

Retrieve an instance of a from the result set.

parseEntity :: (GenericEntity a, GEntity (AnalyzeEntity a)) => RowParser a

Retrieve an instance of a from the result set.

Instances

Entity Bool

boolean

Methods

insertEntity :: Bool -> QueryBuilder

parseEntity :: RowParser Bool

Entity Double

Any floating-point number

Methods

insertEntity :: Double -> QueryBuilder

parseEntity :: RowParser Double

Entity Float

Any floating-point number

Methods

insertEntity :: Float -> QueryBuilder

parseEntity :: RowParser Float

Entity Int

Any integer

Methods

insertEntity :: Int -> QueryBuilder

parseEntity :: RowParser Int

Entity Int8

Any integer

Methods

insertEntity :: Int8 -> QueryBuilder

parseEntity :: RowParser Int8

Entity Int16

Any integer

Methods

insertEntity :: Int16 -> QueryBuilder

parseEntity :: RowParser Int16

Entity Int32

Any integer

Methods

insertEntity :: Int32 -> QueryBuilder

parseEntity :: RowParser Int32

Entity Int64

Any integer

Methods

insertEntity :: Int64 -> QueryBuilder

parseEntity :: RowParser Int64

Entity Integer

Any integer

Methods

insertEntity :: Integer -> QueryBuilder

parseEntity :: RowParser Integer

Entity Word

Any unsigned integer

Methods

insertEntity :: Word -> QueryBuilder

parseEntity :: RowParser Word

Entity Word8

Any unsigned integer

Methods

insertEntity :: Word8 -> QueryBuilder

parseEntity :: RowParser Word8

Entity Word16

Any unsigned integer

Methods

insertEntity :: Word16 -> QueryBuilder

parseEntity :: RowParser Word16

Entity Word32

Any unsigned integer

Methods

insertEntity :: Word32 -> QueryBuilder

parseEntity :: RowParser Word32

Entity Word64

Any unsigned integer

Methods

insertEntity :: Word64 -> QueryBuilder

parseEntity :: RowParser Word64

Entity ByteString

bytea - byte array encoded in hex format

Methods

insertEntity :: ByteString -> QueryBuilder

parseEntity :: RowParser ByteString

Entity ByteString

bytea - byte array encoded in hex format

Methods

insertEntity :: ByteString -> QueryBuilder

parseEntity :: RowParser ByteString

Entity Scientific

Any numeric type

Methods

insertEntity :: Scientific -> QueryBuilder

parseEntity :: RowParser Scientific

Entity String

char, varchar or text - UTF-8 encoded

Methods

insertEntity :: String -> QueryBuilder

parseEntity :: RowParser String

Entity Text

char, varchar or text - UTF-8 encoded

Methods

insertEntity :: Text -> QueryBuilder

parseEntity :: RowParser Text

Entity Value

json or jsonb

Methods

insertEntity :: Value -> QueryBuilder

parseEntity :: RowParser Value

Entity Text

char, varchar or text - UTF-8 encoded

Methods

insertEntity :: Text -> QueryBuilder

parseEntity :: RowParser Text

Entity Natural

Any unsigned integer

Methods

insertEntity :: Natural -> QueryBuilder

parseEntity :: RowParser Natural

Entity TypedValue

Typed column value

Methods

insertEntity :: TypedValue -> QueryBuilder

parseEntity :: RowParser TypedValue

Entity Value

Untyped column value

Methods

insertEntity :: Value -> QueryBuilder

parseEntity :: RowParser Value

Entity QueryBuilder

QueryBuilder

Methods

insertEntity :: QueryBuilder -> QueryBuilder

parseEntity :: RowParser QueryBuilder

Entity a => Entity (Maybe a)

A value which may normally not be NULL.

Methods

insertEntity :: Maybe a -> QueryBuilder

parseEntity :: RowParser (Maybe a)

(Entity a, Entity b) => Entity (a, b)

2 result entities in sequence

Methods

insertEntity :: (a, b) -> QueryBuilder

parseEntity :: RowParser (a, b)

(Entity a, Entity b, Entity c) => Entity (a, b, c)

3 result entities in sequence

Methods

insertEntity :: (a, b, c) -> QueryBuilder

parseEntity :: RowParser (a, b, c)

(Entity a, Entity b, Entity c, Entity d) => Entity (a, b, c, d)

4 result entities in sequence

Methods

insertEntity :: (a, b, c, d) -> QueryBuilder

parseEntity :: RowParser (a, b, c, d)

(Entity a, Entity b, Entity c, Entity d, Entity e) => Entity (a, b, c, d, e)

5 result entities in sequence

Methods

insertEntity :: (a, b, c, d, e) -> QueryBuilder

parseEntity :: RowParser (a, b, c, d, e)

(Entity a, Entity b, Entity c, Entity d, Entity e, Entity f) => Entity (a, b, c, d, e, f)

6 result entities in sequence

Methods

insertEntity :: (a, b, c, d, e, f) -> QueryBuilder

parseEntity :: RowParser (a, b, c, d, e, f)

(Entity a, Entity b, Entity c, Entity d, Entity e, Entity f, Entity g) => Entity (a, b, c, d, e, f, g)

7 result entities in sequence

Methods

insertEntity :: (a, b, c, d, e, f, g) -> QueryBuilder

parseEntity :: RowParser (a, b, c, d, e, f, g)

Tables

class Entity a => TableEntity a where

Classify a type which can be used as a table.

Methods

describeTableType :: proxy a -> Table

Describe the table type.

describeTableType :: GenericTable a => proxy a -> Table

Describe the table type.

class Entity a => ColumnEntity a where

Classify a type which can be used as a column in a table.

Minimal complete definition

describeColumnType

Methods

describeColumnType :: proxy a -> ColumnType

Describe the column type

Instances

ColumnEntity Bool

Methods

describeColumnType :: proxy Bool -> ColumnType

ColumnEntity Double

Methods

describeColumnType :: proxy Double -> ColumnType

ColumnEntity Float

Methods

describeColumnType :: proxy Float -> ColumnType

ColumnEntity Int

Methods

describeColumnType :: proxy Int -> ColumnType

ColumnEntity Int8

Methods

describeColumnType :: proxy Int8 -> ColumnType

ColumnEntity Int16

Methods

describeColumnType :: proxy Int16 -> ColumnType

ColumnEntity Int32

Methods

describeColumnType :: proxy Int32 -> ColumnType

ColumnEntity Int64

Methods

describeColumnType :: proxy Int64 -> ColumnType

ColumnEntity Integer

Methods

describeColumnType :: proxy Integer -> ColumnType

ColumnEntity Word

Methods

describeColumnType :: proxy Word -> ColumnType

ColumnEntity Word8

Methods

describeColumnType :: proxy Word8 -> ColumnType

ColumnEntity Word16

Methods

describeColumnType :: proxy Word16 -> ColumnType

ColumnEntity Word32

Methods

describeColumnType :: proxy Word32 -> ColumnType

ColumnEntity Word64

Methods

describeColumnType :: proxy Word64 -> ColumnType

ColumnEntity ByteString

Methods

describeColumnType :: proxy ByteString -> ColumnType

ColumnEntity ByteString

Methods

describeColumnType :: proxy ByteString -> ColumnType

ColumnEntity Scientific

Methods

describeColumnType :: proxy Scientific -> ColumnType

ColumnEntity String

Methods

describeColumnType :: proxy String -> ColumnType

ColumnEntity Text

Methods

describeColumnType :: proxy Text -> ColumnType

ColumnEntity Value

Methods

describeColumnType :: proxy Value -> ColumnType

ColumnEntity Text

Methods

describeColumnType :: proxy Text -> ColumnType

ColumnEntity Natural

Methods

describeColumnType :: proxy Natural -> ColumnType

ColumnEntity a => ColumnEntity (Maybe a)

Methods

describeColumnType :: proxy (Maybe a) -> ColumnType

data Table

Description of a table

Constructors

Table

Fields

• tableName :: ByteString

  Table name

• tableCols :: [Column]

  Table columns

data ColumnType

Description of a column type

Constructors

ColumnType

Fields

• colTypeName :: ByteString

  Type name

• colTypeNotNull :: Bool

  NOT NULL constraint present?

• colTypeCheck :: Maybe (ByteString -> QueryBuilder)

  Produce a check statement body when given a column name

data Column

Desciption of a column

Constructors

Column

Fields

• colName :: ByteString

  Column name

• colType :: ColumnType

  Column type

Errors

data ErrandError

Error during errand

Constructors

NoResult

No Result has been returned.

UserError String

A user has thrown an error.

ExecError ExecStatus ErrorCode ByteString ByteString ByteString

Query execution failed.

ParseError RowError

Result processing failed.

Instances

Eq ErrandError

Methods

(==) :: ErrandError -> ErrandError -> Bool

(/=) :: ErrandError -> ErrandError -> Bool

Show ErrandError

Methods

showsPrec :: Int -> ErrandError -> ShowS

show :: ErrandError -> String

showList :: [ErrandError] -> ShowS

MonadError ErrandError Errand

Methods

throwError :: ErrandError -> Errand a

catchError :: Errand a -> (ErrandError -> Errand a) -> Errand a

data ErrorCode

Error codes

Constructors

UnknownErrorCause ByteString

IntegrityViolation

RestrictViolation

NotNullViolation

ForeignKeyViolation

UniqueViolation

CheckViolation

ExclusionViolation

Instances

Eq ErrorCode

Methods

(==) :: ErrorCode -> ErrorCode -> Bool

(/=) :: ErrorCode -> ErrorCode -> Bool

Show ErrorCode

Methods

showsPrec :: Int -> ErrorCode -> ShowS

show :: ErrorCode -> String

showList :: [ErrorCode] -> ShowS

data ExecStatus :: *

Instances

Enum ExecStatus

Methods

succ :: ExecStatus -> ExecStatus

pred :: ExecStatus -> ExecStatus

toEnum :: Int -> ExecStatus

fromEnum :: ExecStatus -> Int

enumFrom :: ExecStatus -> [ExecStatus]

enumFromThen :: ExecStatus -> ExecStatus -> [ExecStatus]

enumFromTo :: ExecStatus -> ExecStatus -> [ExecStatus]

enumFromThenTo :: ExecStatus -> ExecStatus -> ExecStatus -> [ExecStatus]

Eq ExecStatus

Methods

(==) :: ExecStatus -> ExecStatus -> Bool

(/=) :: ExecStatus -> ExecStatus -> Bool

Show ExecStatus

Methods

showsPrec :: Int -> ExecStatus -> ShowS

show :: ExecStatus -> String

showList :: [ExecStatus] -> ShowS

data RowError

An error that occured when parsing a row.

Constructors

RowError RowErrorLocation RowErrorDetail

Instances

Eq RowError

Methods

(==) :: RowError -> RowError -> Bool

(/=) :: RowError -> RowError -> Bool

Ord RowError

Methods

compare :: RowError -> RowError -> Ordering

(<) :: RowError -> RowError -> Bool

(<=) :: RowError -> RowError -> Bool

(>) :: RowError -> RowError -> Bool

(>=) :: RowError -> RowError -> Bool

max :: RowError -> RowError -> RowError

min :: RowError -> RowError -> RowError

Show RowError

Methods

showsPrec :: Int -> RowError -> ShowS

show :: RowError -> String

showList :: [RowError] -> ShowS

MonadError RowError RowParser

Methods

throwError :: RowError -> RowParser a

catchError :: RowParser a -> (RowError -> RowParser a) -> RowParser a

data RowErrorLocation

Location of an error

Constructors

RowErrorLocation Column Row

Instances

Eq RowErrorLocation

Methods

(==) :: RowErrorLocation -> RowErrorLocation -> Bool

(/=) :: RowErrorLocation -> RowErrorLocation -> Bool

Ord RowErrorLocation

Methods

compare :: RowErrorLocation -> RowErrorLocation -> Ordering

(<) :: RowErrorLocation -> RowErrorLocation -> Bool

(<=) :: RowErrorLocation -> RowErrorLocation -> Bool

(>) :: RowErrorLocation -> RowErrorLocation -> Bool

(>=) :: RowErrorLocation -> RowErrorLocation -> Bool

max :: RowErrorLocation -> RowErrorLocation -> RowErrorLocation

min :: RowErrorLocation -> RowErrorLocation -> RowErrorLocation

Show RowErrorLocation

Methods

showsPrec :: Int -> RowErrorLocation -> ShowS

show :: RowErrorLocation -> String

showList :: [RowErrorLocation] -> ShowS

data RowErrorDetail

Errors that occur during row parsing

Constructors

TooFewColumns

Underlying RowParser wants more columns than are currently present.

ColumnRejected TypedValue

A column value could not be parsed.

ContentsRejected (Maybe ByteString)

The contents of a column could not be parsed.

Instances

Eq RowErrorDetail

Methods

(==) :: RowErrorDetail -> RowErrorDetail -> Bool

(/=) :: RowErrorDetail -> RowErrorDetail -> Bool

Ord RowErrorDetail

Methods

compare :: RowErrorDetail -> RowErrorDetail -> Ordering

(<) :: RowErrorDetail -> RowErrorDetail -> Bool

(<=) :: RowErrorDetail -> RowErrorDetail -> Bool

(>) :: RowErrorDetail -> RowErrorDetail -> Bool

(>=) :: RowErrorDetail -> RowErrorDetail -> Bool

max :: RowErrorDetail -> RowErrorDetail -> RowErrorDetail

min :: RowErrorDetail -> RowErrorDetail -> RowErrorDetail

Show RowErrorDetail

Methods

showsPrec :: Int -> RowErrorDetail -> ShowS

show :: RowErrorDetail -> String

showList :: [RowErrorDetail] -> ShowS