ProjectM36.Tupleable

Documentation

toInsertExpr :: forall a t. (Tupleable a, Traversable t) => t a -> RelVarName -> Either RelationalError DatabaseContextExpr

Convert a Traverseable of Tupleables to an Insert DatabaseContextExpr. This is useful for converting, for example, a list of data values to a set of Insert expressions which can be used to add the values to the database.

toDefineExpr :: forall a proxy. Tupleable a => proxy a -> RelVarName -> DatabaseContextExpr

Convert a Tupleable to a create a Define expression which can be used to create an empty relation variable. Use toInsertExpr to insert the actual tuple data. This function is typically used with Proxy.

tupleAssocsEqualityPredicate :: [(AttributeName, Atom)] -> RestrictionPredicateExpr

partitionByAttributes :: Tupleable a => [AttributeName] -> a -> ([(AttributeName, Atom)], [(AttributeName, Atom)])

toUpdateExpr :: forall a. Tupleable a => RelVarName -> [AttributeName] -> a -> Either RelationalError DatabaseContextExpr

Convert a list of key attributes and a Tupleable value to an Update expression. This expression flushes the non-key attributes of the value to a tuple with the matching key attributes.

toDeleteExpr :: forall a. Tupleable a => RelVarName -> [AttributeName] -> a -> Either RelationalError DatabaseContextExpr

Convert a list of key attributes and a Tupleable value to a Delete expression. This expression deletes tuples matching the key attributes from the value.

validateAttributes :: Set AttributeName -> Set AttributeName -> a -> Either RelationalError a

class Tupleable a where

Types that can be converted to and from RelationTuple.

deriving without customization:

data Example = Example
    { foo :: Integer
    , bar :: Text
    }
    deriving (Generic)

instance Tupleable Example

deriving with customization using ProjectM36.Tupleable.Deriving:

data Example = Example
    { exampleFoo :: Integer
    , exampleBar :: Text
    }
    deriving stock (Generic)
    deriving (Tupleable)
        via Codec (Field (DropPrefix "example" >>> CamelCase)) Example

Minimal complete definition

Nothing

Methods

toTuple :: a -> RelationTuple

default toTuple :: (Generic a, TupleableG (Rep a)) => a -> RelationTuple

fromTuple :: RelationTuple -> Either RelationalError a

default fromTuple :: (Generic a, TupleableG (Rep a)) => RelationTuple -> Either RelationalError a

toAttributes :: Proxy a -> Attributes

default toAttributes :: (Generic a, TupleableG (Rep a)) => Proxy a -> Attributes

Instances

(ModifyOptions tag, Generic a, TupleableG (Rep a)) => Tupleable (Codec tag a)

Defined in ProjectM36.Tupleable.Deriving

Methods

toTuple :: Codec tag a -> RelationTuple

fromTuple :: RelationTuple -> Either RelationalError (Codec tag a)

toAttributes :: Proxy (Codec tag a) -> Attributes

Generics

genericToTuple :: (Generic a, TupleableG (Rep a)) => TupleableOptions -> a -> RelationTuple

genericFromTuple :: (Generic a, TupleableG (Rep a)) => TupleableOptions -> RelationTuple -> Either RelationalError a

genericToAttributes :: forall a. (Generic a, TupleableG (Rep a)) => TupleableOptions -> Proxy a -> Attributes

class TupleableG g where

Methods

toTupleG :: TupleableOptions -> g a -> RelationTuple

toAttributesG :: TupleableOptions -> g a -> Attributes

fromTupleG :: TupleableOptions -> RelationTuple -> Either RelationalError (g a)

isRecordTypeG :: g a -> Bool

Instances

TupleableG (U1 :: Type -> Type)

Defined in ProjectM36.Tupleable

Methods

toTupleG :: TupleableOptions -> U1 a -> RelationTuple

toAttributesG :: TupleableOptions -> U1 a -> Attributes

fromTupleG :: TupleableOptions -> RelationTuple -> Either RelationalError (U1 a)

isRecordTypeG :: U1 a -> Bool

(TupleableG a, TupleableG b) => TupleableG (a :*: b)

Defined in ProjectM36.Tupleable

Methods

toTupleG :: TupleableOptions -> (a :*: b) a0 -> RelationTuple

toAttributesG :: TupleableOptions -> (a :*: b) a0 -> Attributes

fromTupleG :: TupleableOptions -> RelationTuple -> Either RelationalError ((a :*: b) a0)

isRecordTypeG :: (a :*: b) a0 -> Bool

(Constructor c, TupleableG a, AtomableG a) => TupleableG (M1 C c a)

Defined in ProjectM36.Tupleable

Methods

toTupleG :: TupleableOptions -> M1 C c a a0 -> RelationTuple

toAttributesG :: TupleableOptions -> M1 C c a a0 -> Attributes

fromTupleG :: TupleableOptions -> RelationTuple -> Either RelationalError (M1 C c a a0)

isRecordTypeG :: M1 C c a a0 -> Bool

(Datatype c, TupleableG a) => TupleableG (M1 D c a)

Defined in ProjectM36.Tupleable

Methods

toTupleG :: TupleableOptions -> M1 D c a a0 -> RelationTuple

toAttributesG :: TupleableOptions -> M1 D c a a0 -> Attributes

fromTupleG :: TupleableOptions -> RelationTuple -> Either RelationalError (M1 D c a a0)

isRecordTypeG :: M1 D c a a0 -> Bool

(Selector c, AtomableG a) => TupleableG (M1 S c a)

Defined in ProjectM36.Tupleable

Methods

toTupleG :: TupleableOptions -> M1 S c a a0 -> RelationTuple

toAttributesG :: TupleableOptions -> M1 S c a a0 -> Attributes

fromTupleG :: TupleableOptions -> RelationTuple -> Either RelationalError (M1 S c a a0)

isRecordTypeG :: M1 S c a a0 -> Bool

Options

defaultTupleableOptions :: TupleableOptions

The default options for deriving Tupleable instances.

These options can be customized by using record update syntax. For example,

defaultTupleableOptions
    { fieldModifier = \fieldName ->
        case Data.Text.stripPrefix "example" fieldName of
            Nothing -> fieldName
            Just attributeName -> attributeName
    }

will result in record field names being translated into attribute names by removing the prefix "example" from the field names.

data TupleableOptions

Options that influence deriving behavior.

fieldModifier :: TupleableOptions -> Text -> Text

A function that translates record field names into attribute names.