date.toTimeZone

Description

Converts a date/time instant to represent the wall clock time in a given timezone offset. The returned Date represents the same instant but shifted so UTC fields reflect local time.

Syntax

flex.date.toTimeZone(datetime, timezone)

Parameters

Parameter	Type	Required	Description
`datetime`	Date/number/string	Yes	The date/time value to convert
`timezone`	string	Yes	Timezone offset like `"+02:00"`, `"-05:00"`, or `"+0530"`

Returns

Type: Date A Date object adjusted to show local time in the given timezone. Returns null if input is invalid. Returns original date if timezone format is invalid.

Examples

Example 1: Convert UTC to Eastern Time

WITH datetime('2024-03-15T14:00:00Z') AS utc
RETURN flex.date.toTimeZone(utc, '-05:00') AS eastern

Output:

eastern
--------------------------
2024-03-15T09:00:00.000Z

(UTC fields now show 09:00 which is the local time in -05:00)

Example 2: Convert to Multiple Time Zones

WITH datetime('2024-03-15T12:00:00Z') AS utc
RETURN 
    flex.date.format(utc, 'HH:mm') AS utcTime,
    flex.date.format(flex.date.toTimeZone(utc, '+00:00'), 'HH:mm') AS london,
    flex.date.format(flex.date.toTimeZone(utc, '+01:00'), 'HH:mm') AS paris,
    flex.date.format(flex.date.toTimeZone(utc, '+05:30'), 'HH:mm') AS india,
    flex.date.format(flex.date.toTimeZone(utc, '-05:00'), 'HH:mm') AS newYork

Example 3: Display User Events in Local Time

MATCH (u:User {id: $userId})
MATCH (e:Event)-[:ASSIGNED_TO]->(u)
WITH e, flex.date.toTimeZone(e.timestamp, u.timezone) AS localTime
RETURN e.name, flex.date.format(localTime, 'YYYY-MM-DD HH:mm') AS localDisplay
ORDER BY e.timestamp

Example 4: Adjust for Daylight Saving Time Context

WITH datetime('2024-07-15T12:00:00Z') AS summer
RETURN flex.date.format(
    flex.date.toTimeZone(summer, '-04:00'), 
    'YYYY-MM-DD HH:mm'
) AS edtTime

Notes

Returns null for invalid date inputs
Invalid timezone format returns the original date unchanged
Timezone format accepts +HH:MM, -HH:MM, +HHMM, or -HHMM
Does not handle DST transitions automatically
The returned Date’s UTC methods will show the local time
Useful for displaying times in user’s local timezone

Frequently Asked Questions

What does flex.date.toTimeZone do?

It converts a date/time value to a different timezone by applying an offset, returning the adjusted date/time.

How do I specify the timezone offset?

The offset is specified as a numeric value representing hours (e.g., -5 for EST, +9 for JST).

Home

Description

Syntax

Parameters

Returns

Examples

Example 1: Convert UTC to Eastern Time

Example 2: Convert to Multiple Time Zones

Example 3: Display User Events in Local Time

Example 4: Adjust for Daylight Saving Time Context

Notes

See Also

Frequently Asked Questions

​Description

​Syntax

​Parameters

​Returns

​Examples

​Example 1: Convert UTC to Eastern Time

​Example 2: Convert to Multiple Time Zones

​Example 3: Display User Events in Local Time

​Example 4: Adjust for Daylight Saving Time Context

​Notes

​See Also

​Frequently Asked Questions

Description

Syntax

Parameters

Returns

Examples

Example 1: Convert UTC to Eastern Time

Example 2: Convert to Multiple Time Zones

Example 3: Display User Events in Local Time

Example 4: Adjust for Daylight Saving Time Context

Notes

See Also

Frequently Asked Questions