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 :: (Type -> Type) -> Type)

Allows introspection into database types.

All database types must be of kind '(Type -> Type) -> Type'. 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, Applicative 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 applicative functor m), then we can transform the two databases over f and g to a database in h, within m.

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

type DatabaseSettings be (db :: (Type -> Type) -> Type) = 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

type DatabaseEntityRegularRequirements be entityType

Methods

dbEntityName :: Lens' (DatabaseEntityDescriptor be entityType) Text

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

dbEntityAuto :: Text -> DatabaseEntityDescriptor be entityType

Instances

IsDatabaseEntity be (DomainTypeEntity ty)

Defined in Database.Beam.Schema.Tables

Associated Types

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) = ()

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 (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

Associated Types

data DatabaseEntityDescriptor be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

data DatabaseEntityDescriptor be (TableEntity tbl) where

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

type DatabaseEntityDefaultRequirements be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityDefaultRequirements be (TableEntity tbl) = (GDefaultTableFieldSettings (Rep (TableSettings tbl) ()), Generic (TableSettings tbl), Table tbl, Beamable tbl)

type DatabaseEntityRegularRequirements be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

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

Methods

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

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

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

Beamable tbl => IsDatabaseEntity be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

Associated Types

data DatabaseEntityDescriptor be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

data DatabaseEntityDescriptor be (ViewEntity tbl) where

• DatabaseView :: forall (tbl :: (Type -> Type) -> Type) be. {..} -> DatabaseEntityDescriptor be (ViewEntity tbl)

type DatabaseEntityDefaultRequirements be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityDefaultRequirements be (ViewEntity tbl) = (GDefaultTableFieldSettings (Rep (TableSettings tbl) ()), Generic (TableSettings tbl), Beamable tbl)

type DatabaseEntityRegularRequirements be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityRegularRequirements be (ViewEntity tbl) = Beamable tbl

Methods

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

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

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

data family DatabaseEntityDescriptor be entityType

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 (TableEntity tbl)))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> FieldRenamer (DatabaseEntityDescriptor be (TableEntity 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 (DomainTypeEntity ty)

Defined in Database.Beam.Schema.Tables

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

data DatabaseEntityDescriptor be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

data DatabaseEntityDescriptor be (TableEntity tbl) where

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

data DatabaseEntityDescriptor be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

data DatabaseEntityDescriptor be (ViewEntity tbl) where

• DatabaseView :: forall (tbl :: (Type -> Type) -> Type) be. {..} -> DatabaseEntityDescriptor be (ViewEntity tbl)

data DatabaseEntity be (db :: (Type -> Type) -> Type) 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 :: forall be entityType (db :: (Type -> Type) -> Type). 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

(Selector f, IsDatabaseEntity be x, DatabaseEntityDefaultRequirements be x) => GAutoDbSettings (S1 f (K1 R (DatabaseEntity be db x) :: Type -> Type) p)

Defined in Database.Beam.Schema.Tables

Methods

autoDbSettings' :: S1 f (K1 R (DatabaseEntity be db x) :: Type -> Type) p

(Database be embedded, Generic (DatabaseSettings be embedded), GAutoDbSettings (Rep (DatabaseSettings be embedded) ())) => GAutoDbSettings (S1 f (K1 R (embedded (DatabaseEntity be super)) :: Type -> Type) p)

Defined in Database.Beam.Schema.Tables

Methods

autoDbSettings' :: S1 f (K1 R (embedded (DatabaseEntity be super)) :: Type -> Type) p

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

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)

Defined in Database.Beam.Schema.Tables

data DatabaseEntityDescriptor be (TableEntity tbl) where

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

type DatabaseEntityDefaultRequirements be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityDefaultRequirements be (TableEntity tbl) = (GDefaultTableFieldSettings (Rep (TableSettings tbl) ()), Generic (TableSettings tbl), Table tbl, Beamable tbl)

type DatabaseEntityRegularRequirements be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

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

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))

type DatabaseEntityDefaultRequirements be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityDefaultRequirements be (TableEntity tbl) = (GDefaultTableFieldSettings (Rep (TableSettings tbl) ()), Generic (TableSettings tbl), Table tbl, Beamable tbl)

data DatabaseEntityDescriptor be (TableEntity tbl)

Defined in Database.Beam.Schema.Tables

data DatabaseEntityDescriptor be (TableEntity tbl) where

• DatabaseTable :: forall (tbl :: (Type -> Type) -> Type) be. Table tbl => {..} -> DatabaseEntityDescriptor 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 :: (Type -> Type) -> Type)

Instances

Beamable tbl => IsDatabaseEntity be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

Associated Types

data DatabaseEntityDescriptor be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

data DatabaseEntityDescriptor be (ViewEntity tbl) where

• DatabaseView :: forall (tbl :: (Type -> Type) -> Type) be. {..} -> DatabaseEntityDescriptor be (ViewEntity tbl)

type DatabaseEntityDefaultRequirements be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityDefaultRequirements be (ViewEntity tbl) = (GDefaultTableFieldSettings (Rep (TableSettings tbl) ()), Generic (TableSettings tbl), Beamable tbl)

type DatabaseEntityRegularRequirements be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityRegularRequirements be (ViewEntity tbl) = Beamable tbl

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))

