The yeshql package

[Tags:library, mit, test]

Use quasi-quotations or TemplateHaskell to write SQL in SQL, while adding type annotations to turn SQL into well-typed Haskell functions.


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.2.0.0, 0.2.0.1, 0.3.0.0, 0.3.0.2, 0.3.0.3, 1.0.0.0, 1.0.0.1, 2.0.0.0, 2.1.0.0, 2.2.0.0, 3.0.0.0, 3.0.0.1
Dependencies base (>=4.6 && <5.0), containers (>=0.5 && <1.0), convertible (>=1.1.1.0 && <2), filepath, HDBC (>=2.4 && <3.0), parsec (>=3.0 && <4.0), syb-with-class (>=0.6.1.7 && <1), template-haskell [details]
License MIT
Copyright 2015-2016 Tobias Dammers
Author Tobias Dammers
Maintainer tdammers@gmail.com
Category Database
Uploaded Mon Mar 27 07:37:27 UTC 2017 by TobiasDammers
Distributions NixOS:3.0.0.1
Downloads 453 total (18 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Last success reported on 2017-03-27 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for yeshql

Readme for yeshql-3.0.0.1

YeshQL

YesQL-style SQL database abstraction.

YeshQL implements quasiquoters that allow the programmer to write SQL queries in SQL, and embed these into Haskell programs using quasi-quotation. YeshQL takes care of generating suitable functions that will run the SQL queries against a HDBC database driver, and marshal values between Haskell and SQL.

In order to do this properly, YeshQL extends SQL syntax with type annotations and function names; other than that, it is perfectly ignorant about the SQL syntax itself. See the YesQL Readme for the full rationale - Haskell and Clojure are sufficiently different languages, but the reasoning behind YesQL applies to YeshQL almost unchanged.

Installation

Use stack or cabal to install. Nothing extraordinary here.

Usage

In short:

{-#LANGUAGE QuasiQuotes #-}
import MyProject.DatabaseConnection (withDB)
import Database.HDBC
import Database.YeshQL

[yesh|
  -- name:getUser :: (String)
  -- :userID :: Int
  SELECT username FROM users WHERE id = :userID
|] 

main = withDB $ \conn -> do
  username <- getUser 1 conn
  putStrLn username

Please refer to the Haddock documentation for further usage details.

Bugs

Probably. The project is hosted at https://bitbucket.org/tdammers/yeshql, feel free to comment there or send a message to tdammers@gmail.com if you find any.

Something about the name

YeshQL is rather heavily inspired by YesQL, so it makes sense to blatantly steal most of the name. Throwing in an "H" for good measure (this being Haskell and all) makes it sound like Sean Connery, which automatically increases aweshomenesh, so that'sh what we'll roll with.

License / Copying

YeshQL is Free Software and provided as-is. Please see the enclosed LICENSE file for details.