Database.Beam.Schema.Tables

Defines a generic schema type that can be used to define schemas for Beam tables

Database Types

class Database be db

Allows introspection into database types.

All database types must be of kind '(* -> *) -> *'. If the type parameter is named f, each field must be of the type of f applied to some type for which an IsDatabaseEntity instance exists.

The be type parameter is necessary so that the compiler can ensure that backend-specific entities only work on the proper backend.

Entities are documented under the corresponding section and in the manual

zipTables :: (Database be db, Monad m) => Proxy be -> (forall tbl. (IsDatabaseEntity be tbl, DatabaseEntityRegularRequirements be tbl) => f tbl -> g tbl -> m (h tbl)) -> db f -> db g -> m (db h)

Default derived function. Do not implement this yourself.

The idea is that, for any two databases over particular entity tags f and g, if we can take any entity in f and g to the corresponding entity in h (in the possibly effectful monad m), then we can transform the two databases over f and g to a database in h, within the monad m.

If that doesn't make sense, don't worry. This is mostly beam internal

type DatabaseSettings be db = db (DatabaseEntity be db)

When parameterized by this entity tag, a database type will hold meta-information on the Haskell mappings of database entities. Under the hood, each entity type is transformed into its DatabaseEntityDescriptor type. For tables this includes the table name as well as the corresponding TableSettings, which provides names for each column.

class RenamableWithRule (FieldRenamer (DatabaseEntityDescriptor be entityType)) => IsDatabaseEntity be entityType where

Associated Types

data DatabaseEntityDescriptor be entityType :: *

type DatabaseEntityDefaultRequirements be entityType :: Constraint

type DatabaseEntityRegularRequirements be entityType :: Constraint

Methods

dbEntityName :: Lens' (DatabaseEntityDescriptor be entityType) Text

dbEntitySchema :: Traversal' (DatabaseEntityDescriptor be entityType) (Maybe Text)

dbEntityAuto :: DatabaseEntityDefaultRequirements be entityType => Text -> DatabaseEntityDescriptor be entityType

Instances

IsDatabaseEntity be (DomainTypeEntity ty)

Defined in Database.Beam.Schema.Tables

Associated Types

data DatabaseEntityDescriptor be (DomainTypeEntity ty) :: Type

type DatabaseEntityDefaultRequirements be (DomainTypeEntity ty) :: Constraint

type DatabaseEntityRegularRequirements be (DomainTypeEntity ty) :: Constraint

Methods

dbEntityName :: Lens' (DatabaseEntityDescriptor be (DomainTypeEntity ty)) Text

dbEntitySchema :: Traversal' (DatabaseEntityDescriptor be (DomainTypeEntity ty)) (Maybe Text)

dbEntityAuto :: Text -> DatabaseEntityDescriptor be (DomainTypeEntity ty)

Beamable tbl => IsDatabaseEntity be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

Associated Types

data DatabaseEntityDescriptor be (ViewEntity tbl) :: Type

type DatabaseEntityDefaultRequirements be (ViewEntity tbl) :: Constraint

type DatabaseEntityRegularRequirements be (ViewEntity tbl) :: Constraint

Methods

dbEntityName :: Lens' (DatabaseEntityDescriptor be (ViewEntity tbl)) Text

dbEntitySchema :: Traversal' (DatabaseEntityDescriptor be (ViewEntity tbl)) (Maybe Text)

dbEntityAuto :: Text -> DatabaseEntityDescriptor be (ViewEntity tbl)

Beamable tbl => IsDatabaseEntity be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

Associated Types

data DatabaseEntityDescriptor be (TableEntity tbl) :: Type

type DatabaseEntityDefaultRequirements be (TableEntity tbl) :: Constraint

type DatabaseEntityRegularRequirements be (TableEntity tbl) :: Constraint

Methods

dbEntityName :: Lens' (DatabaseEntityDescriptor be (TableEntity tbl)) Text

dbEntitySchema :: Traversal' (DatabaseEntityDescriptor be (TableEntity tbl)) (Maybe Text)

dbEntityAuto :: Text -> DatabaseEntityDescriptor be (TableEntity tbl)

data DatabaseEntity be (db :: (* -> *) -> *) entityType where

Represents a meta-description of a particular entityType. Mostly, a wrapper around 'DatabaseEntityDescriptor be entityType', but carries around the IsDatabaseEntity dictionary.

Constructors

DatabaseEntity :: IsDatabaseEntity be entityType => DatabaseEntityDescriptor be entityType -> DatabaseEntity be db entityType

Instances

Database be db => RenamableWithRule (db (EntityModification (DatabaseEntity be db) be))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> db (EntityModification (DatabaseEntity be db) be)

IsDatabaseEntity be entity => RenamableWithRule (EntityModification (DatabaseEntity be db) be entity)

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> EntityModification (DatabaseEntity be db) be entity

data TableEntity (tbl :: (* -> *) -> *)

An entity tag for tables. See the documentation for Table or consult the manual for more.

Instances

Beamable tbl => IsDatabaseEntity be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

Associated Types

data DatabaseEntityDescriptor be (TableEntity tbl) :: Type

type DatabaseEntityDefaultRequirements be (TableEntity tbl) :: Constraint

type DatabaseEntityRegularRequirements be (TableEntity tbl) :: Constraint

Methods

dbEntityName :: Lens' (DatabaseEntityDescriptor be (TableEntity tbl)) Text

dbEntitySchema :: Traversal' (DatabaseEntityDescriptor be (TableEntity tbl)) (Maybe Text)

dbEntityAuto :: Text -> DatabaseEntityDescriptor be (TableEntity tbl)

Beamable tbl => RenamableWithRule (FieldRenamer (DatabaseEntityDescriptor be (TableEntity tbl)))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> FieldRenamer (DatabaseEntityDescriptor be (TableEntity tbl))

data DatabaseEntityDescriptor be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

data DatabaseEntityDescriptor be (TableEntity tbl) where

• DatabaseTable :: forall be (tbl :: (Type -> Type) -> Type). Table tbl => {..} -> DatabaseEntityDescriptor be (TableEntity tbl)

type DatabaseEntityDefaultRequirements be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityDefaultRequirements be (TableEntity tbl)

type DatabaseEntityRegularRequirements be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityRegularRequirements be (TableEntity tbl) = (Table tbl, Beamable tbl)

data ViewEntity (view :: (* -> *) -> *)

Instances

Beamable tbl => IsDatabaseEntity be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

Associated Types

data DatabaseEntityDescriptor be (ViewEntity tbl) :: Type

type DatabaseEntityDefaultRequirements be (ViewEntity tbl) :: Constraint

type DatabaseEntityRegularRequirements be (ViewEntity tbl) :: Constraint

Methods

dbEntityName :: Lens' (DatabaseEntityDescriptor be (ViewEntity tbl)) Text

dbEntitySchema :: Traversal' (DatabaseEntityDescriptor be (ViewEntity tbl)) (Maybe Text)

dbEntityAuto :: Text -> DatabaseEntityDescriptor be (ViewEntity tbl)

