apoc.temporal.format
FunctionDeprecated in Cypher 25

This function is deprecated. Use Cypher’s format() function instead.

Details
Syntax	`apoc.temporal.format(temporal [, format ])`
Description	Formats the given temporal value into the given time format.
Arguments	Name	Type	Description
	`temporal`	`ANY`	A temporal value to be formatted.
	`format`	`STRING`	The format to return the temporal value in. The default is: `yyyy-MM-dd`.
Returns	`STRING`

Usage Examples

apoc.temporal.format

RETURN apoc.temporal.format( date(), 'yyyy-MM-dd') AS output;

Cypher’s format function

RETURN format(date(), 'yyyy-MM-dd') AS output;

Results
output
"2021-01-19"

apoc.temporal.format

RETURN apoc.temporal.format( datetime(), 'yyyy-MM-dd HH:mm:ss.SSSSZ') AS output;

Cypher’s format function

RETURN format( datetime(), 'yyyy-MM-dd HH:mm:ss.SSSSZ') AS output;

Results
output
"2021-01-19 10:57:25.2140+0000"

apoc.temporal.format

RETURN apoc.temporal.format( localtime(), 'HH:mm:ss.SSSS') AS output;

Cypher’s format function

RETURN format( localtime(), 'HH:mm:ss.SSSS') AS output;

Results
output
"10:57:57.8140"

apoc.temporal.format

RETURN apoc.temporal.format( date( { year: 2018, month: 12, day: 10 } ), 'ISO_DATE' ) as output;

Cypher’s format function

RETURN format( date( { year: 2018, month: 12, day: 10 } ) ) as output;

Results
Output
"2018-12-10"

apoc.temporal.format

RETURN apoc.temporal.format( duration.between( datetime.transaction(), datetime.realtime() ) , 'HH:mm:ss.SSSS') AS output;

Cypher’s format function

RETURN format( duration.between( datetime.transaction(), datetime.realtime() ) , 'HH:mm:ss.SSSS') AS output;

Results
Output
"00:00:00.0131"