Ecto.Date

An Ecto type for dates.

Source

Summary

cast(d)

Casts the given value to date

compare(t1, t2)

Compare two dates

dump(arg1)

Converts an Ecto.Date into a date triplet

from_erl(arg)

Returns an Ecto.Date from an Erlang date tuple

load(arg1)

Converts a date triplet into an Ecto.Date

local()

Returns an Ecto.Date in local time

to_erl(date)

Returns an Erlang date tuple from an Ecto.Date

to_iso8601(date)

Converts Ecto.Date to ISO8601 representation

to_string(date)

Converts Ecto.Date to a readable string representation

type()

The Ecto primitive type

utc()

Returns an Ecto.Date in UTC

Functions

cast(d)

Casts the given value to date.

It supports:

  • a binary in the “YYYY-MM-DD” format
  • a map with "year", "month" and "day" keys with integer or binaries as values
  • a map with :year, :month and :day keys with integer or binaries as values
  • a tuple with {year, month, day} as integers or binaries
  • an Ecto.Date struct itself
Source
compare(t1, t2)

Compare two dates.

Receives two dates and compares the t1 against t2 and returns :lt, :eq or :gt.

Source
dump(arg1)

Converts an Ecto.Date into a date triplet.

Source
from_erl(arg)

Returns an Ecto.Date from an Erlang date tuple.

Source
load(arg1)

Converts a date triplet into an Ecto.Date.

Source
local()

Returns an Ecto.Date in local time.

Source
to_erl(date)

Returns an Erlang date tuple from an Ecto.Date.

Source
to_iso8601(date)

Converts Ecto.Date to ISO8601 representation.

Source
to_string(date)

Converts Ecto.Date to a readable string representation.

Source
type()

The Ecto primitive type.

Source
utc()

Returns an Ecto.Date in UTC.

Source