Database.YeshQL.Backend

Backend abstractions for YeshQL.

Documentation

data YeshBackend

A backend provides just the information required to build query functions from a parsed query.

Constructors

YeshBackend

Fields

• ybNames :: ParsedQuery -> ([Name], [PatQ], String, TypeQ)

  Argument names, argument patterns, query function name, query function type

• ybMkQueryBody :: ParsedQuery -> Q Exp

data YeshImpl

A YeshQL implementation. From this, we can build both TH splices and quasiquoters.

Constructors

YeshImpl

Fields

• yiDecs :: Q [Dec]
• yiExp :: Q Exp

foldYeshImpls :: [YeshImpl] -> YeshImpl

class Yesh a where

We want to be able to call the yesh family of functions in both QQ and TH contexts, so unfortunately we need some typeclass polymorphism.

Minimal complete definition

yeshWith, yesh1With

Methods

yeshWith :: YeshBackend -> a

yesh1With :: YeshBackend -> a

Instances

Yesh QuasiQuoter

Defined in Database.YeshQL.Backend

Methods

yeshWith :: YeshBackend -> QuasiQuoter

yesh1With :: YeshBackend -> QuasiQuoter

Yesh (String -> Q [Dec])

Defined in Database.YeshQL.Backend

Methods

yeshWith :: YeshBackend -> String -> Q [Dec]

yesh1With :: YeshBackend -> String -> Q [Dec]

Yesh (String -> Q Exp)

Defined in Database.YeshQL.Backend

Methods

yeshWith :: YeshBackend -> String -> Q Exp

yesh1With :: YeshBackend -> String -> Q Exp

class YeshFile a where

Minimal complete definition

yeshFileWith, yesh1FileWith

Methods

yeshFileWith :: YeshBackend -> a

yesh1FileWith :: YeshBackend -> a

Instances

YeshFile QuasiQuoter

Defined in Database.YeshQL.Backend

Methods

yeshFileWith :: YeshBackend -> QuasiQuoter

yesh1FileWith :: YeshBackend -> QuasiQuoter

YeshFile (String -> Q [Dec])

Defined in Database.YeshQL.Backend

Methods

yeshFileWith :: YeshBackend -> String -> Q [Dec]

yesh1FileWith :: YeshBackend -> String -> Q [Dec]

YeshFile (String -> Q Exp)

Defined in Database.YeshQL.Backend

Methods

yeshFileWith :: YeshBackend -> String -> Q Exp

yesh1FileWith :: YeshBackend -> String -> Q Exp

yeshAllWith :: YeshBackend -> Either ParsedQuery [ParsedQuery] -> YeshImpl

This is where much of the magic happens: this function asks the backend for some building blocks, and assembles a YeshImpl of the provided query or queries.

describeBackend :: YeshBackend

docBackend :: YeshBackend