type DatabaseEntityDefaultRequirements be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityDefaultRequirements be (ViewEntity tbl) = (GDefaultTableFieldSettings (Rep (TableSettings tbl) ()), Generic (TableSettings tbl), Beamable tbl)

data DatabaseEntityDescriptor be (ViewEntity tbl)

Defined in Database.Beam.Schema.Tables

data DatabaseEntityDescriptor be (ViewEntity tbl) where

• DatabaseView :: forall (tbl :: (Type -> Type) -> Type) be. {..} -> DatabaseEntityDescriptor 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)

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) = ()

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))

type DatabaseEntityDefaultRequirements be (DomainTypeEntity ty)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityDefaultRequirements be (DomainTypeEntity ty) = ()

data DatabaseEntityDescriptor be (DomainTypeEntity ty)

Defined in Database.Beam.Schema.Tables

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

type DatabaseEntityRegularRequirements be (DomainTypeEntity ty)

Defined in Database.Beam.Schema.Tables

type DatabaseEntityRegularRequirements be (DomainTypeEntity ty) = ()

dbEntityDescriptor :: forall be (db :: (Type -> Type) -> Type) entityType r. Getting r (DatabaseEntity be db entityType) (DatabaseEntityDescriptor be entityType)

type DatabaseModification (f :: Type -> Type) be (db :: (Type -> Type) -> Type) = 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 :: Type -> Type) 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)

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

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

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

newtype FieldModification (f :: Type -> Type) a

A newtype wrapper around 'Columnar f a -> Columnar f a' (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 :: Type -> Type) 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 :: Type -> Type) 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 :: Type -> ((Type -> Type) -> Type) -> Type -> Type). 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 = setEntityName "Table_1" <> modifyTableFields tableModification { 
           table1Field1 = "first_name" 
        }
     }

withTableModification :: forall tbl (f :: Type -> Type). 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 :: forall tbl be (db :: (Type -> Type) -> Type). (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 :: forall be entity (db :: (Type -> Type) -> Type). IsDatabaseEntity be entity => (Text -> Text) -> EntityModification (DatabaseEntity be db) be entity

Construct an EntityModification to rename any database entity

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

Change the entity name without consulting the beam-assigned one

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

Construct an EntityModification to rename the fields of a TableEntity

fieldNamed :: forall (tbl :: (Type -> Type) -> Type) a. 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.

modifyEntitySchema :: forall be entity (db :: (Type -> Type) -> Type). IsDatabaseEntity be entity => (Maybe Text -> Maybe Text) -> EntityModification (DatabaseEntity be db) be entity

Construct an EntityModification to set the schema of a database entity

setEntitySchema :: forall be entity (db :: (Type -> Type) -> Type). IsDatabaseEntity be entity => Maybe Text -> EntityModification (DatabaseEntity be db) be entity

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

embedDatabase :: forall be embedded (db :: (Type -> Type) -> Type). Database be embedded => DatabaseSettings be embedded -> embedded (EntityModification (DatabaseEntity be db) be)

Embed database settings in a larger database

class RenamableWithRule mod where

Methods

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

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 (TableEntity tbl)))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> FieldRenamer (DatabaseEntityDescriptor be (TableEntity 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))

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)

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

Defined in Database.Beam.Schema.Tables

Methods

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

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 :: Type -> Type) 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 (TableEntity tbl)))

Defined in Database.Beam.Schema.Tables

Methods

renamingFields :: (NonEmpty Text -> Text) -> FieldRenamer (DatabaseEntityDescriptor be (TableEntity 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 Lenses (t :: (Type -> Type) -> Type) (f :: Type -> Type) x

Instances

(Generic (sub (Nullable m)), Generic (sub (Nullable (Lenses t m))), GTableLenses t m (Rep (sub (Nullable m))) (Rep (sub (Nullable (Lenses t m))))) => GTableLenses t m (K1 R (sub (Nullable m)) :: k -> Type) (K1 R (sub (Nullable (Lenses t m))) :: Type -> Type)

Defined in Database.Beam.Schema.Lenses

Methods

gTableLenses :: forall (p :: k). Proxy (K1 R (sub (Nullable m)) :: k -> Type) -> Lens' (t m) (K1 R (sub (Nullable m)) p) -> K1 R (sub (Nullable (Lenses t m))) ()

(Generic (sub m), Generic (sub (Lenses t m)), GTableLenses t m (Rep (sub m)) (Rep (sub (Lenses t m)))) => GTableLenses t m (K1 R (sub m) :: k -> Type) (K1 R (sub (Lenses t m)) :: Type -> Type)

Defined in Database.Beam.Schema.Lenses

Methods

gTableLenses :: forall (p :: k). Proxy (K1 R (sub m) :: k -> Type) -> Lens' (t m) (K1 R (sub m) p) -> K1 R (sub (Lenses t m)) ()

data LensFor t x where

Constructors

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

Instances

Generic (t m) => GTableLenses t m (K1 R x :: k -> Type) (K1 R (LensFor (t m) x) :: Type -> Type)

Defined in Database.Beam.Schema.Lenses

Methods

gTableLenses :: forall (p :: k). Proxy (K1 R x :: k -> Type) -> Lens' (t m) (K1 R x p) -> K1 R (LensFor (t m) x) ()

Columnar and Column Tags

type family Columnar (f :: Type -> Type) 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 just_ and nothing_ 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 :: Type -> Type) a = Columnar f a

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

newtype Columnar' (f :: Type -> Type) 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 :: Type -> Type) (g :: Type -> Type) a

Like Compose, but with an intermediate Columnar

Constructors

ComposeColumnar (f (Columnar g a))

data Nullable (c :: Type -> Type) 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 (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 => 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 :: Type -> Type)) -> m (t (Nullable (Const Text :: Type -> Type)))

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

