Modulepersistent-2.14.6.3Haskell2010

Database.Persist.PersistValue

This module contains an intermediate representation of values before the backends serialize them into explicit database types.

2 types
1 value

Packagepersistent-2.14.6.3
Exports6
LanguageHaskell2010
LicenceMIT
SourcePersistValue.hs

datadata PersistValue

A raw value which can be stored in any backend and can be marshalled to and from a PersistField.

Constructors

PersistText Text
PersistByteString ByteString
PersistInt64 Int64
PersistDouble Double
PersistRational Rational
PersistBool Bool
PersistDay Day
PersistTimeOfDay TimeOfDay
PersistUTCTime UTCTime
PersistNull
PersistList [PersistValue]
PersistMap [(Text, PersistValue)]
PersistObjectId ByteString
Intended especially for MongoDB backend
PersistArray [PersistValue]
Intended especially for PostgreSQL backend for text arrays
PersistLiteral_ LiteralType ByteString
This constructor is used to specify some raw literal value for the backend. The LiteralType value specifies how the value should be escaped. This can be used to make special, custom types avaialable in the back end.

Instances12Eq, Ord, Read, Show, NFData, FromJSON, …

Eq PersistValueDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
Ord PersistValueDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
Read PersistValueDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
Show PersistValueDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
NFData PersistValueDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
FromJSON PersistValueDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
ToJSON PersistValueDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
FromHttpApiData PersistValueDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
ToHttpApiData PersistValueDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
PathPiece PersistValueDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
PersistField PersistValueDefined in persistent-2.14.6.3 · Database.Persist.Class.PersistField
PersistFieldSql PersistValueDefined in persistent-2.14.6.3 · Database.Persist.Sql.Class

patternpattern PersistLiteral :: ByteString -> PersistValue

This pattern synonym used to be a data constructor on PersistValue, but was changed into a catch-all pattern synonym to allow backwards compatiblity with database types. See the documentation on PersistDbSpecific for more details.

patternpattern PersistLiteralEscaped :: ByteString -> PersistValue

patternpattern PersistDbSpecific :: ByteString -> PersistValue

Deprecated. Deprecated since 2.11 because of inconsistent escaping behavior across backends. The Postgres backend escapes these values, while the MySQL backend does not. If you are using this, please switch to PersistLiteral_ and provide a relevant LiteralType for your conversion.

This pattern synonym used to be a data constructor for the PersistValue type. It was changed to be a pattern so that JSON-encoded database values could be parsed into their corresponding values. You should not use this, and instead prefer to pattern match on PersistLiteral_ directly.

If you use this, it will overlap a patern match on the 'PersistLiteral_, PersistLiteral, and PersistLiteralEscaped patterns. If you need to disambiguate between these constructors, pattern match on PersistLiteral_ directly.

valuefromPersistValueText :: PersistValue -> Either Text Text

datadata LiteralType

A type that determines how a backend should handle the literal.

Constructors

Escaped
The accompanying value will be escaped before inserting into the database. This is the correct default choice to use.
Unescaped
The accompanying value will not be escaped when inserting into the database. This is potentially dangerous - use this with care.
DbSpecific
The DbSpecific constructor corresponds to the legacy PersistDbSpecific constructor. We need to keep this around because old databases may have serialized JSON representations that reference this. We don't want to break the ability of a database to load rows.

Instances4Eq, Ord, Read, Show

Eq LiteralTypeDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
Ord LiteralTypeDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
Read LiteralTypeDefined in persistent-2.14.6.3 · Database.Persist.PersistValue
Show LiteralTypeDefined in persistent-2.14.6.3 · Database.Persist.PersistValue