PgRest.Parser.Order (PgRest v0.1.0)

Copy Markdown View Source

Parses PostgREST order parameter into ordering directives.

Examples:

  • "created_at.desc.nullslast" -> [%{field: "created_at", direction: :desc, nulls: :last}]
  • "name.asc" -> [%{field: "name", direction: :asc, nulls: nil}]
  • "name" -> [%{field: "name", direction: :asc, nulls: nil}]

Summary

Functions

Parses an order parameter string into a list of ordering directives.

Functions

parse(order_str)

@spec parse(String.t()) :: {:ok, [map()]}

Parses an order parameter string into a list of ordering directives.

Each directive contains :field, :direction (:asc or :desc), and :nulls (:first, :last, or nil).