Beamable tbl => RenamableWithRule (FieldRenamer (DatabaseEntityDescriptor be (ViewEntity tbl)))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> FieldRenamer (DatabaseEntityDescriptor be (ViewEntity tbl))

data DatabaseEntityDescriptor be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

data DatabaseEntityDescriptor be (ViewEntity tbl) = DatabaseView {

• dbViewSchema :: Maybe Text
• dbViewOrigName :: Text
• dbViewCurrentName :: Text
• dbViewSettings :: TableSettings tbl

}

type DatabaseEntityDefaultRequirements be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityDefaultRequirements be (ViewEntity tbl)

type DatabaseEntityRegularRequirements be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityRegularRequirements be (ViewEntity tbl) = Beamable tbl

data DomainTypeEntity (ty :: *)

Instances

IsDatabaseEntity be (DomainTypeEntity ty)

Defined in Database.Beam.Schema.Tables

Associated Types

data DatabaseEntityDescriptor be (DomainTypeEntity ty) :: Type

type DatabaseEntityDefaultRequirements be (DomainTypeEntity ty) :: Constraint

type DatabaseEntityRegularRequirements be (DomainTypeEntity ty) :: Constraint

Methods

dbEntityName :: Lens' (DatabaseEntityDescriptor be (DomainTypeEntity ty)) Text

dbEntitySchema :: Traversal' (DatabaseEntityDescriptor be (DomainTypeEntity ty)) (Maybe Text)

dbEntityAuto :: Text -> DatabaseEntityDescriptor be (DomainTypeEntity ty)

RenamableWithRule (FieldRenamer (DatabaseEntityDescriptor be (DomainTypeEntity ty)))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> FieldRenamer (DatabaseEntityDescriptor be (DomainTypeEntity ty))

data DatabaseEntityDescriptor be (DomainTypeEntity ty)

Defined in Database.Beam.Schema.Tables

data DatabaseEntityDescriptor be (DomainTypeEntity ty) = DatabaseDomainType !(Maybe Text) !Text

type DatabaseEntityDefaultRequirements be (DomainTypeEntity ty)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityDefaultRequirements be (DomainTypeEntity ty) = ()

type DatabaseEntityRegularRequirements be (DomainTypeEntity ty)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityRegularRequirements be (DomainTypeEntity ty) = ()

dbEntityDescriptor :: SimpleGetter (DatabaseEntity be db entityType) (DatabaseEntityDescriptor be entityType)

type DatabaseModification f be db = db (EntityModification f be)

A helper data type that lets you modify a database schema. Converts all entities in the database into functions from that entity to itself.

newtype EntityModification f be e

A newtype wrapper around 'f e -> f e' (i.e., an endomorphism between entity types in f). You usually want to use modifyTable or another function to contstruct these for you.

Constructors

EntityModification (Endo (f e))

Instances

Database be db => RenamableWithRule (db (EntityModification (DatabaseEntity be db) be))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> db (EntityModification (DatabaseEntity be db) be)

Semigroup (EntityModification f be e)

Defined in Database.Beam.Schema.Tables

Methods

(<>) :: EntityModification f be e -> EntityModification f be e -> EntityModification f be e

sconcat :: NonEmpty (EntityModification f be e) -> EntityModification f be e

stimes :: Integral b => b -> EntityModification f be e -> EntityModification f be e

Monoid (EntityModification f be e)

Defined in Database.Beam.Schema.Tables

Methods

mempty :: EntityModification f be e

mappend :: EntityModification f be e -> EntityModification f be e -> EntityModification f be e

mconcat :: [EntityModification f be e] -> EntityModification f be e

IsDatabaseEntity be entity => RenamableWithRule (EntityModification (DatabaseEntity be db) be entity)

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> EntityModification (DatabaseEntity be db) be entity

newtype FieldModification f a

A newtype wrapper around 'Columnar f a -> Columnar f ' (i.e., an endomorphism between Columnars over f). You usually want to use fieldNamed or the IsString instance to rename the field, when 'f ~ TableField'

Constructors

FieldModification (Columnar f a -> Columnar f a)

Instances

(Beamable tbl, RenamableField f) => RenamableWithRule (tbl (FieldModification f))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> tbl (FieldModification f)

IsString (FieldModification (TableField tbl) a)

Defined in Database.Beam.Schema.Tables

Methods

fromString :: String -> FieldModification (TableField tbl) a

dbModification :: forall f be db. Database be db => DatabaseModification f be db

Return a DatabaseModification that does nothing. This is useful if you only want to rename one table. You can do

dbModification { tbl1 = modifyTable (\oldNm -> "NewTableName") tableModification }

tableModification :: forall f tbl. Beamable tbl => tbl (FieldModification f)

Return a table modification (for use with modifyTable) that does nothing. Useful if you only want to change the table name, or if you only want to modify a few fields.

For example,

tableModification { field1 = "Column1" }

is a table modification (where 'f ~ TableField tbl') that changes the column name of field1 to Column1.

withDbModification :: forall db be entity. Database be db => db (entity be db) -> DatabaseModification (entity be db) be db -> db (entity be db)

Modify a database according to a given modification. Most useful for DatabaseSettings to change the name mappings of tables and fields. For example, you can use this to modify the default names of a table

