haskell/esqueleto
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Reword package description (fixes #65).

Browse Source
This commit is contained in:
Felipe Lessa 2014-05-21 14:16:26 -03:00
parent dbe4689cd7
commit 2be1c1bc20
1 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
esqueleto.cabal
View File

@ -1,6 +1,6 @@
name: esqueleto name: esqueleto
version: 1.4.1 version: 1.4.1
synopsis: Bare bones, type-safe EDSL for SQL queries on persistent backends. synopsis: Type-safe EDSL for SQL queries on persistent backends.
homepage: https://github.com/meteficha/esqueleto homepage: https://github.com/meteficha/esqueleto
license: BSD3 license: BSD3
license-file: LICENSE license-file: LICENSE
@ -11,28 +11,27 @@ category: Database
build-type: Simple build-type: Simple
cabal-version: >=1.8 cabal-version: >=1.8
description: description:
@persistent@ is a library for type-safe data serialization. It
has many kinds of backends, such as SQL backends
(@persistent-mysql@, @persistent-postgresql@,
@persistent-sqlite@) and NoSQL backends (@persistent-mongoDB@).
.
While @persistent@ is a nice library for storing and retrieving
records, currently it has a poor interface for SQL backends
compared to SQL itself. For example, it's extremely hard to do
a type-safe @JOIN@ on a many-to-one relation, and simply
impossible to do any other kinds of @JOIN@s (including for the
very common many-to-many relations). Users have the option of
writing raw SQL, but that's error prone and not type-checked.
.
@esqueleto@ is a bare bones, type-safe EDSL for SQL queries @esqueleto@ is a bare bones, type-safe EDSL for SQL queries
that works with unmodified @persistent@ SQL backends. Its that works with unmodified @persistent@ SQL backends. Its
language closely resembles SQL, so (a) you don't have to learn language closely resembles SQL, so you don't have to learn
new concepts, just new syntax, and (b) it's fairly easy to new concepts, just new syntax, and it's fairly easy to
predict the generated SQL and optimize it for your backend. predict the generated SQL and optimize it for your backend.
Most kinds of errors committed when writing SQL are caught as Most kinds of errors committed when writing SQL are caught as
compile-time errors---although it is possible to write compile-time errors---although it is possible to write
type-checked @esqueleto@ queries that fail at runtime. type-checked @esqueleto@ queries that fail at runtime.
. .
@persistent@ is a library for type-safe data serialization. It
has many kinds of backends, such as SQL backends
(@persistent-mysql@, @persistent-postgresql@,
@persistent-sqlite@) and NoSQL backends (@persistent-mongoDB@).
While @persistent@ is a nice library for storing and retrieving
records, including with filters, it does not try to support
some of the features that are specific to SQL backends. In
particular, @esqueleto@ is the recommended library for
type-safe @JOIN@s on @persistent@ SQL backends. (The
alternative is using raw SQL, but that's error prone and does
not offer any composability.)
.
Currently, @SELECT@s, @UPDATE@s, @INSERT@s and @DELETE@s are supported. Currently, @SELECT@s, @UPDATE@s, @INSERT@s and @DELETE@s are supported.
Not all SQL features are available, but most of them can be easily added Not all SQL features are available, but most of them can be easily added
(especially functions), so please open an issue or send a pull request if (especially functions), so please open an issue or send a pull request if