(Generic (sub (Nullable m)), Generic (sub (Nullable (Lenses t m))), GTableLenses t m (Rep (sub (Nullable m))) (Rep (sub (Nullable (Lenses t m))))) => GTableLenses t m (K1 R (sub (Nullable m)) :: k -> Type) (K1 R (sub (Nullable (Lenses t m))) :: Type -> Type)

Defined in Database.Beam.Schema.Lenses

Methods

gTableLenses :: forall (p :: k). Proxy (K1 R (sub (Nullable m)) :: k -> Type) -> Lens' (t m) (K1 R (sub (Nullable m)) p) -> K1 R (sub (Nullable (Lenses t m))) ()

Beamable tbl => GZipTables f g h (K1 R (tbl (Nullable Exposed)) :: Type -> Type) (K1 R (tbl (Nullable f)) :: Type -> Type) (K1 R (tbl (Nullable g)) :: Type -> Type) (K1 R (tbl (Nullable h)) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gZipTables :: Applicative m => Proxy (K1 R (tbl (Nullable Exposed)) :: Type -> Type) -> (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> K1 R (tbl (Nullable f)) () -> K1 R (tbl (Nullable g)) () -> m (K1 R (tbl (Nullable h)) ())

(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

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

FromBackendRow be (t (Nullable Identity)) => GFromBackendRow be (K1 R (t (Nullable Exposed)) :: Type -> Type) (K1 R (t (Nullable Identity)) :: Type -> Type)

Defined in Database.Beam.Backend.SQL.Row

Methods

gFromBackendRow :: Proxy (K1 R (t (Nullable Exposed)) :: Type -> Type) -> FromBackendRowM be (K1 R (t (Nullable Identity)) ())

gValuesNeeded :: Proxy be -> Proxy (K1 R (t (Nullable Exposed)) :: Type -> Type) -> Proxy (K1 R (t (Nullable Identity)) :: Type -> Type) -> Int

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

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t (Nullable Exposed)) :: Type -> Type) -> K1 R (t (Nullable (HasConstraint c))) ()

(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))

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

Defined in Database.Beam.Query.Internal

Methods

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

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)

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, 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))

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 (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))

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)

Beamable tbl => GTableSkeleton (K1 R (tbl (Nullable Ignored)) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gTblSkeleton :: Proxy (K1 R (tbl (Nullable Ignored)) :: Type -> Type) -> K1 R (tbl (Nullable Ignored)) ()

(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 HaskellLiteralForQExpr (table (Nullable f))

Defined in Database.Beam.Query.Combinators

type HaskellLiteralForQExpr (table (Nullable f))

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 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 :: (Type -> Type) -> Type) 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)

IsString (FieldModification (TableField tbl) a)

Defined in Database.Beam.Schema.Tables

Methods

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

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

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

Selector f => GDefaultTableFieldSettings (S1 f (K1 R (TableField table field) :: Type -> Type) p)

Defined in Database.Beam.Schema.Tables

Methods

gDefTblFieldSettings :: Proxy (S1 f (K1 R (TableField table field) :: Type -> Type) p) -> S1 f (K1 R (TableField table field) :: Type -> Type) p

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