db :: DatabaseSettings MyDb
db = defaultDbSettings `withDbModification`
     dbModification {
       -- Change default name "table1" to "Table_1". Change the name of "table1Field1" to "first_name"
       table1 = modifyTable (\_ -> "Table_1") (tableModification { table1Field1 = "first_name" }
     }

withTableModification :: Beamable tbl => tbl (FieldModification f) -> tbl f -> tbl f

Modify a table according to the given field modifications. Invoked by modifyTable to apply the modification in the database. Not used as often in user code, but provided for completeness.

modifyTable :: (Beamable tbl, Table tbl) => (Text -> Text) -> tbl (FieldModification (TableField tbl)) -> EntityModification (DatabaseEntity be db) be (TableEntity tbl)

Deprecated: Instead of 'modifyTable fTblNm fFields', use 'modifyEntityName _ <> modifyTableFields _'

Provide an EntityModification for TableEntitys. Allows you to modify the name of the table and provide a modification for each field in the table. See the examples for withDbModification for more.

modifyEntityName :: IsDatabaseEntity be entity => (Text -> Text) -> EntityModification (DatabaseEntity be db) be entity

Construct an EntityModification to rename any database entity

setEntityName :: IsDatabaseEntity be entity => Text -> EntityModification (DatabaseEntity be db) be entity

Change the entity name without consulting the beam-assigned one

modifyTableFields :: tbl (FieldModification (TableField tbl)) -> EntityModification (DatabaseEntity be db) be (TableEntity tbl)

Construct an EntityModification to rename the fields of a TableEntity

fieldNamed :: Text -> FieldModification (TableField tbl) a

A field modification to rename the field. Also offered under the IsString instance for 'FieldModification (TableField tbl) a' for convenience.

defaultDbSettings :: (Generic (DatabaseSettings be db), GAutoDbSettings (Rep (DatabaseSettings be db) ())) => DatabaseSettings be db

Automatically provide names for tables, and descriptions for tables (using defTblFieldSettings). Your database must implement Generic, and must be auto-derivable. For more information on name generation, see the manual

class RenamableWithRule mod where

Methods

renamingFields :: (NonEmpty Text -> Text) -> mod

Instances

(Beamable tbl, RenamableField f) => RenamableWithRule (tbl (FieldModification f))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> tbl (FieldModification f)

Database be db => RenamableWithRule (db (EntityModification (DatabaseEntity be db) be))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> db (EntityModification (DatabaseEntity be db) be)

RenamableWithRule (FieldRenamer (DatabaseEntityDescriptor be (DomainTypeEntity ty)))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> FieldRenamer (DatabaseEntityDescriptor be (DomainTypeEntity ty))

Beamable tbl => RenamableWithRule (FieldRenamer (DatabaseEntityDescriptor be (ViewEntity tbl)))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> FieldRenamer (DatabaseEntityDescriptor be (ViewEntity tbl))

Beamable tbl => RenamableWithRule (FieldRenamer (DatabaseEntityDescriptor be (TableEntity tbl)))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> FieldRenamer (DatabaseEntityDescriptor be (TableEntity tbl))

IsDatabaseEntity be entity => RenamableWithRule (EntityModification (DatabaseEntity be db) be entity)

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> EntityModification (DatabaseEntity be db) be entity

class RenamableField f where

Methods

renameField :: Proxy f -> Proxy a -> (NonEmpty Text -> Text) -> Columnar f a -> Columnar f a

Instances

RenamableField (TableField tbl)

Defined in Database.Beam.Schema.Tables

Methods

renameField :: Proxy (TableField tbl) -> Proxy a -> (NonEmpty Text -> Text) -> Columnar (TableField tbl) a -> Columnar (TableField tbl) a

newtype FieldRenamer entity

Constructors

FieldRenamer

Fields

• withFieldRenamer :: entity -> entity

Instances

RenamableWithRule (FieldRenamer (DatabaseEntityDescriptor be (DomainTypeEntity ty)))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> FieldRenamer (DatabaseEntityDescriptor be (DomainTypeEntity ty))

Beamable tbl => RenamableWithRule (FieldRenamer (DatabaseEntityDescriptor be (ViewEntity tbl)))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> FieldRenamer (DatabaseEntityDescriptor be (ViewEntity tbl))

Beamable tbl => RenamableWithRule (FieldRenamer (DatabaseEntityDescriptor be (TableEntity tbl)))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> FieldRenamer (DatabaseEntityDescriptor be (TableEntity tbl))

data Lenses (t :: (* -> *) -> *) (f :: * -> *) x

data LensFor t x where

Constructors

LensFor :: Generic t => Lens' t x -> LensFor t x

Columnar and Column Tags

type family Columnar (f :: * -> *) x where ...

A type family that we use to "tag" columns in our table datatypes.

This is what allows us to use the same table type to hold table data, describe table settings, derive lenses, and provide expressions.

The basic rules are

Columnar Identity x = x

Thus, any Beam table applied to Identity will yield a simplified version of the data type, that contains just what you'd expect.

The Nullable type is used when referencing PrimaryKeys that we want to include optionally. For example, if we have a table with a PrimaryKey, like the following

data BeamTableT f = BeamTableT
                  { _refToAnotherTable :: PrimaryKey AnotherTableT f
                  , ... }

we would typically be required to provide values for the PrimaryKey embedded into BeamTableT. We can use Nullable to lift this constraint.

data BeamTableT f = BeamTableT
                  { _refToAnotherTable :: PrimaryKey AnotherTableT (Nullable f)
                  , ... }

Now we can use justRef and nothingRef to refer to this table optionally. The embedded PrimaryKey in _refToAnotherTable automatically has its fields converted into Maybe using Nullable.

The last Columnar rule is

Columnar f x = f x

Use this rule if you'd like to parameterize your table type over any other functor. For example, this is used in the query modules to write expressions such as 'TableT QExpr', which returns a table whose fields have been turned into query expressions.

The other rules are used within Beam to provide lenses and to expose the inner structure of the data type.

Equations

Columnar Exposed x = Exposed x

Columnar Identity x = x

Columnar (Lenses t f) x = LensFor (t f) (Columnar f x)

Columnar (Nullable c) x = Columnar c (Maybe x)

Columnar f x = f x

type C f a = Columnar f a

A short type-alias for Columnar. May shorten your schema definitions

newtype Columnar' f a

If you declare a function 'Columnar f a -> b' and try to constrain your function by a type class for f, GHC will complain, because f is ambiguous in 'Columnar f a'. For example, 'Columnar Identity (Maybe a) ~ Maybe a' and 'Columnar (Nullable Identity) a ~ Maybe a', so given a type 'Columnar f a', we cannot know the type of f.

Thus, if you need to know f, you can instead use Columnar'. Since its a newtype, it carries around the f paramater unambiguously. Internally, it simply wraps 'Columnar f a'

Constructors

Columnar' (Columnar f a)

newtype ComposeColumnar f g a

Like Compose, but with an intermediate Columnar

Constructors

ComposeColumnar (f (Columnar g a))

data Nullable (c :: * -> *) x

Support for NULLable Foreign Key references.

data MyTable f = MyTable
               { nullableRef :: PrimaryKey AnotherTable (Nullable f)
               , ... }
                deriving (Generic, Typeable)

See Columnar for more information.

Instances

Beamable t => ProjectibleWithPredicate AnyType () Text (t (Nullable (Const Text :: Type -> Type)))

Defined in Database.Beam.Query.Internal

Methods

project' :: Monad m => Proxy AnyType -> Proxy ((), Text) -> (forall context. AnyType context => Proxy context -> Proxy () -> Text -> m Text) -> t (Nullable (Const Text)) -> m (t (Nullable (Const Text)))

projectSkeleton' :: Monad m => Proxy AnyType -> Proxy ((), Text) -> (forall context. AnyType context => Proxy context -> Proxy () -> m Text) -> m (t (Nullable (Const Text)))

Beamable t => ProjectibleWithPredicate AnyType () Text (t (Nullable (QField s)))

Defined in Database.Beam.Query.Internal

Methods

project' :: Monad m => Proxy AnyType -> Proxy ((), Text) -> (forall context. AnyType context => Proxy context -> Proxy () -> Text -> m Text) -> t (Nullable (QField s)) -> m (t (Nullable (QField s)))

projectSkeleton' :: Monad m => Proxy AnyType -> Proxy ((), Text) -> (forall context. AnyType context => Proxy context -> Proxy () -> m Text) -> m (t (Nullable (QField s)))

(Beamable t, contextPredicate context) => ProjectibleWithPredicate contextPredicate be (WithExprContext (BeamSqlBackendExpressionSyntax' be)) (t (Nullable (QGenExpr context be s)))

Defined in Database.Beam.Query.Internal

Methods

project' :: Monad m => Proxy contextPredicate -> Proxy (be, WithExprContext (BeamSqlBackendExpressionSyntax' be)) -> (forall context0. contextPredicate context0 => Proxy context0 -> Proxy be -> WithExprContext (BeamSqlBackendExpressionSyntax' be) -> m (WithExprContext (BeamSqlBackendExpressionSyntax' be))) -> t (Nullable (QGenExpr context be s)) -> m (t (Nullable (QGenExpr context be s)))

