Clarify that writing portable SQL is not one of our goals.

This commit is contained in:
Felipe Lessa 2012-09-09 10:22:32 -03:00
parent 65e7e67247
commit c8a96db9da

View File

@ -86,14 +86,18 @@ import qualified Database.Persist.Store
-- project page (<https://github.com/meteficha/esqueleto>) if -- project page (<https://github.com/meteficha/esqueleto>) if
-- there's anything missing that you'd like to see. -- there's anything missing that you'd like to see.
-- --
-- * Be as type-safe as possible. There are ways of shooting -- * Be as type-safe as possible. We strive to provide as many
-- yourself in the foot while using @esqueleto@ because it's -- type checks as possible. If you get bitten by some invalid
-- extremely hard to provide 100% type-safety into a SQL-like -- code that type-checks, please open an issue on our project
-- EDSL---there's a tension between supporting features with a -- page so we can take a look.
-- nice syntax and rejecting bad code. However, we strive to --
-- provide as many type checks as possible. If you get bitten -- However, it is /not/ a goal to be able to write portable SQL.
-- by some invalid code that type-checks, please open an issue -- We do not try to hide the differences between DBMSs from you,
-- on our project page so we can take a look. -- and @esqueleto@ code that works for one database may not work
-- on another. This is a compromise we have to make in order to
-- give you as much control over the raw SQL as possible without
-- losing too much convenience. This also means that you may
-- type-check a query that doesn't work on your DBMS.
---------------------------------------------------------------------- ----------------------------------------------------------------------