(fa ~ Columnar f a, ga ~ Columnar g a, ha ~ Columnar h a, ha ~ Columnar h a) => GZipTables f g h (K1 R (Exposed a) :: Type -> Type) (K1 R fa :: Type -> Type) (K1 R ga :: Type -> Type) (K1 R ha :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gZipTables :: Applicative m => Proxy (K1 R (Exposed a) :: Type -> Type) -> (forall a0. Columnar' f a0 -> Columnar' g a0 -> m (Columnar' h a0)) -> K1 R fa () -> K1 R ga () -> m (K1 R ha ())

Beamable tbl => GZipTables f g h (K1 R (tbl Exposed) :: Type -> Type) (K1 R (tbl f) :: Type -> Type) (K1 R (tbl g) :: Type -> Type) (K1 R (tbl h) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gZipTables :: Applicative m => Proxy (K1 R (tbl Exposed) :: Type -> Type) -> (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> K1 R (tbl f) () -> K1 R (tbl g) () -> m (K1 R (tbl h) ())

Beamable tbl => GZipTables f g h (K1 R (tbl (Nullable Exposed)) :: Type -> Type) (K1 R (tbl (Nullable f)) :: Type -> Type) (K1 R (tbl (Nullable g)) :: Type -> Type) (K1 R (tbl (Nullable h)) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gZipTables :: Applicative m => Proxy (K1 R (tbl (Nullable Exposed)) :: Type -> Type) -> (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> K1 R (tbl (Nullable f)) () -> K1 R (tbl (Nullable g)) () -> m (K1 R (tbl (Nullable h)) ())

FromBackendRow be x => GFromBackendRow be (K1 R (Exposed x) :: Type -> Type) (K1 R (Identity x) :: Type -> Type)

Defined in Database.Beam.Backend.SQL.Row

Methods

gFromBackendRow :: Proxy (K1 R (Exposed x) :: Type -> Type) -> FromBackendRowM be (K1 R (Identity x) ())

gValuesNeeded :: Proxy be -> Proxy (K1 R (Exposed x) :: Type -> Type) -> Proxy (K1 R (Identity x) :: Type -> Type) -> Int

FromBackendRow be x => GFromBackendRow be (K1 R (Exposed x) :: Type -> Type) (K1 R x :: Type -> Type)

Defined in Database.Beam.Backend.SQL.Row

Methods

gFromBackendRow :: Proxy (K1 R (Exposed x) :: Type -> Type) -> FromBackendRowM be (K1 R x ())

gValuesNeeded :: Proxy be -> Proxy (K1 R (Exposed x) :: Type -> Type) -> Proxy (K1 R x :: Type -> Type) -> Int

FromBackendRow be (t Identity) => GFromBackendRow be (K1 R (t Exposed) :: Type -> Type) (K1 R (t Identity) :: Type -> Type)

Defined in Database.Beam.Backend.SQL.Row

Methods

gFromBackendRow :: Proxy (K1 R (t Exposed) :: Type -> Type) -> FromBackendRowM be (K1 R (t Identity) ())

gValuesNeeded :: Proxy be -> Proxy (K1 R (t Exposed) :: Type -> Type) -> Proxy (K1 R (t Identity) :: Type -> Type) -> Int

FromBackendRow be (t (Nullable Identity)) => GFromBackendRow be (K1 R (t (Nullable Exposed)) :: Type -> Type) (K1 R (t (Nullable Identity)) :: Type -> Type)

Defined in Database.Beam.Backend.SQL.Row

Methods

gFromBackendRow :: Proxy (K1 R (t (Nullable Exposed)) :: Type -> Type) -> FromBackendRowM be (K1 R (t (Nullable Identity)) ())

gValuesNeeded :: Proxy be -> Proxy (K1 R (t (Nullable Exposed)) :: Type -> Type) -> Proxy (K1 R (t (Nullable Identity)) :: Type -> Type) -> Int

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

Defined in Database.Beam.Schema.Tables

Methods

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

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

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t Exposed) :: Type -> Type) -> K1 R (t (HasConstraint c)) ()

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

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t (Nullable Exposed)) :: Type -> Type) -> K1 R (t (Nullable (HasConstraint c))) ()

fieldName :: forall (table :: (Type -> Type) -> Type) ty f. Functor f => (Text -> f Text) -> TableField table ty -> f (TableField table ty)

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

fieldPath :: forall (table :: (Type -> Type) -> Type) ty f. Applicative f => (Text -> f Text) -> TableField table ty -> f (TableField table ty)

type TableSettings (table :: (Type -> Type) -> Type) = 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 :: (Type -> Type) -> Type) = table Identity

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

type TableSkeleton (table :: (Type -> Type) -> Type) = 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

Instances

GTableSkeleton (K1 R (Ignored field) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gTblSkeleton :: Proxy (K1 R (Ignored field) :: Type -> Type) -> K1 R (Ignored field) ()

Beamable tbl => GTableSkeleton (K1 R (tbl (Nullable Ignored)) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gTblSkeleton :: Proxy (K1 R (tbl (Nullable Ignored)) :: Type -> Type) -> K1 R (tbl (Nullable Ignored)) ()

Beamable tbl => GTableSkeleton (K1 R (tbl Ignored) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gTblSkeleton :: Proxy (K1 R (tbl Ignored) :: Type -> Type) -> K1 R (tbl Ignored) ()

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

Methods

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

Instances

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

Defined in Database.Beam.Schema.Tables

Methods

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

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

Defined in Database.Beam.Schema.Tables

Methods

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

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

Defined in Database.Beam.Schema.Tables

Methods

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

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

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t Exposed) :: Type -> Type) -> K1 R (t (HasConstraint c)) ()

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

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t (Nullable Exposed)) :: Type -> Type) -> K1 R (t (Nullable (HasConstraint c))) ()

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

Defined in Database.Beam.Schema.Tables

Methods

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

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

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

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

Carry a constraint instance and the value it applies to.

Constructors

WithConstraint :: forall (c :: Type -> Constraint) x. c x => x -> WithConstraint c x

data HasConstraint (c :: Type -> Constraint) x where

Carry a constraint instance.

Constructors

HasConstraint :: forall (c :: Type -> Constraint) x. c x => HasConstraint c x

Instances

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

Defined in Database.Beam.Schema.Tables

Methods

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

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

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t Exposed) :: Type -> Type) -> K1 R (t (HasConstraint c)) ()

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

Defined in Database.Beam.Schema.Tables

Methods

gWithConstrainedFields :: Proxy c -> Proxy (K1 R (t (Nullable Exposed)) :: Type -> Type) -> K1 R (t (Nullable (HasConstraint c))) ()