projectSkeleton' :: Monad m => Proxy contextPredicate -> Proxy (be, WithExprContext (BeamSqlBackendExpressionSyntax' be)) -> (forall context0. contextPredicate context0 => Proxy context0 -> Proxy be -> m (WithExprContext (BeamSqlBackendExpressionSyntax' be))) -> m (t (Nullable (QGenExpr context be s)))

(BeamBackend be, Generic (tbl (Nullable Identity)), Generic (tbl (Nullable Exposed)), GFromBackendRow be (Rep (tbl (Nullable Exposed))) (Rep (tbl (Nullable Identity)))) => FromBackendRow be (tbl (Nullable Identity))

Defined in Database.Beam.Backend.SQL.Row

Methods

fromBackendRow :: FromBackendRowM be (tbl (Nullable Identity))

valuesNeeded :: Proxy be -> Proxy (tbl (Nullable Identity)) -> Int

Beamable tbl => ThreadRewritable s (tbl (Nullable (QGenExpr ctxt syntax s)))

Defined in Database.Beam.Query.Internal

Associated Types

type WithRewrittenThread s s' (tbl (Nullable (QGenExpr ctxt syntax s))) :: Type

Methods

rewriteThread :: Proxy s' -> tbl (Nullable (QGenExpr ctxt syntax s)) -> WithRewrittenThread s s' (tbl (Nullable (QGenExpr ctxt syntax s)))

(BeamSqlBackend be, Beamable t) => SqlDeconstructMaybe be (t (Nullable (QGenExpr ctxt be s))) (t (QGenExpr ctxt be s)) s

Defined in Database.Beam.Query.Combinators

Methods

isJust_ :: t (Nullable (QGenExpr ctxt be s)) -> QGenExpr ctxt0 be s Bool

isNothing_ :: t (Nullable (QGenExpr ctxt be s)) -> QGenExpr ctxt0 be s Bool

maybe_ :: QGenExpr ctxt0 be s y -> (t (QGenExpr ctxt be s) -> QGenExpr ctxt0 be s y) -> t (Nullable (QGenExpr ctxt be s)) -> QGenExpr ctxt0 be s y

FieldsFulfillConstraintNullable c t => GFieldsFulfillConstraint c (K1 R (t (Nullable Exposed)) :: Type -> Type) (K1 R (t (Nullable Identity)) :: Type -> Type) (K1 R (t (Nullable (WithConstraint c))) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t (Nullable Exposed))) -> K1 R (t (Nullable Identity)) () -> K1 R (t (Nullable (WithConstraint c))) ()

Beamable tbl => ContextRewritable (tbl (Nullable (QGenExpr old syntax s)))

Defined in Database.Beam.Query.Internal

Associated Types

type WithRewrittenContext (tbl (Nullable (QGenExpr old syntax s))) ctxt :: Type

Methods

rewriteContext :: Proxy ctxt -> tbl (Nullable (QGenExpr old syntax s)) -> WithRewrittenContext (tbl (Nullable (QGenExpr old syntax s))) ctxt

(Beamable table, BeamSqlBackend be, FieldsFulfillConstraintNullable (BeamSqlBackendCanSerialize be) table) => SqlValable (table (Nullable (QGenExpr ctxt be s)))

Defined in Database.Beam.Query.Combinators

Methods

val_ :: HaskellLiteralForQExpr (table (Nullable (QGenExpr ctxt be s))) -> table (Nullable (QGenExpr ctxt be s))

TagReducesTo f f' => TagReducesTo (Nullable f) f'

Defined in Database.Beam.Schema.Tables

Methods

reduceTag :: Functor m => (Columnar' f' a' -> m (Columnar' f' a')) -> Columnar' (Nullable f) a -> m (Columnar' (Nullable f) a)

Table t => SqlJustable (t Identity) (t (Nullable Identity))

Defined in Database.Beam.Query.Combinators

Methods

just_ :: t Identity -> t (Nullable Identity)

nothing_ :: t (Nullable Identity)

(Table t, BeamSqlBackend be) => SqlJustable (t (QExpr be s)) (t (Nullable (QExpr be s)))

Defined in Database.Beam.Query.Combinators

Methods

just_ :: t (QExpr be s) -> t (Nullable (QExpr be s))

nothing_ :: t (Nullable (QExpr be s))

Beamable tbl => QGroupable (tbl (Nullable (QExpr be s))) (tbl (Nullable (QGroupExpr be s)))

group_ for any Beamable type. Adds every field in the type to the grouping key. This is the equivalent of including the grouping expression of each field in the type as part of the aggregate projection

Defined in Database.Beam.Query.Aggregate

Methods

group_ :: tbl (Nullable (QExpr be s)) -> tbl (Nullable (QGroupExpr be s))

Table t => SqlJustable (PrimaryKey t Identity) (PrimaryKey t (Nullable Identity))

Defined in Database.Beam.Query.Combinators

Methods

just_ :: PrimaryKey t Identity -> PrimaryKey t (Nullable Identity)

nothing_ :: PrimaryKey t (Nullable Identity)

(Table t, BeamSqlBackend be) => SqlJustable (PrimaryKey t (QExpr be s)) (PrimaryKey t (Nullable (QExpr be s)))

Defined in Database.Beam.Query.Combinators

Methods

just_ :: PrimaryKey t (QExpr be s) -> PrimaryKey t (Nullable (QExpr be s))

nothing_ :: PrimaryKey t (Nullable (QExpr be s))

(BeamSqlBackend be, Beamable tbl, FieldsFulfillConstraintNullable (HasSqlEqualityCheck be) tbl) => SqlEq (QGenExpr context be s) (tbl (Nullable (QGenExpr context be s)))

Defined in Database.Beam.Query.Ord

Methods

(==.) :: tbl (Nullable (QGenExpr context be s)) -> tbl (Nullable (QGenExpr context be s)) -> QGenExpr context be s Bool

(/=.) :: tbl (Nullable (QGenExpr context be s)) -> tbl (Nullable (QGenExpr context be s)) -> QGenExpr context be s Bool

(==?.) :: tbl (Nullable (QGenExpr context be s)) -> tbl (Nullable (QGenExpr context be s)) -> QGenExpr context be s SqlBool

(/=?.) :: tbl (Nullable (QGenExpr context be s)) -> tbl (Nullable (QGenExpr context be s)) -> QGenExpr context be s SqlBool

type WithRewrittenThread s s' (tbl (Nullable (QGenExpr ctxt syntax s)))

Defined in Database.Beam.Query.Internal

type WithRewrittenThread s s' (tbl (Nullable (QGenExpr ctxt syntax s))) = tbl (Nullable (QGenExpr ctxt syntax s'))

type QExprToField (table (Nullable (QGenExpr context syntax s)))

Defined in Database.Beam.Query.Types

type QExprToField (table (Nullable (QGenExpr context syntax s))) = table (Nullable (QField s))

type QExprToIdentity (table (Nullable c))

Defined in Database.Beam.Query.Types

type QExprToIdentity (table (Nullable c)) = Maybe (QExprToIdentity (table c))

