| Copyright | 2015 Dylan Simon |
|---|---|
| Safe Haskell | None |
| Language | Haskell98 |
Database.PostgreSQL.Typed.Range
Contents
Description
Representaion of PostgreSQL's range type. There are a number of existing range data types, but PostgreSQL's is rather particular. This tries to provide a one-to-one mapping.
- data Bound a
- = Unbounded
- | Bounded {
- _boundClosed :: Bool
- _bound :: a
- newtype LowerBound a = Lower {
- boundLower :: Bound a
- newtype UpperBound a = Upper {
- boundUpper :: Bound a
- compareBounds :: Ord a => LowerBound a -> UpperBound a -> Bound Bool
- data Range a
- = Empty
- | Range {
- lower :: LowerBound a
- upper :: UpperBound a
- bound :: Bound a -> Maybe a
- boundClosed :: Bound a -> Bool
- makeBound :: Bool -> Maybe a -> Bound a
- lowerBound :: Range a -> Bound a
- upperBound :: Range a -> Bound a
- lowerClosed :: Range a -> Bool
- upperClosed :: Range a -> Bool
- empty :: Range a
- isEmpty :: Ord a => Range a -> Bool
- full :: Range a
- isFull :: Range a -> Bool
- point :: a -> Range a
- getPoint :: Eq a => Range a -> Maybe a
- range :: Ord a => Bound a -> Bound a -> Range a
- normal :: Ord a => Maybe a -> Maybe a -> Range a
- bounded :: Ord a => a -> a -> Range a
- normalize :: Ord a => Range a -> Range a
- normalize' :: (Ord a, Enum a) => Range a -> Range a
- (@>) :: Ord a => Range a -> Range a -> Bool
- (<@) :: Ord a => Range a -> Range a -> Bool
- (@>.) :: Ord a => Range a -> a -> Bool
- overlaps :: Ord a => Range a -> Range a -> Bool
- intersect :: Ord a => Range a -> Range a -> Range a
- class (PGType t, PGType (PGSubType t)) => PGRangeType t where
Documentation
A end-point for a range, which may be nothing (infinity, NULL in PostgreSQL), open (inclusive), or closed (exclusive)
Constructors
| Unbounded | Equivalent to |
| Bounded | |
Fields
| |
newtype LowerBound a #
Constructors
| Lower | |
Fields
| |
Instances
| Functor LowerBound # | |
| Bounded a => Bounded (LowerBound a) # | The constraint is only necessary for |
| Eq a => Eq (LowerBound a) # | |
| Ord a => Ord (LowerBound a) # | Takes into account open vs. closed (but does not understand equivalent discrete bounds) |
newtype UpperBound a #
Constructors
| Upper | |
Fields
| |
Instances
| Functor UpperBound # | |
| Bounded a => Bounded (UpperBound a) # | The constraint is only necessary for |
| Eq a => Eq (UpperBound a) # | |
| Ord a => Ord (UpperBound a) # | Takes into account open vs. closed (but does not understand equivalent discrete bounds) |
compareBounds :: Ord a => LowerBound a -> UpperBound a -> Bound Bool #
Constructors
| Empty | |
| Range | |
Fields
| |
boundClosed :: Bound a -> Bool #
Unbounded endpoints are always open.
makeBound :: Bool -> Maybe a -> Bound a #
Construct from parts: makeBound (boundClosed b) (bound b) == b
lowerBound :: Range a -> Bound a #
Empty ranges treated as Unbounded
upperBound :: Range a -> Bound a #
Empty ranges treated as Unbounded
lowerClosed :: Range a -> Bool #
Equivalent to boundClosed . lowerBound
upperClosed :: Range a -> Bool #
Equivalent to boundClosed . upperBound
class (PGType t, PGType (PGSubType t)) => PGRangeType t where #
Class indicating that the first PostgreSQL type is a range of the second.
This implies PGParameter and PGColumn instances that will work for any type.
Methods
pgRangeElementType :: PGTypeID t -> PGTypeID (PGSubType t) #
Instances
| PGRangeType "daterange" # | |
| PGRangeType "int4range" # | |
| PGRangeType "int8range" # | |
| PGRangeType "numrange" # | |
| PGRangeType "tsrange" # | |
| PGRangeType "tstzrange" # | |