Database.Beam.Migrate.Serialization

Serialization and deserialization helpers for beam data types.

Used to read and write machine-readable schema descriptions.

Serialization helpers

Below we provide various instances of Beam SQL syntax types that produce an aeson Value that reflects the call tree. This allows us to read back these data types in various syntaxes.

Because these are formatted as standard beam syntaxes, backends can easily serialize their data to disk. For an example of what we mean by this, see the instance of IsSql92DataTypeSyntax for SqliteDataTypeSyntax in beam-sqlite.

newtype BeamSerializedDataType

An IsSql92DataTypeSyntax for JSON. Supports all superclasses of IsSql92DataTypeSyntax declared in beam-core.

Constructors

BeamSerializedDataType

Fields

• fromBeamSerializedDataType :: Value

Instances

ToJSON BeamSerializedDataType

Defined in Database.Beam.Migrate.Serialization

Methods

toJSON :: BeamSerializedDataType -> Value

toEncoding :: BeamSerializedDataType -> Encoding

toJSONList :: [BeamSerializedDataType] -> Value

toEncodingList :: [BeamSerializedDataType] -> Encoding

Show BeamSerializedDataType

Defined in Database.Beam.Migrate.Serialization

Methods

showsPrec :: Int -> BeamSerializedDataType -> ShowS

show :: BeamSerializedDataType -> String

showList :: [BeamSerializedDataType] -> ShowS

IsSql2003BinaryAndVarBinaryDataTypeSyntax BeamSerializedDataType

Defined in Database.Beam.Migrate.Serialization

Methods

binaryType :: Maybe Word -> BeamSerializedDataType

varBinaryType :: Maybe Word -> BeamSerializedDataType

IsSql2008BigIntDataTypeSyntax BeamSerializedDataType

Defined in Database.Beam.Migrate.Serialization

Methods

bigIntType :: BeamSerializedDataType

IsSql92DataTypeSyntax BeamSerializedDataType

Defined in Database.Beam.Migrate.Serialization

Methods

domainType :: Text -> BeamSerializedDataType

charType :: Maybe Word -> Maybe Text -> BeamSerializedDataType

varCharType :: Maybe Word -> Maybe Text -> BeamSerializedDataType

nationalCharType :: Maybe Word -> BeamSerializedDataType

nationalVarCharType :: Maybe Word -> BeamSerializedDataType

bitType :: Maybe Word -> BeamSerializedDataType

varBitType :: Maybe Word -> BeamSerializedDataType

numericType :: Maybe (Word, Maybe Word) -> BeamSerializedDataType

decimalType :: Maybe (Word, Maybe Word) -> BeamSerializedDataType

intType :: BeamSerializedDataType

smallIntType :: BeamSerializedDataType

floatType :: Maybe Word -> BeamSerializedDataType

doubleType :: BeamSerializedDataType

realType :: BeamSerializedDataType

dateType :: BeamSerializedDataType

timeType :: Maybe Word -> Bool -> BeamSerializedDataType

timestampType :: Maybe Word -> Bool -> BeamSerializedDataType

IsSql99DataTypeSyntax BeamSerializedDataType

Defined in Database.Beam.Migrate.Serialization

Methods

characterLargeObjectType :: BeamSerializedDataType

binaryLargeObjectType :: BeamSerializedDataType

booleanType :: BeamSerializedDataType

arrayType :: BeamSerializedDataType -> Int -> BeamSerializedDataType

rowType :: [(Text, BeamSerializedDataType)] -> BeamSerializedDataType

Eq BeamSerializedDataType

Defined in Database.Beam.Migrate.Serialization

Methods

(==) :: BeamSerializedDataType -> BeamSerializedDataType -> Bool

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

newtype BeamSerializedConstraintDefinition

IsSql92ColumnConstraintDefinitionSyntax type for JSON

Constructors

BeamSerializedConstraintDefinition

Fields

• fromBeamSerializedConstraintDefinition :: Value

Instances

Show BeamSerializedConstraintDefinition

Defined in Database.Beam.Migrate.Serialization

Methods

showsPrec :: Int -> BeamSerializedConstraintDefinition -> ShowS

show :: BeamSerializedConstraintDefinition -> String

showList :: [BeamSerializedConstraintDefinition] -> ShowS

IsSql92ColumnConstraintDefinitionSyntax BeamSerializedConstraintDefinition