type HaskellLiteralForQExpr (table (Nullable f))

Defined in Database.Beam.Query.Combinators

type HaskellLiteralForQExpr (table (Nullable f))

type WithRewrittenContext (tbl (Nullable (QGenExpr old syntax s))) ctxt

Defined in Database.Beam.Query.Internal

type WithRewrittenContext (tbl (Nullable (QGenExpr old syntax s))) ctxt = tbl (Nullable (QGenExpr ctxt syntax s))

data TableField (table :: (* -> *) -> *) ty

Metadata for a field of type ty in table.

Essentially a wrapper over the field name, but with a phantom type parameter, so that it forms an appropriate column tag.

Usually you use the defaultDbSettings function to generate an appropriate naming convention for you, and then modify it with withDbModification if necessary. Under this scheme, the field n be renamed using the IsString instance for TableField, or the fieldNamed function.

Constructors

TableField

Fields

• _fieldPath :: NonEmpty Text

  The path that led to this field. Each element is the haskell name of the record field in which this table is stored.

• _fieldName :: Text

  The field name

Instances

RenamableField (TableField tbl)

Defined in Database.Beam.Schema.Tables

Methods

renameField :: Proxy (TableField tbl) -> Proxy a -> (NonEmpty Text -> Text) -> Columnar (TableField tbl) a -> Columnar (TableField tbl) a

TagReducesTo (TableField tbl) (TableField tbl)

Defined in Database.Beam.Schema.Tables

Methods

reduceTag :: Functor m => (Columnar' (TableField tbl) a' -> m (Columnar' (TableField tbl) a')) -> Columnar' (TableField tbl) a -> m (Columnar' (TableField tbl) a)

Eq (TableField table ty)

Defined in Database.Beam.Schema.Tables

Methods

(==) :: TableField table ty -> TableField table ty -> Bool

(/=) :: TableField table ty -> TableField table ty -> Bool

Show (TableField table ty)

Defined in Database.Beam.Schema.Tables

Methods

showsPrec :: Int -> TableField table ty -> ShowS

show :: TableField table ty -> String

showList :: [TableField table ty] -> ShowS

IsString (FieldModification (TableField tbl) a)

Defined in Database.Beam.Schema.Tables

Methods

fromString :: String -> FieldModification (TableField tbl) a

data Exposed x

newtype mainly used to inspect the tag structure of a particular Beamable. Prevents overlapping instances in some case. Usually not used in end-user code.

Instances

FieldsFulfillConstraintNullable c t => GFieldsFulfillConstraint c (K1 R (t (Nullable Exposed)) :: Type -> Type) (K1 R (t (Nullable Identity)) :: Type -> Type) (K1 R (t (Nullable (WithConstraint c))) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t (Nullable Exposed))) -> K1 R (t (Nullable Identity)) () -> K1 R (t (Nullable (WithConstraint c))) ()

FieldsFulfillConstraint c t => GFieldsFulfillConstraint c (K1 R (t Exposed) :: Type -> Type) (K1 R (t Identity) :: Type -> Type) (K1 R (t (WithConstraint c)) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t Exposed)) -> K1 R (t Identity) () -> K1 R (t (WithConstraint c)) ()

c x => GFieldsFulfillConstraint c (K1 R (Exposed x) :: Type -> Type) (K1 R x :: Type -> Type) (K1 R (WithConstraint c x) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (Exposed x)) -> K1 R x () -> K1 R (WithConstraint c x) ()

fieldName :: Lens' (TableField table ty) Text

Van Laarhoven lens to retrieve or set the field name from a TableField.

fieldPath :: Traversal' (TableField table ty) Text

type TableSettings table = table (TableField table)

Represents a table that contains metadata on its fields. In particular, each field of type 'Columnar f a' is transformed into 'TableField table a'. You can get or update the name of each field by using the fieldName lens.

type HaskellTable table = table Identity

The regular Haskell version of the table. Equivalent to 'tbl Identity'

type TableSkeleton table = table Ignored

A form of table all fields Ignored. Useful as a parameter to zipTables when you only care about one table.

data Ignored x

Column tag that ignores the type.

Constructors

Ignored

class GFieldsFulfillConstraint (c :: * -> Constraint) (exposed :: * -> *) values withconstraint where

Methods

gWithConstrainedFields :: Proxy c -> Proxy exposed -> values () -> withconstraint ()

Instances

GFieldsFulfillConstraint c (U1 :: Type -> Type) (U1 :: Type -> Type) (U1 :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy U1 -> U1 () -> U1 ()

FieldsFulfillConstraintNullable c t => GFieldsFulfillConstraint c (K1 R (t (Nullable Exposed)) :: Type -> Type) (K1 R (t (Nullable Identity)) :: Type -> Type) (K1 R (t (Nullable (WithConstraint c))) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t (Nullable Exposed))) -> K1 R (t (Nullable Identity)) () -> K1 R (t (Nullable (WithConstraint c))) ()

FieldsFulfillConstraint c t => GFieldsFulfillConstraint c (K1 R (t Exposed) :: Type -> Type) (K1 R (t Identity) :: Type -> Type) (K1 R (t (WithConstraint c)) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t Exposed)) -> K1 R (t Identity) () -> K1 R (t (WithConstraint c)) ()

c x => GFieldsFulfillConstraint c (K1 R (Exposed x) :: Type -> Type) (K1 R x :: Type -> Type) (K1 R (WithConstraint c x) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (Exposed x)) -> K1 R x () -> K1 R (WithConstraint c x) ()

(GFieldsFulfillConstraint c aExp a aC, GFieldsFulfillConstraint c bExp b bC) => GFieldsFulfillConstraint c (aExp :*: bExp) (a :*: b) (aC :*: bC)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (aExp :*: bExp) -> (a :*: b) () -> (aC :*: bC) ()

GFieldsFulfillConstraint c exposed values withconstraint => GFieldsFulfillConstraint c (M1 s m exposed) (M1 s m values) (M1 s m withconstraint)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (M1 s m exposed) -> M1 s m values () -> M1 s m withconstraint ()

type FieldsFulfillConstraint (c :: * -> Constraint) t = (Generic (t (WithConstraint c)), Generic (t Identity), Generic (t Exposed), GFieldsFulfillConstraint c (Rep (t Exposed)) (Rep (t Identity)) (Rep (t (WithConstraint c))))

type FieldsFulfillConstraintNullable (c :: * -> Constraint) t = (Generic (t (Nullable (WithConstraint c))), Generic (t (Nullable Identity)), Generic (t (Nullable Exposed)), GFieldsFulfillConstraint c (Rep (t (Nullable Exposed))) (Rep (t (Nullable Identity))) (Rep (t (Nullable (WithConstraint c)))))

data WithConstraint (c :: * -> Constraint) x where

Constructors

WithConstraint :: c x => x -> WithConstraint c x

Instances

FieldsFulfillConstraintNullable c t => GFieldsFulfillConstraint c (K1 R (t (Nullable Exposed)) :: Type -> Type) (K1 R (t (Nullable Identity)) :: Type -> Type) (K1 R (t (Nullable (WithConstraint c))) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t (Nullable Exposed))) -> K1 R (t (Nullable Identity)) () -> K1 R (t (Nullable (WithConstraint c))) ()

