FQL v4 will be decommissioned on June 30, 2025. Ensure that you complete your migration from FQL v4 to FQL v10 by that date.

For more details, review the migration guide. Contact support@fauna.com with any questions.

Epoch

This reference topic applies to FQL v4. Go to this page for the latest FQL v10 reference topics.

Epoch( num, unit )
epoch(0, unit )
Epoch( num, unit )
Epoch( num, unit )
Epoch( num, unit )

Description

The Epoch function constructs a Timestamp relative to the Unix epoch (1970-01-01T00:00:00Z).

The num argument must be an integer value. The unit argument specifies the scale of num.

Parameters

Parameter Type Definition and Requirements

num

Number

A mathematical integer value specifying the offset from epoch.

unit

String

Indicates the units used by num. Must be one of:

  • day, or days

  • half day, or half days

  • hour, or hours

  • minute, or minutes

  • second, or seconds

  • millisecond, or milliseconds

  • microsecond, or microseconds

  • nanosecond, or nanoseconds

Returns

A Timestamp which represents Unix epoch plus the offset represented by num and unit.

Examples

The following query adds 0 seconds to the Unix epoch (1970-01-01T00:00:00Z) and returns a timestamp:

client.query(
  q.Epoch(0, 'second')
)
.then((ret) => console.log(ret))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))
Time("1970-01-01T00:00:00Z")
result = client.query(
  q.epoch(0, "second")
)
print(result)
FaunaTime('1970-01-01T00:00:00Z')
result, err := client.Query(
	f.Epoch(0, f.TimeUnitSecond))

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
{0 62135596800 <nil>}
try
{
    Value result = await client.Query(
        Epoch(0, "second")
    );
    Console.WriteLine(result);
}
catch (Exception e)
{
    Console.WriteLine($"ERROR: {e.Message}");
}
FaunaTime(1970-01-01T00:00:00Z)
Epoch(0, 'second')
Time("1970-01-01T00:00:00Z")
Query metrics:
  •    bytesIn:  27

  •   bytesOut:  43

  • computeOps:   1

  •    readOps:   0

  •   writeOps:   0

  •  readBytes:   0

  • writeBytes:   0

  •  queryTime: 3ms

  •    retries:   0

Is this article helpful? 

Tell Fauna how the article can be improved:
Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!