Defined in Database.Beam.Migrate.Serialization

Associated Types

type Sql92ColumnConstraintDefinitionConstraintSyntax BeamSerializedConstraintDefinition

type Sql92ColumnConstraintDefinitionAttributesSyntax BeamSerializedConstraintDefinition

Methods

constraintDefinitionSyntax :: Maybe Text -> Sql92ColumnConstraintDefinitionConstraintSyntax BeamSerializedConstraintDefinition -> Maybe (Sql92ColumnConstraintDefinitionAttributesSyntax BeamSerializedConstraintDefinition) -> BeamSerializedConstraintDefinition

Eq BeamSerializedConstraintDefinition

Defined in Database.Beam.Migrate.Serialization

Methods

(==) :: BeamSerializedConstraintDefinition -> BeamSerializedConstraintDefinition -> Bool

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

type Sql92ColumnConstraintDefinitionAttributesSyntax BeamSerializedConstraintDefinition

Defined in Database.Beam.Migrate.Serialization

type Sql92ColumnConstraintDefinitionAttributesSyntax BeamSerializedConstraintDefinition = BeamSerializedConstraintAttributes

type Sql92ColumnConstraintDefinitionConstraintSyntax BeamSerializedConstraintDefinition

Defined in Database.Beam.Migrate.Serialization

type Sql92ColumnConstraintDefinitionConstraintSyntax BeamSerializedConstraintDefinition = BeamSerializedConstraint

newtype BeamSerializedConstraintAttributes

IsSql92ConstraintAttributesSyntax type for JSON

Constructors

BeamSerializedConstraintAttributes

Fields

• fromBeamSerializedConstraintAttributes :: [Value]

Instances

Monoid BeamSerializedConstraintAttributes

Defined in Database.Beam.Migrate.Serialization

Methods

mempty :: BeamSerializedConstraintAttributes

mappend :: BeamSerializedConstraintAttributes -> BeamSerializedConstraintAttributes -> BeamSerializedConstraintAttributes

mconcat :: [BeamSerializedConstraintAttributes] -> BeamSerializedConstraintAttributes

Semigroup BeamSerializedConstraintAttributes

Defined in Database.Beam.Migrate.Serialization

Methods

(<>) :: BeamSerializedConstraintAttributes -> BeamSerializedConstraintAttributes -> BeamSerializedConstraintAttributes

sconcat :: NonEmpty BeamSerializedConstraintAttributes -> BeamSerializedConstraintAttributes

stimes :: Integral b => b -> BeamSerializedConstraintAttributes -> BeamSerializedConstraintAttributes

Show BeamSerializedConstraintAttributes

Defined in Database.Beam.Migrate.Serialization

Methods

showsPrec :: Int -> BeamSerializedConstraintAttributes -> ShowS

show :: BeamSerializedConstraintAttributes -> String

showList :: [BeamSerializedConstraintAttributes] -> ShowS

IsSql92ConstraintAttributesSyntax BeamSerializedConstraintAttributes

Defined in Database.Beam.Migrate.Serialization

Methods

initiallyDeferredAttributeSyntax :: BeamSerializedConstraintAttributes

initiallyImmediateAttributeSyntax :: BeamSerializedConstraintAttributes

notDeferrableAttributeSyntax :: BeamSerializedConstraintAttributes

deferrableAttributeSyntax :: BeamSerializedConstraintAttributes

Eq BeamSerializedConstraintAttributes

Defined in Database.Beam.Migrate.Serialization

Methods

(==) :: BeamSerializedConstraintAttributes -> BeamSerializedConstraintAttributes -> Bool

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

newtype BeamSerializedConstraint

IsSql92ColumnConstraintSyntax type for JSON

Constructors

BeamSerializedConstraint

Fields

• fromBeamSerializedConstraint :: Value

Instances

Show BeamSerializedConstraint

Defined in Database.Beam.Migrate.Serialization

Methods

showsPrec :: Int -> BeamSerializedConstraint -> ShowS

show :: BeamSerializedConstraint -> String

showList :: [BeamSerializedConstraint] -> ShowS

IsSql92ColumnConstraintSyntax BeamSerializedConstraint

Defined in Database.Beam.Migrate.Serialization

Associated Types

type Sql92ColumnConstraintMatchTypeSyntax BeamSerializedConstraint