FieldsFulfillConstraint c t => GFieldsFulfillConstraint c (K1 R (t Exposed) :: Type -> Type) (K1 R (t Identity) :: Type -> Type) (K1 R (t (WithConstraint c)) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t Exposed)) -> K1 R (t Identity) () -> K1 R (t (WithConstraint c)) ()

c x => GFieldsFulfillConstraint c (K1 R (Exposed x) :: Type -> Type) (K1 R x :: Type -> Type) (K1 R (WithConstraint c x) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (Exposed x)) -> K1 R x () -> K1 R (WithConstraint c x) ()

class TagReducesTo f f' | f -> f' where

Class to automatically unwrap nested Nullables

Methods

reduceTag :: Functor m => (Columnar' f' a' -> m (Columnar' f' a')) -> Columnar' f a -> m (Columnar' f a)

Instances

TagReducesTo f f' => TagReducesTo (Nullable f) f'

Defined in Database.Beam.Schema.Tables

Methods

reduceTag :: Functor m => (Columnar' f' a' -> m (Columnar' f' a')) -> Columnar' (Nullable f) a -> m (Columnar' (Nullable f) a)

TagReducesTo (TableField tbl) (TableField tbl)

Defined in Database.Beam.Schema.Tables

Methods

reduceTag :: Functor m => (Columnar' (TableField tbl) a' -> m (Columnar' (TableField tbl) a')) -> Columnar' (TableField tbl) a -> m (Columnar' (TableField tbl) a)

type family ReplaceBaseTag tag f where ...

Equations

ReplaceBaseTag tag (Nullable f) = Nullable (ReplaceBaseTag tag f)

ReplaceBaseTag tag x = tag

withConstrainedFields :: forall c tbl. FieldsFulfillConstraint c tbl => tbl Identity -> tbl (WithConstraint c)

withConstraints :: forall c tbl. (Beamable tbl, FieldsFulfillConstraint c tbl) => tbl (WithConstraint c)

withNullableConstrainedFields :: forall c tbl. FieldsFulfillConstraintNullable c tbl => tbl (Nullable Identity) -> tbl (Nullable (WithConstraint c))

withNullableConstraints :: forall c tbl. (Beamable tbl, FieldsFulfillConstraintNullable c tbl) => tbl (Nullable (WithConstraint c))

Tables

class (Typeable table, Beamable table, Beamable (PrimaryKey table)) => Table (table :: (* -> *) -> *) where

The big Kahuna! All beam tables implement this class.

The kind of all table types is '(* -> *) -> *'. This is because all table types are actually table type constructors. Every table type takes in another type constructor, called the column tag, and uses that constructor to instantiate the column types. See the documentation for Columnar.

This class is mostly Generic-derivable. You need only specify a type for the table's primary key and a method to extract the primary key given the table.

An example table:

data BlogPostT f = BlogPost
                 { _blogPostSlug    :: Columnar f Text
                 , _blogPostBody    :: Columnar f Text
                 , _blogPostDate    :: Columnar f UTCTime
                 , _blogPostAuthor  :: PrimaryKey AuthorT f
                 , _blogPostTagline :: Columnar f (Maybe Text)
                 , _blogPostImageGallery :: PrimaryKey ImageGalleryT (Nullable f) }
                   deriving Generic
instance Beamable BlogPostT
instance Table BlogPostT where
   data PrimaryKey BlogPostT f = BlogPostId (Columnar f Text) deriving Generic
   primaryKey = BlogPostId . _blogPostSlug
instance Beamable (PrimaryKey BlogPostT)

We can interpret this as follows:

• The _blogPostSlug, _blogPostBody, _blogPostDate, and _blogPostTagline fields are of types ErrorMessage, ErrorMessage, UTCTime, and 'Maybe Text' respectfully.
• Since _blogPostSlug, _blogPostBody, _blogPostDate, _blogPostAuthor must be provided (i.e, they cannot contain Nothing), they will be given SQL NOT NULL constraints. _blogPostTagline is declared Maybe so Nothing will be stored as NULL in the database. _blogPostImageGallery will be allowed to be empty because it uses the Nullable tag modifier.
• blogPostAuthor references the AuthorT table (not given here) and is required.
• blogPostImageGallery references the ImageGalleryT table (not given here), but this relation is not required (i.e., it may be Nothing. See Nullable).

Associated Types

data PrimaryKey table (column :: * -> *) :: *

A data type representing the types of primary keys for this table. In order to play nicely with the default deriving mechanism, this type must be an instance of Generic.

Methods

primaryKey :: table column -> PrimaryKey table column

