servant-db: Servant types for defining API with relational DBs

[ bsd3, library, unclassified ] [ Propose Tags ]

[Skip to Readme]
Versions [faq],
Change log
Dependencies base (>=4.7 && <5), servant (>=0.2 && <0.10) [details]
License BSD-3-Clause
Copyright 2016 (c) Anton Gushcha
Author Anton Gushcha
Uploaded by NCrashed at 2016-10-14T09:53:10Z
Distributions NixOS:
Downloads 1241 total (13 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]




Maintainer's Corner

For package maintainers and hackage trustees

Readme for servant-db-

[back to package description]


The idea of package is to provide servant-like DSL for specifying an API for functions stored in RDBMS.

data RegisterUser = RegisterUser {
  userName :: Text
, userPassword :: Text
, userPhone :: Phone
, userEmail :: Email

type API = 
       ArgNamed "user" RegisterUser
    :> ArgNamed "isAdmin" Bool
    :> Procedure "registerUser" (Maybe (Only UserId))
  :<|> ArgPos UserId
    :> Procedure "getUser" (Maybe User)
  :<|> Procedure "listUsers" [User]

The library adds three custom combinators:

  • ArgNamed name a - named argument of stored function of type a.

  • ArgPos a - unamed argument of stored function of type a.

  • Procedure name a - named stored function with return type a.

Related libraries: