Copyright	(c) 2013 Leon P Smith
License	BSD3
Maintainer	Leon P Smith <leon@melding-monads.com>
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Database.PostgreSQL.Simple.HStore

Description

Parsers and printers for hstore, a extended type bundled with PostgreSQL providing finite maps from text strings to text strings. See https://www.postgresql.org/docs/9.5/static/hstore.html for more information.

Note that in order to use this type, a database superuser must install it by running a sql script in the share directory. This can be done on PostgreSQL 9.1 and later with the command CREATE EXTENSION hstore. See https://www.postgresql.org/docs/9.5/static/contrib.html for more information.

Synopsis

newtype HStoreList = HStoreList {
- fromHStoreList :: [(Text, Text)]
}
newtype HStoreMap = HStoreMap {
- fromHStoreMap :: Map Text Text
}
class ToHStore a where
data HStoreBuilder
toBuilder :: HStoreBuilder -> Builder
toLazyByteString :: HStoreBuilder -> ByteString
hstore :: (ToHStoreText a, ToHStoreText b) => a -> b -> HStoreBuilder
parseHStoreList :: ByteString -> Either String HStoreList
class ToHStoreText a where
data HStoreText

Documentation

newtype HStoreList Source #

Constructors

HStoreList
Fields fromHStoreList :: [(Text, Text)]

Instances

Show HStoreList Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods showsPrec :: Int -> HStoreList -> ShowS # show :: HStoreList -> String # showList :: [HStoreList] -> ShowS #
ToField HStoreList Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toField :: HStoreList -> Action Source #
FromField HStoreList Source #	hstore
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods fromField :: FieldParser HStoreList Source #
ToHStore HStoreList Source #	hstore
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toHStore :: HStoreList -> HStoreBuilder Source #

newtype HStoreMap Source #

Constructors

HStoreMap
Fields fromHStoreMap :: Map Text Text

Instances

Eq HStoreMap Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods (==) :: HStoreMap -> HStoreMap -> Bool # (/=) :: HStoreMap -> HStoreMap -> Bool #
Ord HStoreMap Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods compare :: HStoreMap -> HStoreMap -> Ordering # (<) :: HStoreMap -> HStoreMap -> Bool # (<=) :: HStoreMap -> HStoreMap -> Bool # (>) :: HStoreMap -> HStoreMap -> Bool # (>=) :: HStoreMap -> HStoreMap -> Bool # max :: HStoreMap -> HStoreMap -> HStoreMap # min :: HStoreMap -> HStoreMap -> HStoreMap #
Show HStoreMap Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods showsPrec :: Int -> HStoreMap -> ShowS # show :: HStoreMap -> String # showList :: [HStoreMap] -> ShowS #
ToField HStoreMap Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toField :: HStoreMap -> Action Source #
FromField HStoreMap Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods fromField :: FieldParser HStoreMap Source #
ToHStore HStoreMap Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toHStore :: HStoreMap -> HStoreBuilder Source #

class ToHStore a where Source #

Minimal complete definition

toHStore

Methods

toHStore :: a -> HStoreBuilder Source #

Instances

ToHStore HStoreMap Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toHStore :: HStoreMap -> HStoreBuilder Source #
ToHStore HStoreList Source #	hstore
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toHStore :: HStoreList -> HStoreBuilder Source #
ToHStore HStoreBuilder Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toHStore :: HStoreBuilder -> HStoreBuilder Source #

data HStoreBuilder Source #

Represents valid hstore syntax.

Instances

Semigroup HStoreBuilder Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods (<>) :: HStoreBuilder -> HStoreBuilder -> HStoreBuilder # sconcat :: NonEmpty HStoreBuilder -> HStoreBuilder # stimes :: Integral b => b -> HStoreBuilder -> HStoreBuilder #
Monoid HStoreBuilder Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods mempty :: HStoreBuilder # mappend :: HStoreBuilder -> HStoreBuilder -> HStoreBuilder # mconcat :: [HStoreBuilder] -> HStoreBuilder #
ToField HStoreBuilder Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toField :: HStoreBuilder -> Action Source #
ToHStore HStoreBuilder Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toHStore :: HStoreBuilder -> HStoreBuilder Source #

toBuilder :: HStoreBuilder -> Builder Source #

toLazyByteString :: HStoreBuilder -> ByteString Source #

hstore :: (ToHStoreText a, ToHStoreText b) => a -> b -> HStoreBuilder Source #

parseHStoreList :: ByteString -> Either String HStoreList Source #

class ToHStoreText a where Source #

Minimal complete definition

toHStoreText

Methods

toHStoreText :: a -> HStoreText Source #

Instances

ToHStoreText ByteString Source #	Assumed to be UTF-8 encoded
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toHStoreText :: ByteString -> HStoreText Source #
ToHStoreText ByteString Source #	Assumed to be UTF-8 encoded
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toHStoreText :: ByteString -> HStoreText Source #
ToHStoreText Text Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toHStoreText :: Text -> HStoreText Source #
ToHStoreText Text Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toHStoreText :: Text -> HStoreText Source #
ToHStoreText HStoreText Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toHStoreText :: HStoreText -> HStoreText Source #

data HStoreText Source #

Represents escape text, ready to be the key or value to a hstore value

Instances

Semigroup HStoreText Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods (<>) :: HStoreText -> HStoreText -> HStoreText # sconcat :: NonEmpty HStoreText -> HStoreText # stimes :: Integral b => b -> HStoreText -> HStoreText #
Monoid HStoreText Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods mempty :: HStoreText # mappend :: HStoreText -> HStoreText -> HStoreText # mconcat :: [HStoreText] -> HStoreText #
ToHStoreText HStoreText Source #
Instance details Defined in Database.PostgreSQL.Simple.HStore.Implementation Methods toHStoreText :: HStoreText -> HStoreText Source #