Skip to content
No description, website, or topics provided.
Haskell
Branch: master
Clone or download
Tom Ellis
Latest commit ffbacad Sep 9, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Doc Changes of nomenclature in tutorials Sep 10, 2019
Test Fix date format for time 1.9.3 Sep 10, 2019
opaleye-sqlite Add tests for literals Nov 29, 2018
src wsp Sep 10, 2019
.gitignore Use dotenv to read .env Jun 28, 2017
.travis.yml Bump neil Sep 10, 2019
CHANGELOG.md version -> 0.6.7004.1 Sep 10, 2019
LICENSE Add Tom Ellis to copyright Sep 10, 2019
README.md Upgrade to latest version of neil May 11, 2019
Setup.hs Add Setup.hs Nov 30, 2014
TODO.md TODO: Escape hatch Feb 21, 2016
opaleye.cabal version -> 0.6.7004.1 Sep 10, 2019
stack.yaml Add missing deps to stack.yaml Nov 22, 2018

README.md

Brief introduction to Opaleye Hackage version Linux build status

Opaleye is a Haskell library that provides an SQL-generating embedded domain specific language for targeting Postgres. You need Opaleye if you want to use Haskell to write typesafe and composable code to query a Postgres database.

"Opaleye really is great. You've managed to bring what is so wonderful about relational databases and give it type safety and composition (i.e. what is wonderful about Haskell)" – Daniel Patterson, Position Development

"We use it for most of our DB code. It's very flexible and almost always as performant as manually written queries" – Adam Bergmark, Silk.co

Opaleye allows you to define your database tables and write queries against them in Haskell code, and aims to be typesafe in the sense that if your code compiles then the generated SQL query will not fail at runtime. A wide range of SQL functionality is supported including inner and outer joins, restriction, aggregation, distinct, sorting and limiting, unions and differences. Facilities to insert to, update and delete from tables are also provided. Code written using Opaleye is composable at a very fine level of granularity, promoting code reuse and high levels of abstraction.

Getting Opaleye

Tutorials

Please get started with Opaleye by referring to these two tutorials

Contact

Contact the author

The main author of Opaleye is Tom Ellis. He can be contacted via email.

File bugs

Please file bugs on the Opaleye GitHub issue tracking page.

Mailing list

Please join the opaleye-users mailing list.

Internal modules

Opaleye exports a number of modules named Opaleye.Internal..... They are provided in case of urgent need for access to the internals, but they are not intended to be used by API consumers and if you find yourself repeatedly accessing them this is a sign that either you or Opaleye are doing something wrong. In such a case please file a bug.

The interface of Internal modules does not follow the PVP and may break between minor releases, so be careful.

Running tests

You must have running PostgreSQL server to run tests. Specify the database by setting the POSTGRES_CONNSTRING environment variable:

POSTGRES_CONNSTRING="user=tom dbname=opaleye_test" stack test

Commercial support

Commercial support for Opaleye is provided by Purely Agile.

Backup maintainers

In the event of the main developer becoming unreachable, please contact the following who are authorised to make bugfixes and dependency version bumps:

  • Adam Bergmark
  • Erik Hesselink
  • Oliver Charles

Contributors

The Opaleye Project was founded by Tom Ellis, inspired by theoretical work on databases by David Spivak. Much of the implementation was based on ideas and code from the HaskellDB project by Daan Leijen, Conny Andersson, Martin Andersson, Mary Bergman, Victor Blomqvist, Bjorn Bringert, Anders Hockersten, Torbjorn Martin, Jeremy Shaw and Justin Bailey.

The following individuals and organisations made helpful contributions which were important in helping to get the project off the ground.

  • Silk (Erik Hesselink, Adam Bergmark)
  • Karamaan (Christopher Lewis)
  • Fynder (Renzo Carbonara, Oliver Charles)
  • Daniel Patterson
  • Jakub Ryška
  • Travis Staton

Joseph Abrahamson, Alfredo Di Napoli and Mietek Bak performed useful reviews of early versions which helped improve the codebase. Since then there have been helpful contributions from many others. Thanks to them all for their help.

You can’t perform that action at this time.