Yesod.Filter.TH

Documentation

mkFilterGenerator :: Text -> Options -> DecsQ

Generates the function that creates the list of Filter and the list of SelectOpt from query parameters.

mkFilters :: ExpQ

Generates the list of Filter.

mkSelectOpts :: ExpQ

Generates the list of SelectOpt.

data Options

Options to specify filtering, sorting, and pagination settings to generate.

Constructors

Options

Fields

• filtering :: Filtering
• sorting :: Sorting
• pagination :: Pagination

Instances

Show Options

Defined in Yesod.Filter.Types

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

Lift Options

Defined in Yesod.Filter.Types

Methods

lift :: Options -> Q Exp

data Filtering

A filtering setting.

Constructors

SimpleFiltering

Allow users to specify filtering by query parameters.

Fields

• filterDefs :: [FilterDef]

NoFiltering

Disable filtering.

Instances

Show Filtering

Defined in Yesod.Filter.Types

Methods

showsPrec :: Int -> Filtering -> ShowS

show :: Filtering -> String

showList :: [Filtering] -> ShowS

Lift Filtering

Defined in Yesod.Filter.Types

Methods

lift :: Filtering -> Q Exp

data FilterDef

A filter defintion.

Constructors

FilterDef

Fields

• Text

  A field name used for the filter.

• [FilterParam]

  Parameters used to specify the filter.

Instances

Show FilterDef

Defined in Yesod.Filter.Types

Methods

showsPrec :: Int -> FilterDef -> ShowS

show :: FilterDef -> String

showList :: [FilterDef] -> ShowS

Lift FilterDef

Defined in Yesod.Filter.Types

Methods

lift :: FilterDef -> Q Exp

data FilterParam

A parameter name used to specify the filter.

Constructors

AutoParam FilterOp

Use automatically generated parameter names.

CustomParam FilterOp Text

Use custom parameter name.

Instances

Show FilterParam

Defined in Yesod.Filter.Types

Methods

showsPrec :: Int -> FilterParam -> ShowS

show :: FilterParam -> String

showList :: [FilterParam] -> ShowS

Lift FilterParam

Defined in Yesod.Filter.Types

Methods

lift :: FilterParam -> Q Exp

data FilterOp

A comparison operator to apply to the filter.

Constructors

EqOp

=

NeOp

<>

GtOp

>

LtOp

<

GeOp

>=

LeOp

<=

IsNullOp

IS NULL

Instances

Show FilterOp

Defined in Yesod.Filter.Types

Methods

showsPrec :: Int -> FilterOp -> ShowS

show :: FilterOp -> String

showList :: [FilterOp] -> ShowS

Lift FilterOp

Defined in Yesod.Filter.Types

Methods

lift :: FilterOp -> Q Exp

data Sorting

A sorting setting.

Constructors

AllowSorting

Allow users to specify sort order by query parameters.

Fields

• sortParam :: Text

  A parameter name to specify the field name as a sort key.

• sortFields :: [Text]

  Field names that can be used as sort keys.

• defaultOrdering :: SortOrdering

  A default order setting.

DisallowSorting

Disable sorting.

Instances

Show Sorting

Defined in Yesod.Filter.Types

Methods

showsPrec :: Int -> Sorting -> ShowS

show :: Sorting -> String

showList :: [Sorting] -> ShowS

Lift Sorting

Defined in Yesod.Filter.Types

Methods

lift :: Sorting -> Q Exp

data SortOrdering

A value that becomes the SQL ORDER BY clause.

Constructors

NaturalOrdering

ORDERBY Text SortDirection

Instances

Show SortOrdering

Defined in Yesod.Filter.Types

Methods

showsPrec :: Int -> SortOrdering -> ShowS

show :: SortOrdering -> String

showList :: [SortOrdering] -> ShowS

Lift SortOrdering

Defined in Yesod.Filter.Types

Methods

lift :: SortOrdering -> Q Exp

data SortDirection

Constructors

ASC

DESC

Instances

Show SortDirection

Defined in Yesod.Filter.Types

Methods

showsPrec :: Int -> SortDirection -> ShowS

show :: SortDirection -> String

showList :: [SortDirection] -> ShowS

Lift SortDirection

Defined in Yesod.Filter.Types

Methods

lift :: SortDirection -> Q Exp

data Pagination

A pagination setting. Currently, only offset pagination is available.

Constructors

OffsetPagination

Allow users to specify offset pagination by query parameters.

Fields

• offsetParam :: Text

  A parameter name to specify the offset value.

• defaultOffset :: PageOffset

  A default offset setting.

• limitParam :: Text

  A parameter name to specify the limit value.

• defaultLimit :: PageLimit

  A default limit setting.

NoPagination

Disable pagination.

Instances

Show Pagination

Defined in Yesod.Filter.Types

Methods

showsPrec :: Int -> Pagination -> ShowS

show :: Pagination -> String

showList :: [Pagination] -> ShowS

Lift Pagination

Defined in Yesod.Filter.Types

Methods

lift :: Pagination -> Q Exp

data PageLimit

A value that becomes the SQL LIMIT clause.

Constructors

NoLimit

LIMIT Int

Instances

Show PageLimit

Defined in Yesod.Filter.Types

Methods

showsPrec :: Int -> PageLimit -> ShowS

show :: PageLimit -> String

showList :: [PageLimit] -> ShowS

Lift PageLimit

Defined in Yesod.Filter.Types

Methods

lift :: PageLimit -> Q Exp

data PageOffset

A value that becomes the SQL OFFSET clause.

Constructors

NoOffset

OFFSET Int

Instances

Show PageOffset

Defined in Yesod.Filter.Types

Methods

showsPrec :: Int -> PageOffset -> ShowS

show :: PageOffset -> String

showList :: [PageOffset] -> ShowS

Lift PageOffset

Defined in Yesod.Filter.Types

Methods

lift :: PageOffset -> Q Exp

defaultOptions :: Options

Default options.

defaultFiltering :: Filtering

A default filtering setting.

defaultFilterParams :: [FilterParam]

Default filter parameters.

defaultSorting :: Sorting

A default sorting setting.

defaultPagination :: Pagination

A default pagination setting.

mkToFilterValueInstances :: Text -> DecsQ

availableFiltersE :: Text -> Filtering -> ExpQ

defaultOrderByE :: Text -> Sorting -> ExpQ

availableOrderBysE :: Text -> Sorting -> ExpQ