# Flop v0.26.4 - Table of Contents

> Filtering, ordering and pagination with Ecto.

## GUIDES

- [Flop](readme.md)
- [Changelog](changelog.md)

- Recipes
  - [Partial UUID Filter](partial_uuid_filter.md)

- Cheatsheets
  - [Schema configuration](schema.md)

## Modules

- [Flop](Flop.md): Flop is a helper library for filtering, ordering and pagination with Ecto.
- [Flop.Cursor](Flop.Cursor.md): Functions for encoding, decoding and extracting cursor values.

- [Flop.FieldInfo](Flop.FieldInfo.md): Defines a struct that holds the information about a schema field.
- [Flop.Filter](Flop.Filter.md): Defines a filter.

- [Flop.Meta](Flop.Meta.md): Defines a struct for holding meta information of a query result.

- [Flop.Relay](Flop.Relay.md): Helpers to turn query results into Relay formats.

- [Flop.Schema](Flop.Schema.md): Flop.Schema is a protocol that allows you to customize and set query options
in your Ecto schemas.

- Exceptions
  - [Flop.InvalidCursorError](Flop.InvalidCursorError.md): Raised when an invalid cursor is passed to the decode function.
  - [Flop.InvalidDefaultOrderError](Flop.InvalidDefaultOrderError.md)
  - [Flop.InvalidDefaultPaginationTypeError](Flop.InvalidDefaultPaginationTypeError.md)
  - [Flop.InvalidDirectionsError](Flop.InvalidDirectionsError.md): An error that is raised when invalid directions are passed.

  - [Flop.InvalidParamsError](Flop.InvalidParamsError.md): Raised when parameter validation fails.
  - [Flop.NoRepoError](Flop.NoRepoError.md)
  - [Flop.UnknownFieldError](Flop.UnknownFieldError.md)