Given a table, this should return the PrimaryKey from the table. By keeping this polymorphic over column, we ensure that the primary key values come directly from the table (i.e., they can't be arbitrary constants)

class Beamable table where

Provides a number of introspection routines for the beam library. Allows us to "zip" tables with different column tags together. Always instantiate an empty Beamable instance for tables, primary keys, and any type that you would like to embed within either. See the manual for more information on embedding.

Minimal complete definition

Nothing

Methods

zipBeamFieldsM :: Applicative m => (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> table f -> table g -> m (table h)

zipBeamFieldsM :: (HasBeamFields table f g h, Applicative m) => (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> table f -> table g -> m (table h)

tblSkeleton :: TableSkeleton table

tblSkeleton :: (Generic (TableSkeleton table), GTableSkeleton (Rep (TableSkeleton table))) => TableSkeleton table

class Retaggable f x | x -> f where

Associated Types

type Retag (tag :: (* -> *) -> * -> *) x :: *

Methods

retag :: (forall a. Columnar' f a -> Columnar' (tag f) a) -> x -> Retag tag x

Instances

Beamable tbl => Retaggable f (tbl f)

Defined in Database.Beam.Schema.Tables

Associated Types

type Retag tag (tbl f) :: Type

Methods

retag :: (forall a. Columnar' f a -> Columnar' (tag f) a) -> tbl f -> Retag tag (tbl f)

(Retaggable f a, Retaggable f b) => Retaggable f (a, b)

Defined in Database.Beam.Schema.Tables

Associated Types

type Retag tag (a, b) :: Type

Methods

retag :: (forall a0. Columnar' f a0 -> Columnar' (tag f) a0) -> (a, b) -> Retag tag (a, b)

(Retaggable f a, Retaggable f b, Retaggable f c) => Retaggable f (a, b, c)

Defined in Database.Beam.Schema.Tables

Associated Types

type Retag tag (a, b, c) :: Type

Methods

retag :: (forall a0. Columnar' f a0 -> Columnar' (tag f) a0) -> (a, b, c) -> Retag tag (a, b, c)

(Retaggable f a, Retaggable f b, Retaggable f c, Retaggable f d) => Retaggable f (a, b, c, d)

Defined in Database.Beam.Schema.Tables

Associated Types

type Retag tag (a, b, c, d) :: Type

Methods

retag :: (forall a0. Columnar' f a0 -> Columnar' (tag f) a0) -> (a, b, c, d) -> Retag tag (a, b, c, d)

(Retaggable f a, Retaggable f b, Retaggable f c, Retaggable f d, Retaggable f e) => Retaggable f (a, b, c, d, e)

Defined in Database.Beam.Schema.Tables

Associated Types

type Retag tag (a, b, c, d, e) :: Type

Methods

retag :: (forall a0. Columnar' f a0 -> Columnar' (tag f) a0) -> (a, b, c, d, e) -> Retag tag (a, b, c, d, e)

(Retaggable f' a, Retaggable f' b, Retaggable f' c, Retaggable f' d, Retaggable f' e, Retaggable f' f) => Retaggable f' (a, b, c, d, e, f)

Defined in Database.Beam.Schema.Tables

Associated Types

type Retag tag (a, b, c, d, e, f) :: Type

Methods

retag :: (forall a0. Columnar' f' a0 -> Columnar' (tag f') a0) -> (a, b, c, d, e, f) -> Retag tag (a, b, c, d, e, f)

(Retaggable f' a, Retaggable f' b, Retaggable f' c, Retaggable f' d, Retaggable f' e, Retaggable f' f, Retaggable f' g) => Retaggable f' (a, b, c, d, e, f, g)

Defined in Database.Beam.Schema.Tables

Associated Types

type Retag tag (a, b, c, d, e, f, g) :: Type

Methods

retag :: (forall a0. Columnar' f' a0 -> Columnar' (tag f') a0) -> (a, b, c, d, e, f, g) -> Retag tag (a, b, c, d, e, f, g)

(Retaggable f' a, Retaggable f' b, Retaggable f' c, Retaggable f' d, Retaggable f' e, Retaggable f' f, Retaggable f' g, Retaggable f' h) => Retaggable f' (a, b, c, d, e, f, g, h)

Defined in Database.Beam.Schema.Tables

Associated Types

type Retag tag (a, b, c, d, e, f, g, h) :: Type

Methods

retag :: (forall a0. Columnar' f' a0 -> Columnar' (tag f') a0) -> (a, b, c, d, e, f, g, h) -> Retag tag (a, b, c, d, e, f, g, h)

Retaggable (QGenExpr ctxt expr s) (QGenExpr ctxt expr s t)

Defined in Database.Beam.Query.Internal

Associated Types

type Retag tag (QGenExpr ctxt expr s t) :: Type

Methods

retag :: (forall a. Columnar' (QGenExpr ctxt expr s) a -> Columnar' (tag (QGenExpr ctxt expr s)) a) -> QGenExpr ctxt expr s t -> Retag tag (QGenExpr ctxt expr s t)

data ((f :: k -> Type) :*: (g :: k -> Type)) (p :: k) :: forall k. (k -> Type) -> (k -> Type) -> k -> Type infixr 6

Products: encode multiple arguments to constructors

Constructors

(f p) :*: (g p) infixr 6

Instances

(Monoid pairs, RecordToPairs enc pairs arity a, RecordToPairs enc pairs arity b) => RecordToPairs enc pairs arity (a :*: b)

Defined in Data.Aeson.Types.ToJSON

Methods

recordToPairs :: Options -> ToArgs enc arity a0 -> (a :*: b) a0 -> pairs

(EncodeProduct arity a, EncodeProduct arity b) => GToJSON Encoding arity (a :*: b)

Defined in Data.Aeson.Types.ToJSON

Methods

gToJSON :: Options -> ToArgs Encoding arity a0 -> (a :*: b) a0 -> Encoding

(WriteProduct arity a, WriteProduct arity b, ProductSize a, ProductSize b) => GToJSON Value arity (a :*: b)

Defined in Data.Aeson.Types.ToJSON

Methods

gToJSON :: Options -> ToArgs Value arity a0 -> (a :*: b) a0 -> Value

Generic1 (f :*: g :: k -> Type)

Defined in GHC.Generics

Associated Types

type Rep1 (f :*: g) :: k -> Type

Methods

from1 :: (f :*: g) a -> Rep1 (f :*: g) a

to1 :: Rep1 (f :*: g) a -> (f :*: g) a

(FromProduct arity a, FromProduct arity b, ProductSize a, ProductSize b) => GFromJSON arity (a :*: b)

Defined in Data.Aeson.Types.FromJSON

Methods

gParseJSON :: Options -> FromArgs arity a0 -> Value -> Parser ((a :*: b) a0)

(EncodeProduct arity a, EncodeProduct arity b) => EncodeProduct arity (a :*: b)

Defined in Data.Aeson.Types.ToJSON

Methods

encodeProduct :: Options -> ToArgs Encoding arity a0 -> (a :*: b) a0 -> Encoding' InArray

(WriteProduct arity a, WriteProduct arity b) => WriteProduct arity (a :*: b)

Defined in Data.Aeson.Types.ToJSON

Methods

writeProduct :: Options -> ToArgs Value arity a0 -> MVector s Value -> Int -> Int -> (a :*: b) a0 -> ST s ()

(FromRecord arity a, FromRecord arity b) => FromRecord arity (a :*: b)

Defined in Data.Aeson.Types.FromJSON

Methods

parseRecord :: Options -> FromArgs arity a0 -> Object -> Parser ((a :*: b) a0)

(FromProduct arity a, FromProduct arity b) => FromProduct arity (a :*: b)

Defined in Data.Aeson.Types.FromJSON

Methods

parseProduct :: Options -> FromArgs arity a0 -> Array -> Int -> Int -> Parser ((a :*: b) a0)

(GFieldsFulfillConstraint c aExp a aC, GFieldsFulfillConstraint c bExp b bC) => GFieldsFulfillConstraint c (aExp :*: bExp) (a :*: b) (aC :*: bC)

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (aExp :*: bExp) -> (a :*: b) () -> (aC :*: bC) ()

(Monad f, Monad g) => Monad (f :*: g)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

(>>=) :: (f :*: g) a -> (a -> (f :*: g) b) -> (f :*: g) b

(>>) :: (f :*: g) a -> (f :*: g) b -> (f :*: g) b

return :: a -> (f :*: g) a

fail :: String -> (f :*: g) a

(Functor f, Functor g) => Functor (f :*: g)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

fmap :: (a -> b) -> (f :*: g) a -> (f :*: g) b

(<$) :: a -> (f :*: g) b -> (f :*: g) a

(MonadFix f, MonadFix g) => MonadFix (f :*: g)

Since: base-4.9.0.0

Defined in Control.Monad.Fix

Methods

mfix :: (a -> (f :*: g) a) -> (f :*: g) a

(Applicative f, Applicative g) => Applicative (f :*: g)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

pure :: a -> (f :*: g) a

(<*>) :: (f :*: g) (a -> b) -> (f :*: g) a -> (f :*: g) b

liftA2 :: (a -> b -> c) -> (f :*: g) a -> (f :*: g) b -> (f :*: g) c

(*>) :: (f :*: g) a -> (f :*: g) b -> (f :*: g) b

(<*) :: (f :*: g) a -> (f :*: g) b -> (f :*: g) a

(Foldable f, Foldable g) => Foldable (f :*: g)

Since: base-4.9.0.0

Defined in Data.Foldable

Methods

fold :: Monoid m => (f :*: g) m -> m

foldMap :: Monoid m => (a -> m) -> (f :*: g) a -> m

foldr :: (a -> b -> b) -> b -> (f :*: g) a -> b

foldr' :: (a -> b -> b) -> b -> (f :*: g) a -> b

foldl :: (b -> a -> b) -> b -> (f :*: g) a -> b

foldl' :: (b -> a -> b) -> b -> (f :*: g) a -> b

foldr1 :: (a -> a -> a) -> (f :*: g) a -> a

foldl1 :: (a -> a -> a) -> (f :*: g) a -> a

toList :: (f :*: g) a -> [a]

null :: (f :*: g) a -> Bool

length :: (f :*: g) a -> Int

elem :: Eq a => a -> (f :*: g) a -> Bool

maximum :: Ord a => (f :*: g) a -> a

minimum :: Ord a => (f :*: g) a -> a

sum :: Num a => (f :*: g) a -> a

product :: Num a => (f :*: g) a -> a

(Traversable f, Traversable g) => Traversable (f :*: g)

Since: base-4.9.0.0

Defined in Data.Traversable

Methods

traverse :: Applicative f0 => (a -> f0 b) -> (f :*: g) a -> f0 ((f :*: g) b)

sequenceA :: Applicative f0 => (f :*: g) (f0 a) -> f0 ((f :*: g) a)

mapM :: Monad m => (a -> m b) -> (f :*: g) a -> m ((f :*: g) b)

sequence :: Monad m => (f :*: g) (m a) -> m ((f :*: g) a)

(Representable f, Representable g) => Representable (f :*: g)

Defined in Data.Functor.Rep

Associated Types

type Rep (f :*: g) :: Type

Methods

tabulate :: (Rep (f :*: g) -> a) -> (f :*: g) a

index :: (f :*: g) a -> Rep (f :*: g) -> a

(Alternative f, Alternative g) => Alternative (f :*: g)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

empty :: (f :*: g) a

(<|>) :: (f :*: g) a -> (f :*: g) a -> (f :*: g) a

some :: (f :*: g) a -> (f :*: g) [a]

many :: (f :*: g) a -> (f :*: g) [a]

(MonadPlus f, MonadPlus g) => MonadPlus (f :*: g)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

mzero :: (f :*: g) a

mplus :: (f :*: g) a -> (f :*: g) a -> (f :*: g) a

(GIndex f, GIndex g) => GIndex (f :*: g)

Defined in Data.Functor.Rep

Methods

gindex' :: (f :*: g) a -> GRep' (f :*: g) -> a

(GTabulate f, GTabulate g) => GTabulate (f :*: g)

Defined in Data.Functor.Rep

Methods

gtabulate' :: (GRep' (f :*: g) -> a) -> (f :*: g) a

