Database.PostgreSQL.Typed.Range

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.

Documentation

data Bound a

A end-point for a range, which may be nothing (infinity, NULL in PostgreSQL), open (inclusive), or closed (exclusive)

Constructors

Unbounded

Equivalent to Bounded False ±Infinity

Bounded

Fields

• _boundClosed :: Bool

  True if the range includes this bound

• _bound :: a

Instances

Functor Bound

Methods

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

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

Eq a => Eq (Bound a)

Methods

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

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

newtype LowerBound a

Constructors

Lower

Fields

• boundLower :: Bound a

Instances

Functor LowerBound

Methods

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

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

Bounded a => Bounded (LowerBound a)

The constraint is only necessary for maxBound, unfortunately

Methods

minBound :: LowerBound a

maxBound :: LowerBound a

Eq a => Eq (LowerBound a)

Methods

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

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

Ord a => Ord (LowerBound a)

Takes into account open vs. closed (but does not understand equivalent discrete bounds)

Methods

compare :: LowerBound a -> LowerBound a -> Ordering

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

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

(>) :: LowerBound a -> LowerBound a -> Bool

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

max :: LowerBound a -> LowerBound a -> LowerBound a

min :: LowerBound a -> LowerBound a -> LowerBound a

newtype UpperBound a

Constructors

Upper

Fields

• boundUpper :: Bound a

Instances

Functor UpperBound

Methods

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

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

Bounded a => Bounded (UpperBound a)

The constraint is only necessary for minBound, unfortunately

Methods

minBound :: UpperBound a

maxBound :: UpperBound a

Eq a => Eq (UpperBound a)

Methods

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

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

Ord a => Ord (UpperBound a)

Takes into account open vs. closed (but does not understand equivalent discrete bounds)

Methods

compare :: UpperBound a -> UpperBound a -> Ordering

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

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

(>) :: UpperBound a -> UpperBound a -> Bool

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

max :: UpperBound a -> UpperBound a -> UpperBound a

min :: UpperBound a -> UpperBound a -> UpperBound a

compareBounds :: Ord a => LowerBound a -> UpperBound a -> Bound Bool

data Range a

Constructors

Empty

Range

Fields

• lower :: LowerBound a
• upper :: UpperBound a

Instances

Functor Range

Methods

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

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

(PGRangeType tr t, PGColumn t a) => PGColumn tr (Range a)

Methods

pgDecode :: PGTypeName tr -> PGTextValue -> Range a

pgDecodeBinary :: PGTypeEnv -> PGTypeName tr -> PGBinaryValue -> Range a

pgDecodeValue :: PGTypeEnv -> PGTypeName tr -> PGValue -> Range a

(PGRangeType tr t, PGParameter t a) => PGParameter tr (Range a)

Methods

pgEncode :: PGTypeName tr -> Range a -> PGTextValue

pgLiteral :: PGTypeName tr -> Range a -> ByteString

pgEncodeValue :: PGTypeEnv -> PGTypeName tr -> Range a -> PGValue

Eq a => Eq (Range a)

Methods

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

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

Ord a => Ord (Range a)

Methods

compare :: Range a -> Range a -> Ordering

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

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

(>) :: Range a -> Range a -> Bool

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

max :: Range a -> Range a -> Range a

min :: Range a -> Range a -> Range a

Show a => Show (Range a)

Methods

showsPrec :: Int -> Range a -> ShowS

show :: Range a -> String

showList :: [Range a] -> ShowS

Ord a => Monoid (Range a)

Methods

mempty :: Range a

mappend :: Range a -> Range a -> Range a

mconcat :: [Range a] -> Range a

bound :: Bound a -> Maybe a

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

empty :: Range a

isEmpty :: Ord a => Range a -> Bool

full :: Range a

isFull :: Range a -> Bool

point :: a -> Range a

Create a point range [x,x]

getPoint :: Eq a => Range a -> Maybe a

Extract a point: getPoint (point x) == Just x

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

normalize for discrete (non-continuous) range types, using the Enum instance

(@>) :: Ord a => Range a -> Range a -> Bool

Contains range

(<@) :: Ord a => Range a -> Range a -> Bool

Contains range

(@>.) :: Ord a => Range a -> a -> Bool

Contains element

overlaps :: Ord a => Range a -> Range a -> Bool

intersect :: Ord a => Range a -> Range a -> Range a

class (PGType tr, PGType t) => PGRangeType tr t | tr -> 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 :: PGTypeName tr -> PGTypeName t

Instances

PGRangeType "daterange" "date"

Methods

pgRangeElementType :: PGTypeName "daterange" -> PGTypeName "date"

PGRangeType "int4range" "integer"

Methods

pgRangeElementType :: PGTypeName "int4range" -> PGTypeName "integer"

PGRangeType "int8range" "bigint"

Methods

pgRangeElementType :: PGTypeName "int8range" -> PGTypeName "bigint"

PGRangeType "numrange" "numeric"

Methods

pgRangeElementType :: PGTypeName "numrange" -> PGTypeName "numeric"

PGRangeType "tsrange" "timestamp without time zone"

Methods

pgRangeElementType :: PGTypeName "tsrange" -> PGTypeName "timestamp without time zone"

PGRangeType "tstzrange" "timestamp with time zone"

Methods

pgRangeElementType :: PGTypeName "tstzrange" -> PGTypeName "timestamp with time zone"

Orphan instances

PGType "daterange"

Methods

pgTypeName :: PGTypeName "daterange" -> String

pgBinaryColumn :: PGTypeEnv -> PGTypeName "daterange" -> Bool

PGType "int4range"

Methods

pgTypeName :: PGTypeName "int4range" -> String

pgBinaryColumn :: PGTypeEnv -> PGTypeName "int4range" -> Bool

PGType "int8range"

Methods

pgTypeName :: PGTypeName "int8range" -> String

pgBinaryColumn :: PGTypeEnv -> PGTypeName "int8range" -> Bool

PGType "numrange"

Methods

pgTypeName :: PGTypeName "numrange" -> String

pgBinaryColumn :: PGTypeEnv -> PGTypeName "numrange" -> Bool

PGType "tsrange"

Methods

pgTypeName :: PGTypeName "tsrange" -> String

pgBinaryColumn :: PGTypeEnv -> PGTypeName "tsrange" -> Bool

PGType "tstzrange"

Methods

pgTypeName :: PGTypeName "tstzrange" -> String

pgBinaryColumn :: PGTypeEnv -> PGTypeName "tstzrange" -> Bool