2021-04-01 23:17:50 +03:00
|
|
|
Welcome to Rel8!
|
2021-04-03 18:54:33 +03:00
|
|
|
================
|
2021-04-01 23:17:50 +03:00
|
|
|
|
|
|
|
|
Welcome to Rel8! Rel8 is a Haskell library for interacting with PostgreSQL
|
|
|
|
|
databases, built on top of the fantastic `Opaleye
|
|
|
|
|
<https://hackage.haskell.org/package/opaleye>`_ library.
|
|
|
|
|
|
|
|
|
|
The main objectives of Rel8 are:
|
|
|
|
|
|
|
|
|
|
* *Conciseness*: Users using Rel8 should not need to write boiler-plate code.
|
|
|
|
|
By using expressive types, we can provide sufficient information for the
|
|
|
|
|
compiler to infer code whenever possible.
|
|
|
|
|
|
|
|
|
|
* *Inferrable*: Despite using a lot of type level magic, Rel8 aims to have
|
|
|
|
|
excellent and predictable type inference.
|
|
|
|
|
|
|
|
|
|
* *Familiar*: writing Rel8 queries should feel like normal Haskell programming.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
2021-04-03 19:00:58 +03:00
|
|
|
:caption: Getting Started
|
|
|
|
|
:maxdepth: 2
|
2021-04-01 23:17:50 +03:00
|
|
|
|
2021-04-03 19:00:58 +03:00
|
|
|
tutorial
|
2021-04-03 17:30:43 +03:00
|
|
|
|
|
|
|
|
.. toctree::
|
2021-04-03 19:00:58 +03:00
|
|
|
:caption: Rel8 concepts
|
2021-04-04 22:30:33 +03:00
|
|
|
:maxdepth: 2
|
2021-04-03 17:30:43 +03:00
|
|
|
|
2021-04-03 19:00:58 +03:00
|
|
|
concepts/dbtype
|
|
|
|
|
concepts/expr
|
|
|
|
|
concepts/tables
|
2021-04-04 22:03:24 +03:00
|
|
|
concepts/queries
|
2021-06-29 15:44:20 +03:00
|
|
|
concepts/insert
|
2021-04-03 17:30:43 +03:00
|
|
|
|
|
|
|
|
.. toctree::
|
2021-04-03 19:00:58 +03:00
|
|
|
:caption: Tips and tricks
|
|
|
|
|
:maxdepth: 1
|
2021-04-03 17:30:43 +03:00
|
|
|
|
2021-04-03 19:00:58 +03:00
|
|
|
cookbook
|
2021-04-01 23:17:50 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
More Resources
|
|
|
|
|
==============
|
|
|
|
|
|
|
|
|
|
* The `Haskell API documentation <https://hackage.haskell.org/package/rel8>`_
|
|
|
|
|
describes how individual functions are types are to be used.
|
|
|
|
|
|
|
|
|
|
* If you have a question about how to use Rel8, feel free to open a `GitHub
|
|
|
|
|
discussion <https://github.com/circuithub/rel8/discussions>`_.
|
|
|
|
|
|
|
|
|
|
* If you think you've found a bug, confusing behavior, or have a feature
|
|
|
|
|
request, please raise an issue at `Rel8's issue tracker
|
2021-06-29 15:44:20 +03:00
|
|
|
<https://github.com/circuithub/rel8>`_.
|