(Eq (f p), Eq (g p)) => Eq ((f :*: g) p)

Since: base-4.7.0.0

Defined in GHC.Generics

Methods

(==) :: (f :*: g) p -> (f :*: g) p -> Bool

(/=) :: (f :*: g) p -> (f :*: g) p -> Bool

(Ord (f p), Ord (g p)) => Ord ((f :*: g) p)

Since: base-4.7.0.0

Defined in GHC.Generics

Methods

compare :: (f :*: g) p -> (f :*: g) p -> Ordering

(<) :: (f :*: g) p -> (f :*: g) p -> Bool

(<=) :: (f :*: g) p -> (f :*: g) p -> Bool

(>) :: (f :*: g) p -> (f :*: g) p -> Bool

(>=) :: (f :*: g) p -> (f :*: g) p -> Bool

max :: (f :*: g) p -> (f :*: g) p -> (f :*: g) p

min :: (f :*: g) p -> (f :*: g) p -> (f :*: g) p

(Read (f p), Read (g p)) => Read ((f :*: g) p)

Since: base-4.7.0.0

Defined in GHC.Generics

Methods

readsPrec :: Int -> ReadS ((f :*: g) p)

readList :: ReadS [(f :*: g) p]

readPrec :: ReadPrec ((f :*: g) p)

readListPrec :: ReadPrec [(f :*: g) p]

(Show (f p), Show (g p)) => Show ((f :*: g) p)

Since: base-4.7.0.0

Defined in GHC.Generics

Methods

showsPrec :: Int -> (f :*: g) p -> ShowS

show :: (f :*: g) p -> String

showList :: [(f :*: g) p] -> ShowS

Generic ((f :*: g) p)

Defined in GHC.Generics

Associated Types

type Rep ((f :*: g) p) :: Type -> Type

Methods

from :: (f :*: g) p -> Rep ((f :*: g) p) x

to :: Rep ((f :*: g) p) x -> (f :*: g) p

(Semigroup (f p), Semigroup (g p)) => Semigroup ((f :*: g) p)

Since: base-4.12.0.0

Defined in GHC.Generics

Methods

(<>) :: (f :*: g) p -> (f :*: g) p -> (f :*: g) p

sconcat :: NonEmpty ((f :*: g) p) -> (f :*: g) p

stimes :: Integral b => b -> (f :*: g) p -> (f :*: g) p

(Monoid (f p), Monoid (g p)) => Monoid ((f :*: g) p)

Since: base-4.12.0.0

Defined in GHC.Generics

Methods

mempty :: (f :*: g) p

mappend :: (f :*: g) p -> (f :*: g) p -> (f :*: g) p

mconcat :: [(f :*: g) p] -> (f :*: g) p

type Rep1 (f :*: g :: k -> Type)

Since: base-4.9.0.0

Defined in GHC.Generics

type Rep1 (f :*: g :: k -> Type) = D1 (MetaData ":*:" "GHC.Generics" "base" False) (C1 (MetaCons ":*:" (InfixI RightAssociative 6) False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec1 f) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec1 g)))

type Rep (f :*: g)

Defined in Data.Functor.Rep

type Rep (f :*: g) = Either (Rep f) (Rep g)

type GRep' (f :*: g)

Defined in Data.Functor.Rep

type GRep' (f :*: g) = Either (GRep' f) (GRep' g)

type Rep ((f :*: g) p)

Since: base-4.7.0.0

Defined in GHC.Generics

type Rep ((f :*: g) p) = D1 (MetaData ":*:" "GHC.Generics" "base" False) (C1 (MetaCons ":*:" (InfixI RightAssociative 6) False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (f p)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (g p))))

defTblFieldSettings :: (Generic (TableSettings table), GDefaultTableFieldSettings (Rep (TableSettings table) ())) => TableSettings table

Return a TableSettings for the appropriate table type where each column has been given its default name. See the manual for information on the default naming convention.

tableValuesNeeded :: Beamable table => Proxy table -> Int

pk :: Table t => t f -> PrimaryKey t f

Synonym for primaryKey

allBeamValues :: Beamable table => (forall a. Columnar' f a -> b) -> table f -> [b]

changeBeamRep :: Beamable table => (forall a. Columnar' f a -> Columnar' g a) -> table f -> table g

alongsideTable :: Beamable tbl => tbl f -> tbl g -> tbl (Columnar' f :*: Columnar' g)

defaultFieldName :: NonEmpty Text -> Text

Produce the beam default field name for the given path