type Sql92ColumnConstraintReferentialActionSyntax BeamSerializedConstraint

type Sql92ColumnConstraintExpressionSyntax BeamSerializedConstraint

Methods

notNullConstraintSyntax :: BeamSerializedConstraint

uniqueColumnConstraintSyntax :: BeamSerializedConstraint

primaryKeyColumnConstraintSyntax :: BeamSerializedConstraint

checkColumnConstraintSyntax :: Sql92ColumnConstraintExpressionSyntax BeamSerializedConstraint -> BeamSerializedConstraint

referencesConstraintSyntax :: Text -> [Text] -> Maybe (Sql92ColumnConstraintMatchTypeSyntax BeamSerializedConstraint) -> Maybe (Sql92ColumnConstraintReferentialActionSyntax BeamSerializedConstraint) -> Maybe (Sql92ColumnConstraintReferentialActionSyntax BeamSerializedConstraint) -> BeamSerializedConstraint

Eq BeamSerializedConstraint

Defined in Database.Beam.Migrate.Serialization

Methods

(==) :: BeamSerializedConstraint -> BeamSerializedConstraint -> Bool

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

type Sql92ColumnConstraintExpressionSyntax BeamSerializedConstraint

Defined in Database.Beam.Migrate.Serialization

type Sql92ColumnConstraintExpressionSyntax BeamSerializedConstraint = BeamSerializedExpression

type Sql92ColumnConstraintMatchTypeSyntax BeamSerializedConstraint

Defined in Database.Beam.Migrate.Serialization

type Sql92ColumnConstraintMatchTypeSyntax BeamSerializedConstraint = BeamSerializedMatchType

type Sql92ColumnConstraintReferentialActionSyntax BeamSerializedConstraint

Defined in Database.Beam.Migrate.Serialization

type Sql92ColumnConstraintReferentialActionSyntax BeamSerializedConstraint = BeamSerializedReferentialAction

newtype BeamSerializedMatchType

IsSql92MatchTypeSyntax type for JSON

Constructors

BeamSerializedMatchType

Fields

• fromBeamSerializedMatchType :: Value

Instances

Show BeamSerializedMatchType

Defined in Database.Beam.Migrate.Serialization

Methods

showsPrec :: Int -> BeamSerializedMatchType -> ShowS

show :: BeamSerializedMatchType -> String

showList :: [BeamSerializedMatchType] -> ShowS

IsSql92MatchTypeSyntax BeamSerializedMatchType

Defined in Database.Beam.Migrate.Serialization

Methods

fullMatchSyntax :: BeamSerializedMatchType

partialMatchSyntax :: BeamSerializedMatchType

Eq BeamSerializedMatchType

Defined in Database.Beam.Migrate.Serialization

Methods

(==) :: BeamSerializedMatchType -> BeamSerializedMatchType -> Bool

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

newtype BeamSerializedReferentialAction

IsSql92ReferentialActionSyntax type for JSON

Constructors

BeamSerializedReferentialAction

Fields

• fromBeamSerializedReferentialAction :: Value

Instances

Show BeamSerializedReferentialAction

Defined in Database.Beam.Migrate.Serialization

Methods

showsPrec :: Int -> BeamSerializedReferentialAction -> ShowS

show :: BeamSerializedReferentialAction -> String

showList :: [BeamSerializedReferentialAction] -> ShowS

IsSql92ReferentialActionSyntax BeamSerializedReferentialAction

Defined in Database.Beam.Migrate.Serialization

Methods

referentialActionCascadeSyntax :: BeamSerializedReferentialAction

referentialActionSetNullSyntax :: BeamSerializedReferentialAction

referentialActionSetDefaultSyntax :: BeamSerializedReferentialAction

referentialActionNoActionSyntax :: BeamSerializedReferentialAction

Eq BeamSerializedReferentialAction

Defined in Database.Beam.Migrate.Serialization

Methods

(==) :: BeamSerializedReferentialAction -> BeamSerializedReferentialAction -> Bool

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

newtype BeamSerializedExpression

IsSql92ExpressionSyntax is too complex for us to store in JSON. Additionally, many backends provide substantial amounts of extensions to the syntax that would make storing this highly unfeasible. Expressions are therefore represented as their full text rendering.