class TagReducesTo (f :: Type -> Type) (f' :: Type -> Type) | 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 :: Type -> Type) (f :: Type -> Type) :: Type -> Type where ...

Equations

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

ReplaceBaseTag tag x = tag

withConstrainedFields :: forall (c :: Type -> Constraint) tbl. (FieldsFulfillConstraint c tbl, Beamable tbl) => tbl Identity -> tbl (WithConstraint c)

withConstraints :: forall (c :: Type -> Constraint) tbl. (Beamable tbl, FieldsFulfillConstraint c tbl) => tbl (HasConstraint c)

withNullableConstrainedFields :: forall (c :: Type -> Constraint) tbl. (FieldsFulfillConstraintNullable c tbl, Beamable tbl) => tbl (Nullable Identity) -> tbl (Nullable (WithConstraint c))

withNullableConstraints :: forall (c :: Type -> Constraint) tbl. (Beamable tbl, FieldsFulfillConstraintNullable c tbl) => tbl (Nullable (HasConstraint c))

Tables

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

The big Kahuna! All beam tables implement this class.

The kind of all table types is '(Type -> Type) -> Type'. 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 Text, Text, 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 :: (Type -> Type) -> Type) (column :: Type -> Type)

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 :: forall (column :: Type -> Type). 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 :: (Type -> Type) -> Type) 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 :: forall m (f :: Type -> Type) (g :: Type -> Type) (h :: Type -> Type). Applicative m => (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> table f -> table g -> m (table h)

default zipBeamFieldsM :: forall (f :: Type -> Type) (g :: Type -> Type) (h :: Type -> Type) m. (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

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

class Retaggable (f :: Type -> Type) x | x -> f where

Associated Types

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

Methods

retag :: forall (tag :: (Type -> Type) -> Type -> Type). (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

Methods

retag :: forall (tag :: (Type -> Type) -> Type -> Type). (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

Methods

retag :: forall (tag :: (Type -> Type) -> Type -> Type). (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

Methods

retag :: forall (tag :: (Type -> Type) -> Type -> Type). (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

Methods

retag :: forall (tag :: (Type -> Type) -> Type -> Type). (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

Methods

retag :: forall (tag :: (Type -> Type) -> Type -> Type). (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

Methods

retag :: forall (tag :: (Type -> Type) -> Type -> Type). (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

Methods

retag :: forall (tag :: (Type -> Type) -> Type -> Type). (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

Methods

retag :: forall (tag :: (Type -> Type) -> Type -> Type). (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

Methods

retag :: forall (tag :: (Type -> Type) -> Type -> Type). (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) infixr 6

Products: encode multiple arguments to constructors

Constructors

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

Instances

(GZipDatabase be f g h ax ay az, GZipDatabase be f g h bx by bz) => GZipDatabase be f g h (ax :*: bx) (ay :*: by) (az :*: bz)

Defined in Database.Beam.Schema.Tables

Methods

gZipDatabase :: Applicative m => (Proxy f, Proxy g, Proxy h, Proxy be) -> (forall tbl. (IsDatabaseEntity be tbl, DatabaseEntityRegularRequirements be tbl) => f tbl -> g tbl -> m (h tbl)) -> (ax :*: bx) () -> (ay :*: by) () -> m ((az :*: bz) ())

(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

(GTableLenses t m a aLens, GTableLenses t m b bLens) => GTableLenses t m (a :*: b :: k -> Type) (aLens :*: bLens)

Defined in Database.Beam.Schema.Lenses

Methods

gTableLenses :: forall (p :: k). Proxy (a :*: b) -> Lens' (t m) ((a :*: b) p) -> (aLens :*: bLens) ()

(GZipTables f g h exp1 f1 g1 h1, GZipTables f g h exp2 f2 g2 h2) => GZipTables f g h (exp1 :*: exp2) (f1 :*: f2) (g1 :*: g2) (h1 :*: h2)

Defined in Database.Beam.Schema.Tables

Methods

gZipTables :: Applicative m => Proxy (exp1 :*: exp2) -> (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> (f1 :*: f2) () -> (g1 :*: g2) () -> m ((h1 :*: h2) ())

(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

(GDatabaseLenses db a al, GDatabaseLenses db b bl) => GDatabaseLenses db (a :*: b :: k -> Type) (al :*: bl)

Defined in Database.Beam.Schema.Lenses

Methods

gDatabaseLenses :: forall (p :: k). Lens' db ((a :*: b) p) -> (al :*: bl) ()

(FieldNames a, FieldNames b) => FieldNames (a :*: b :: k -> Type)

Defined in Data.Aeson.Types.FromJSON

Methods

fieldNames :: forall (a0 :: k). (a :*: b) a0 -> [String] -> [String]

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

Defined in Data.Aeson.Types.FromJSON

Methods

productParseJSON :: (ConName :* (TypeName :* (Options :* FromArgs arity a0))) -> Array -> Int -> Int -> Parser ((a :*: b) a0)

(RecordFromJSON' arity a, RecordFromJSON' arity b) => RecordFromJSON' arity (a :*: b)

Defined in Data.Aeson.Types.FromJSON

Methods

recordParseJSON' :: (ConName :* (TypeName :* (Options :* FromArgs arity a0))) -> Object -> 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 ()

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

Defined in Control.DeepSeq

Methods

grnf :: RnfArgs arity a0 -> (a :*: b) a0 -> ()

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

Defined in GHC.Internal.Generics

Associated Types

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

@since base-4.9.0.0

Defined in GHC.Internal.Generics

type Rep1 (f :*: g :: k -> Type) = D1 ('MetaData ":*:" "GHC.Internal.Generics" "ghc-internal" '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)))

Methods

from1 :: forall (a :: k). (f :*: g) a -> Rep1 (f :*: g) a

to1 :: forall (a :: k). Rep1 (f :*: g) a -> (f :*: g) a

(GFromBackendRow be aExp a, GFromBackendRow be bExp b) => GFromBackendRow be (aExp :*: bExp) (a :*: b)

Defined in Database.Beam.Backend.SQL.Row

Methods

gFromBackendRow :: Proxy (aExp :*: bExp) -> FromBackendRowM be ((a :*: b) ())

gValuesNeeded :: Proxy be -> Proxy (aExp :*: bExp) -> Proxy (a :*: b) -> Int

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

Defined in Database.Beam.Schema.Tables

Methods

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

(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

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

Defined in Data.Functor.Rep

Associated Types

type Rep (f :*: g)

Defined in Data.Functor.Rep

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

Methods

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

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

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

Since: base-4.9.0.0

Defined in Control.Monad.Zip

Methods

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

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

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

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

Since: base-4.18.0.0

Defined in Data.Foldable1

Methods

fold1 :: Semigroup m => (f :*: g) m -> m

foldMap1 :: Semigroup m => (a -> m) -> (f :*: g) a -> m

foldMap1' :: Semigroup m => (a -> m) -> (f :*: g) a -> m

toNonEmpty :: (f :*: g) a -> NonEmpty a

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

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

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

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

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

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

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

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

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

Defined in Data.Functor.Contravariant

Methods

contramap :: (a' -> a) -> (f :*: g) a -> (f :*: g) a'

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

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

Defined in Database.Beam.Schema.Tables

Methods

gTblSkeleton :: Proxy (a :*: b) -> (a :*: b) ()

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

@since base-4.9.0.0

Defined in GHC.Internal.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]

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

@since base-4.9.0.0

Defined in GHC.Internal.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

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

@since base-4.9.0.0

Defined in GHC.Internal.Generics

Methods

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

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

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

@since base-4.9.0.0

Defined in GHC.Internal.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

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

@since base-4.9.0.0

Defined in GHC.Internal.Generics

Methods

mzero :: (f :*: g) a

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

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

@since base-4.9.0.0

Defined in GHC.Internal.Control.Monad.Fix

Methods

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

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

@since base-4.9.0.0

Defined in GHC.Internal.Data.Foldable

Methods

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

foldMap :: Monoid m => (a -> m) -> (f :*: g) a -> 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 GHC.Internal.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)

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

Defined in System.Random.Internal

Methods

guniformM :: forall g0 (m :: Type -> Type) r a. StatefulGen g0 m => g0 -> ContT r m ((f :*: g) a)

(GAutoDbSettings (x p), GAutoDbSettings (y p)) => GAutoDbSettings ((x :*: y) p)

Defined in Database.Beam.Schema.Tables

Methods

autoDbSettings' :: (x :*: y) p

(GDefaultTableFieldSettings (a p), GDefaultTableFieldSettings (b p)) => GDefaultTableFieldSettings ((a :*: b) p)

Defined in Database.Beam.Schema.Tables

Methods

gDefTblFieldSettings :: Proxy ((a :*: b) p) -> (a :*: b) p

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

@since base-4.12.0.0

Defined in GHC.Internal.Generics

Methods

mempty :: (f :*: g) p

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

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

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

@since base-4.12.0.0

Defined in GHC.Internal.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

Generic ((f :*: g) p)

Defined in GHC.Internal.Generics

Associated Types

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

@since base-4.7.0.0

Defined in GHC.Internal.Generics

type Rep ((f :*: g) p) = D1 ('MetaData ":*:" "GHC.Internal.Generics" "ghc-internal" '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))))

Methods

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

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

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

@since base-4.7.0.0

Defined in GHC.Internal.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.Internal.Generics

Methods

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

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

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

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

@since base-4.7.0.0

Defined in GHC.Internal.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.Internal.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

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

@since base-4.9.0.0

Defined in GHC.Internal.Generics

type Rep1 (f :*: g :: k -> Type) = D1 ('MetaData ":*:" "GHC.Internal.Generics" "ghc-internal" '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 GRep' (f :*: g)

Defined in Data.Functor.Rep

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

type Rep (f :*: g)

Defined in Data.Functor.Rep

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

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

@since base-4.7.0.0

Defined in GHC.Internal.Generics

type Rep ((f :*: g) p) = D1 ('MetaData ":*:" "GHC.Internal.Generics" "ghc-internal" '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 :: forall (table :: (Type -> Type) -> Type). Beamable table => Proxy table -> Int

pk :: forall t (f :: Type -> Type). Table t => t f -> PrimaryKey t f

Synonym for primaryKey

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

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

alongsideTable :: forall tbl (f :: Type -> Type) (g :: Type -> Type). 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

Exported so we can override defaults

For Beamable

class GZipTables (f :: Type -> Type) (g :: Type -> Type) (h :: Type -> Type) (exposedRep :: Type -> Type) (fRep :: Type -> Type) (gRep :: Type -> Type) (hRep :: Type -> Type) where

Methods

gZipTables :: Applicative m => Proxy exposedRep -> (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> fRep () -> gRep () -> m (hRep ())

Instances

GZipTables f g h (U1 :: Type -> Type) (U1 :: Type -> Type) (U1 :: Type -> Type) (U1 :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gZipTables :: Applicative m => Proxy (U1 :: Type -> Type) -> (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> U1 () -> U1 () -> m (U1 ())

(GZipTables f g h exp1 f1 g1 h1, GZipTables f g h exp2 f2 g2 h2) => GZipTables f g h (exp1 :*: exp2) (f1 :*: f2) (g1 :*: g2) (h1 :*: h2)

Defined in Database.Beam.Schema.Tables

Methods

gZipTables :: Applicative m => Proxy (exp1 :*: exp2) -> (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> (f1 :*: f2) () -> (g1 :*: g2) () -> m ((h1 :*: h2) ())

(fa ~ Columnar f a, ga ~ Columnar g a, ha ~ Columnar h a, ha ~ Columnar h a) => GZipTables f g h (K1 R (Exposed a) :: Type -> Type) (K1 R fa :: Type -> Type) (K1 R ga :: Type -> Type) (K1 R ha :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gZipTables :: Applicative m => Proxy (K1 R (Exposed a) :: Type -> Type) -> (forall a0. Columnar' f a0 -> Columnar' g a0 -> m (Columnar' h a0)) -> K1 R fa () -> K1 R ga () -> m (K1 R ha ())

Beamable tbl => GZipTables f g h (K1 R (tbl Exposed) :: Type -> Type) (K1 R (tbl f) :: Type -> Type) (K1 R (tbl g) :: Type -> Type) (K1 R (tbl h) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gZipTables :: Applicative m => Proxy (K1 R (tbl Exposed) :: Type -> Type) -> (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> K1 R (tbl f) () -> K1 R (tbl g) () -> m (K1 R (tbl h) ())

Beamable tbl => GZipTables f g h (K1 R (tbl (Nullable Exposed)) :: Type -> Type) (K1 R (tbl (Nullable f)) :: Type -> Type) (K1 R (tbl (Nullable g)) :: Type -> Type) (K1 R (tbl (Nullable h)) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gZipTables :: Applicative m => Proxy (K1 R (tbl (Nullable Exposed)) :: Type -> Type) -> (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> K1 R (tbl (Nullable f)) () -> K1 R (tbl (Nullable g)) () -> m (K1 R (tbl (Nullable h)) ())

GZipTables f g h exp fRep gRep hRep => GZipTables f g h (M1 x y exp) (M1 x y fRep) (M1 x y gRep) (M1 x y hRep)

Defined in Database.Beam.Schema.Tables

Methods

gZipTables :: Applicative m => Proxy (M1 x y exp) -> (forall a. Columnar' f a -> Columnar' g a -> m (Columnar' h a)) -> M1 x y fRep () -> M1 x y gRep () -> m (M1 x y hRep ())

class GTableSkeleton (x :: Type -> Type) where

Methods

gTblSkeleton :: Proxy x -> x ()

Instances

GTableSkeleton (U1 :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gTblSkeleton :: Proxy (U1 :: Type -> Type) -> U1 ()

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

Defined in Database.Beam.Schema.Tables

Methods

gTblSkeleton :: Proxy (a :*: b) -> (a :*: b) ()

GTableSkeleton (K1 R (Ignored field) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gTblSkeleton :: Proxy (K1 R (Ignored field) :: Type -> Type) -> K1 R (Ignored field) ()

Beamable tbl => GTableSkeleton (K1 R (tbl (Nullable Ignored)) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gTblSkeleton :: Proxy (K1 R (tbl (Nullable Ignored)) :: Type -> Type) -> K1 R (tbl (Nullable Ignored)) ()

Beamable tbl => GTableSkeleton (K1 R (tbl Ignored) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gTblSkeleton :: Proxy (K1 R (tbl Ignored) :: Type -> Type) -> K1 R (tbl Ignored) ()

GTableSkeleton p => GTableSkeleton (M1 t f p)

Defined in Database.Beam.Schema.Tables

Methods

gTblSkeleton :: Proxy (M1 t f p) -> M1 t f p ()

For Database

class GZipDatabase be (f :: Type -> Type) (g :: Type -> Type) (h :: Type -> Type) (x :: Type -> Type) (y :: Type -> Type) (z :: Type -> Type) where

Methods

gZipDatabase :: Applicative m => (Proxy f, Proxy g, Proxy h, Proxy be) -> (forall tbl. (IsDatabaseEntity be tbl, DatabaseEntityRegularRequirements be tbl) => f tbl -> g tbl -> m (h tbl)) -> x () -> y () -> m (z ())

Instances

(GZipDatabase be f g h ax ay az, GZipDatabase be f g h bx by bz) => GZipDatabase be f g h (ax :*: bx) (ay :*: by) (az :*: bz)

Defined in Database.Beam.Schema.Tables

Methods

gZipDatabase :: Applicative m => (Proxy f, Proxy g, Proxy h, Proxy be) -> (forall tbl. (IsDatabaseEntity be tbl, DatabaseEntityRegularRequirements be tbl) => f tbl -> g tbl -> m (h tbl)) -> (ax :*: bx) () -> (ay :*: by) () -> m ((az :*: bz) ())

Database be db => GZipDatabase be f g h (K1 R (db f) :: Type -> Type) (K1 R (db g) :: Type -> Type) (K1 R (db h) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gZipDatabase :: Applicative m => (Proxy f, Proxy g, Proxy h, Proxy be) -> (forall tbl. (IsDatabaseEntity be tbl, DatabaseEntityRegularRequirements be tbl) => f tbl -> g tbl -> m (h tbl)) -> K1 R (db f) () -> K1 R (db g) () -> m (K1 R (db h) ())

(IsDatabaseEntity be tbl, DatabaseEntityRegularRequirements be tbl) => GZipDatabase be f g h (K1 R (f tbl) :: Type -> Type) (K1 R (g tbl) :: Type -> Type) (K1 R (h tbl) :: Type -> Type)

Defined in Database.Beam.Schema.Tables

Methods

gZipDatabase :: Applicative m => (Proxy f, Proxy g, Proxy h, Proxy be) -> (forall tbl0. (IsDatabaseEntity be tbl0, DatabaseEntityRegularRequirements be tbl0) => f tbl0 -> g tbl0 -> m (h tbl0)) -> K1 R (f tbl) () -> K1 R (g tbl) () -> m (K1 R (h tbl) ())

GZipDatabase be f g h x y z => GZipDatabase be f g h (M1 a b x) (M1 a b y) (M1 a b z)

Defined in Database.Beam.Schema.Tables

Methods

gZipDatabase :: Applicative m => (Proxy f, Proxy g, Proxy h, Proxy be) -> (forall tbl. (IsDatabaseEntity be tbl, DatabaseEntityRegularRequirements be tbl) => f tbl -> g tbl -> m (h tbl)) -> M1 a b x () -> M1 a b y () -> m (M1 a b z ())

For defaultDbSettings

class GAutoDbSettings x where

Methods

autoDbSettings' :: x

Instances

(GAutoDbSettings (x p), GAutoDbSettings (y p)) => GAutoDbSettings ((x :*: y) p)

Defined in Database.Beam.Schema.Tables

Methods

autoDbSettings' :: (x :*: y) p

GAutoDbSettings (x p) => GAutoDbSettings (C1 f x p)

Defined in Database.Beam.Schema.Tables

Methods

autoDbSettings' :: C1 f x p

GAutoDbSettings (x p) => GAutoDbSettings (D1 f x p)

Defined in Database.Beam.Schema.Tables

Methods

autoDbSettings' :: D1 f x p

(Selector f, IsDatabaseEntity be x, DatabaseEntityDefaultRequirements be x) => GAutoDbSettings (S1 f (K1 R (DatabaseEntity be db x) :: Type -> Type) p)

Defined in Database.Beam.Schema.Tables

Methods

autoDbSettings' :: S1 f (K1 R (DatabaseEntity be db x) :: Type -> Type) p

(Database be embedded, Generic (DatabaseSettings be embedded), GAutoDbSettings (Rep (DatabaseSettings be embedded) ())) => GAutoDbSettings (S1 f (K1 R (embedded (DatabaseEntity be super)) :: Type -> Type) p)

Defined in Database.Beam.Schema.Tables

Methods

autoDbSettings' :: S1 f (K1 R (embedded (DatabaseEntity be super)) :: Type -> Type) p

class GDefaultTableFieldSettings x where

Methods

gDefTblFieldSettings :: Proxy x -> x

Instances

(GDefaultTableFieldSettings (a p), GDefaultTableFieldSettings (b p)) => GDefaultTableFieldSettings ((a :*: b) p)

Defined in Database.Beam.Schema.Tables

Methods

gDefTblFieldSettings :: Proxy ((a :*: b) p) -> (a :*: b) p

GDefaultTableFieldSettings (p x) => GDefaultTableFieldSettings (C1 f p x)

Defined in Database.Beam.Schema.Tables

Methods

gDefTblFieldSettings :: Proxy (C1 f p x) -> C1 f p x

GDefaultTableFieldSettings (p x) => GDefaultTableFieldSettings (D1 f p x)

Defined in Database.Beam.Schema.Tables

Methods

gDefTblFieldSettings :: Proxy (D1 f p x) -> D1 f p x

(TypeError ('Text "All Beamable types must be record types, so appropriate names can be given to columns") :: Constraint) => GDefaultTableFieldSettings (K1 r f p)

Defined in Database.Beam.Schema.Tables

Methods

gDefTblFieldSettings :: Proxy (K1 r f p) -> K1 r f p

Selector f => GDefaultTableFieldSettings (S1 f (K1 R (TableField table field) :: Type -> Type) p)

Defined in Database.Beam.Schema.Tables

Methods

gDefTblFieldSettings :: Proxy (S1 f (K1 R (TableField table field) :: Type -> Type) p) -> S1 f (K1 R (TableField table field) :: Type -> Type) p

(Selector f', ChooseSubTableStrategy tbl sub ~ strategy, SubTableStrategyImpl strategy f sub, TagReducesTo f (TableField tbl), Beamable sub) => GDefaultTableFieldSettings (S1 f' (K1 R (sub f) :: Type -> Type) p)

Defined in Database.Beam.Schema.Tables

Methods

gDefTblFieldSettings :: Proxy (S1 f' (K1 R (sub f) :: Type -> Type) p) -> S1 f' (K1 R (sub f) :: Type -> Type) p

type family ChooseSubTableStrategy (tbl :: (Type -> Type) -> Type) (sub :: (Type -> Type) -> Type) :: SubTableStrategy where ...

Equations

ChooseSubTableStrategy tbl (PrimaryKey tbl) = 'RecursiveKeyStrategy

ChooseSubTableStrategy tbl (PrimaryKey rel) = 'PrimaryKeyStrategy

ChooseSubTableStrategy tbl sub = 'BeamableStrategy

class SubTableStrategyImpl (strategy :: SubTableStrategy) (f :: Type -> Type) (sub :: (Type -> Type) -> Type)

Minimal complete definition

namedSubTable