apoc.date.convertFormat
FunctionDeprecated in 25

This function is deprecated. Use a combination of Cypher’s format() function and the corresponding temporal type constructor instead, for example date().
Details

Syntax

apoc.date.convertFormat(temporal, currentFormat [, convertTo ])

Description

Converts a STRING of one type of date format into a STRING of another type of date format.

Arguments

Name

Type

Description

temporal

STRING

A string representation of a temporal value.

currentFormat

STRING

The format the given temporal is formatted as.

convertTo

STRING

The format to convert the given temporal value to. The default is: yyyy-MM-dd.

Returns

STRING

Usage Examples

The currentFormat parameter supports the values specified under Patterns for Formatting and Parsing for the DateTimeFormatter.

The convertTo parameter supports Java formats or built-in formats.

The following converts a date in yyyy-MM-dd format to basic_date (yyyyMMdd) format:

apoc.date.convertFormat
RETURN apoc.date.convertFormat("2020-11-04", "date", "basic_date") AS output;
Cypher’s pattern constructors and format function
RETURN format(date("2020-11-04"), "yyyyMMdd") AS output;
Results
output

"20201104"

The following converts a date in date_hour (yyyy-MM-dd’T’HH) format to date_hour_minute (yyyy-MM-dd’T’HH:mm) format:

apoc.date.convertFormat
RETURN apoc.date.convertFormat("2020-11-04T22", "date_hour", "date_hour_minute") AS output;
Cypher’s pattern constructors and format function
RETURN format(localdatetime("2020-11-04T22", "yyyy-MM-dd'T'HH"), "yyyy-MM-dd'T'HH:mm") AS output;
Results
output

"2020-11-04T22:00"