This means that expressions only match as equal if they match exactly. While this may seem overly pedantic, it's not much of a concern if your migrations are generated solely by beam-migrate. If you've modified the schema yourself, you may have to use IsCustomSqlSyntax to provide an exact expression.

Constructors

BeamSerializedExpression

Fields

• fromBeamSerializedExpression :: Text

Instances

Show BeamSerializedExpression

Defined in Database.Beam.Migrate.Serialization

Methods

showsPrec :: Int -> BeamSerializedExpression -> ShowS

show :: BeamSerializedExpression -> String

showList :: [BeamSerializedExpression] -> ShowS

Eq BeamSerializedExpression

Defined in Database.Beam.Migrate.Serialization

Methods

(==) :: BeamSerializedExpression -> BeamSerializedExpression -> Bool

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

beamSerializeJSON :: Text -> Value -> Value

Some backends serialize data that can only be read by that backend. If so, they should wrap these data in beamSerializeJSON, which provides a standard syntax for specifying backend specific data, as well as which backend the data are valid for.

The first argument is a string that is unique to a given backend

serializePrecAndDecimal :: Maybe (Word, Maybe Word) -> Value

Helper for serializing the precision and decimal count parameters to decimalType, etc.

Deserialization helpers

Deserialization requires that knowledge of every type of data we can deserialize is stored in one place. While this is not much of an issue when compiling full Haskell applications, due to the type class mechanism, beam-migrate tools load backends dynamically. This means that we need a separate way to discover deserialization instances for types we care about.

Values of the BeamDeserializers type represent a set of deserializers all related to one kind of command syntax. You can ask for the deserializers to deserialize any type from an aeson Value. The deserialization will succeed only if a deserializer for the requested type exists and the deserializer was able to parse the Value.

BeamDeserializers compose monoidally. Thus, you can extend any BeamDeserializers with your own custom deserializers, by mappending it with a new BeamDeserializers, created by calling beamDeserializer.

newtype BeamDeserializers be

Provides a collection of deserializers from aeson Values for arbitrary types. The cmd type parameter is a phantom type parameter. Notionally, all deserializers within this BeamDeserializers relate to the cmd syntax.

Constructors

BeamDeserializers

Fields

• beamArbitraryDeserializers :: DMap BeamDeserializerLabel BeamDeserializer

Instances

Monoid (BeamDeserializers be)

Defined in Database.Beam.Migrate.Serialization

Methods

mempty :: BeamDeserializers be

mappend :: BeamDeserializers be -> BeamDeserializers be -> BeamDeserializers be

mconcat :: [BeamDeserializers be] -> BeamDeserializers be

Semigroup (BeamDeserializers be)

Defined in Database.Beam.Migrate.Serialization

Methods

(<>) :: BeamDeserializers be -> BeamDeserializers be -> BeamDeserializers be

sconcat :: NonEmpty (BeamDeserializers be) -> BeamDeserializers be

stimes :: Integral b => b -> BeamDeserializers be -> BeamDeserializers be

beamDeserialize :: forall a be. Typeable a => BeamDeserializers be -> Value -> Parser a

Deserialize the requested type from the given deserializers and aeson Value.

beamDeserializeMaybe :: Typeable a => BeamDeserializers be -> Maybe Value -> Parser (Maybe a)

Helper function to deserialize data from a Maybe Value.

beamDeserializeMaybe _ Nothing = pure Nothing
beamDeserializeMaybe d (Just v) = Just $ beamDeserialize d v

beamDeserializer :: Typeable ty => (forall be'. BeamDeserializers be' -> Value -> Parser ty) -> BeamDeserializers be

sql92Deserializers :: forall be. BeamMigrateSqlBackend be => BeamDeserializers be

Deserializers for SQL92 syntaxes

sql99DataTypeDeserializers :: forall be. BeamMigrateSql99Backend be => BeamDeserializers be

Deserializes data types that are instances of IsSql99DataTypeSyntax

sql2003BinaryAndVarBinaryDataTypeDeserializers :: forall be. (BeamMigrateSqlBackend be, BeamSqlT021Backend be) => BeamDeserializers be

Deserialize data types that are instances of IsSql2003BinaryAndVarBinaryDataTypeSyntax

sql2008BigIntDataTypeDeserializers :: forall be. (BeamMigrateSqlBackend be, BeamSqlT071Backend be) => BeamDeserializers be

Deserialize data types that are instance of IsSql2008BigIntDataTypeSyntax