Database.PostgreSQL.Entity.Types

Types and classes

The Entity Typeclass

class Entity e where

An Entity stores the following information about the structure of a database table:

• Its name
• Its primary key
• The fields it contains

Example

data ExampleEntity = E
  { key    :: Key
  , field1 :: Int
  , field2 :: Bool
  }
  deriving stock (Eq, Show, Generic)
  deriving anyclass (FromRow, ToRow)
  deriving Entity
     via (GenericEntity '[TableName "entities"] ExampleEntity)

When using the functions provided by this library, you will sometimes need to be explicit about the Entity you are referring to.

Since: 0.0.1.0

Minimal complete definition

Nothing

Methods

tableName :: Text

The name of the table in the PostgreSQL database.

default tableName :: GetTableName (Rep e) => Text

schema :: Maybe Text

The name of the schema; will be appended to the table name: schema."tablename"

primaryKey :: Field

The name of the primary key for the table.

default primaryKey :: GetFields (Rep e) => Field

fields :: Vector Field

The fields of the table.

default fields :: GetFields (Rep e) => Vector Field

Instances

Entity Author

Defined in Database.PostgreSQL.Entity.Internal.BlogPost

Methods

tableName :: Text

schema :: Maybe Text

primaryKey :: Field

fields :: Vector Field

Entity BlogPost

Defined in Database.PostgreSQL.Entity.Internal.BlogPost

Methods

tableName :: Text

schema :: Maybe Text

primaryKey :: Field

fields :: Vector Field

Entity Tags

Defined in Database.PostgreSQL.Entity.Internal.BlogPost

Methods

tableName :: Text

schema :: Maybe Text

primaryKey :: Field

fields :: Vector Field

Entity a => Entity (UpdateRow a)

Defined in Database.PostgreSQL.Entity.Types

Methods

tableName :: Text

schema :: Maybe Text

primaryKey :: Field

fields :: Vector Field

(EntityOptions t, GetTableName (Rep e), GetFields (Rep e)) => Entity (GenericEntity t e)

Defined in Database.PostgreSQL.Entity.Types

Methods

tableName :: Text

schema :: Maybe Text

primaryKey :: Field

fields :: Vector Field

Associated Types

data Field

A wrapper for table fields.

Since: 0.0.1.0

Instances

ForbiddenIsString => IsString Field

Using the Overloaded String syntax for Field names is forbidden.

Defined in Database.PostgreSQL.Entity.Internal.Unsafe

Methods

fromString :: String -> Field

Show Field

Defined in Database.PostgreSQL.Entity.Internal.Unsafe

Methods

showsPrec :: Int -> Field -> ShowS

show :: Field -> String

showList :: [Field] -> ShowS

Eq Field

Defined in Database.PostgreSQL.Entity.Internal.Unsafe

Methods

(==) :: Field -> Field -> Bool

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

field :: QuasiQuoter

A quasi-quoter for safely constructing Fields.

Example:

instance Entity BlogPost where
  tableName  = "blogposts"
  primaryKey = [field| blogpost_id |]
  fields = [ [field| blogpost_id |]
           , [field| author_id |]
           , [field| uuid_list :: uuid[] |] -- ← This is where we specify an optional PostgreSQL type annotation
           , [field| title |]
           , [field| content |]
           , [field| created_at |]
           ]

Since: 0.1.0.0

fieldName :: Field -> Text

Get the name of a field.

Since: 0.1.0.0

fieldType :: Field -> Maybe Text

Get the type of a field, if any.

Since: 0.1.0.0

newtype UpdateRow a

Wrapper used by the update function in order to have the primary key as the last parameter passed, since it appears in the WHERE clause.

Since: 0.0.1.0

Constructors

UpdateRow

Fields

• getUpdate :: a

Instances

Show a => Show (UpdateRow a)

Defined in Database.PostgreSQL.Entity.Types

Methods

showsPrec :: Int -> UpdateRow a -> ShowS

show :: UpdateRow a -> String

showList :: [UpdateRow a] -> ShowS

Eq a => Eq (UpdateRow a)

Defined in Database.PostgreSQL.Entity.Types

Methods

(==) :: UpdateRow a -> UpdateRow a -> Bool

(/=) :: UpdateRow a -> UpdateRow a -> Bool

Entity a => Entity (UpdateRow a)

Defined in Database.PostgreSQL.Entity.Types

Methods

tableName :: Text

schema :: Maybe Text

primaryKey :: Field

fields :: Vector Field

ToRow a => ToRow (UpdateRow a)

Defined in Database.PostgreSQL.Entity.Types

Methods

toRow :: UpdateRow a -> [Action]

data SortKeyword

Since: 0.0.2.0

Constructors

ASC

DESC

Instances

Show SortKeyword

Defined in Database.PostgreSQL.Entity.Types

Methods

showsPrec :: Int -> SortKeyword -> ShowS

show :: SortKeyword -> String

showList :: [SortKeyword] -> ShowS

Eq SortKeyword

Defined in Database.PostgreSQL.Entity.Types

Methods

(==) :: SortKeyword -> SortKeyword -> Bool

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

Display SortKeyword

Defined in Database.PostgreSQL.Entity.Types

Methods

displayBuilder :: SortKeyword -> Builder

displayList :: [SortKeyword] -> Builder

displayPrec :: Int -> SortKeyword -> Builder

Generics

data Options

Term-level options

Constructors

Options

Fields

• tableNameModifiers :: Text -> Text
• schemaModifier :: Maybe Text
• primaryKeyModifiers :: Text -> Text
• fieldModifiers :: Text -> Text

defaultEntityOptions :: Options

DerivingVia Options

newtype GenericEntity t e

Constructors

GenericEntity

Fields

• getGenericEntity :: e

Instances

(EntityOptions t, GetTableName (Rep e), GetFields (Rep e)) => Entity (GenericEntity t e)

Defined in Database.PostgreSQL.Entity.Types

Methods

tableName :: Text

schema :: Maybe Text

primaryKey :: Field

fields :: Vector Field

class EntityOptions xs where

Type-level options for Deriving Via

Methods

entityOptions :: Options

Instances

EntityOptions ('[] :: [k])

Defined in Database.PostgreSQL.Entity.Types

Methods

entityOptions :: Options

(TextModifier mods, EntityOptions xs) => EntityOptions (FieldModifiers mods ': xs :: [Type])

Defined in Database.PostgreSQL.Entity.Types

Methods

entityOptions :: Options

(GetName name, EntityOptions xs) => EntityOptions (PrimaryKey name ': xs :: [Type])

Defined in Database.PostgreSQL.Entity.Types

Methods

entityOptions :: Options

(GetName name, EntityOptions xs) => EntityOptions (Schema name ': xs :: [Type])

Defined in Database.PostgreSQL.Entity.Types

Methods

entityOptions :: Options

(GetName name, EntityOptions xs) => EntityOptions (TableName name ': xs :: [Type])

Defined in Database.PostgreSQL.Entity.Types

Methods

entityOptions :: Options

data PrimaryKey (t :: Symbol)

Instances

(GetName name, EntityOptions xs) => EntityOptions (PrimaryKey name ': xs :: [Type])

Defined in Database.PostgreSQL.Entity.Types

Methods

entityOptions :: Options

data Schema (t :: Symbol)

Instances

(GetName name, EntityOptions xs) => EntityOptions (Schema name ': xs :: [Type])

Defined in Database.PostgreSQL.Entity.Types

Methods

entityOptions :: Options

data TableName (t :: Symbol)

Instances

(GetName name, EntityOptions xs) => EntityOptions (TableName name ': xs :: [Type])

Defined in Database.PostgreSQL.Entity.Types

Methods

entityOptions :: Options

data FieldModifiers ms

Contains a list of TextModifiers modifiers

Instances

(TextModifier mods, EntityOptions xs) => EntityOptions (FieldModifiers mods ': xs :: [Type])

Defined in Database.PostgreSQL.Entity.Types

Methods

entityOptions :: Options

class TextModifier t where

The modifiers that you can apply to the fields:

• StripPrefix
• CamelTo, and its variations
• CamelToSnake
• CamelToKebab

Methods

getTextModifier :: Text -> Text

Instances

(KnownSymbol separator, NonEmptyText separator) => TextModifier (CamelTo separator :: Type)

Defined in Database.PostgreSQL.Entity.Types

Methods

getTextModifier :: Text -> Text

KnownSymbol prefix => TextModifier (StripPrefix prefix :: Type)

Defined in Database.PostgreSQL.Entity.Types

Methods

getTextModifier :: Text -> Text

TextModifier ('[] :: [k])

Defined in Database.PostgreSQL.Entity.Types

Methods

getTextModifier :: Text -> Text

(TextModifier x, TextModifier xs) => TextModifier (x ': xs :: [a])

Defined in Database.PostgreSQL.Entity.Types

Methods

getTextModifier :: Text -> Text

data StripPrefix (prefix :: Symbol)

TextModifier to remove a certain prefix from the fields

Instances

KnownSymbol prefix => TextModifier (StripPrefix prefix :: Type)

Defined in Database.PostgreSQL.Entity.Types

Methods

getTextModifier :: Text -> Text

data CamelTo (separator :: Symbol)

FieldModifier taking a separator Char when transforming from CamelCase.

Instances

(KnownSymbol separator, NonEmptyText separator) => TextModifier (CamelTo separator :: Type)

Defined in Database.PostgreSQL.Entity.Types

Methods

getTextModifier :: Text -> Text

type CamelToSnake = CamelTo "_"

CamelCase to snake_case

type CamelToKebab = CamelTo "-"

CamelCase to kebab-case