examples for instance types

Author: rsill-neo4j

modules/ROOT/pages/functions/temporal/format.adoc

@@ -78,9 +78,9 @@ Most characters change yield a different output when they are repeated.
 
 | Some characters cannot be applied to certain types, for instance, `u` cannot be used to construct a string for a `LOCAL TIME` because it represents a year which is not part of the temporal value.
 
-| The "text" style is determined by how often the pattern character is repeated: less than 4 characters result in the short form ("AD"). Exactly 4 characters result in the full form ("Anno Domini"). Exactly 5 characters result in the narrow form ("A").
+| The "text" presentation is determined by how often the pattern character is repeated: less than 4 characters result in the short form ("AD"). Exactly 4 characters result in the full form ("Anno Domini"). Exactly 5 characters result in the narrow form ("A").
 
-The characters 'L', 'q', and 'c' represent the standalone form of the text styles.
+The characters 'L', 'q', and 'c' represent the standalone form of the text presentation.
 
 | A single "number" character outputs the minimum number of digits without padding. With more "number" characters, the number of digits is used as the width of the output field, with the value zero-padded as necessary.
 
@@ -152,13 +152,13 @@ More characters will result in an error.
 
 |===
 
-.awesome example
+.Formatting with year, month, day, hour, minute, second, fraction-of-second and zone-offset
 ======
 
 .Query
 [source, cypher, indent=0]
 ----
-WITH datetime('2024-06-27T14:30:45.123456789+02:00[Europe/Paris]') AS dt
+WITH datetime('1986-11-18T6:04:45.123456789+01:00[Europe/Berlin]') AS dt
 RETURN format(dt, "yyyy-MM-dd'T'HH:mm:ss.SSSZ") AS x
 ----
 
@@ -167,13 +167,217 @@ RETURN format(dt, "yyyy-MM-dd'T'HH:mm:ss.SSSZ") AS x
 |===
 
 | x
-| "2024-06-27T14:30:45.123+0200"
+| "1986-11-18T06:04:45.123+0100"
+1+d|Rows: 1
+
+|===
+
+======
+
+.Formatting with day-of-week, month-of-year, day-of-month, era and year
+======
+
+.Query
+[source, cypher, indent=0]
+----
+WITH datetime('1986-11-18T6:04:45.123456789+01:00[Europe/Berlin]') AS dt
+RETURN format(dt, "EEEE, MMMM d, G uuuu") AS x
+----
+
+.Result
+[role="queryresult",options="header,footer",cols="1*<m"]
+|===
+
+| x
+| "Tuesday, November 18, AD 1986"
+1+d|Rows: 1
+
+|===
+
+Four occurrences of `E` and `M` (text presentations) output the full form of the day and month.
+
+======
+
+.Formatting with day-of-year and localized day-of-week
+======
+
+.Query
+[source, cypher, indent=0]
+----
+WITH datetime('1986-11-18T6:04:45.123456789+01:00[Europe/Berlin]') AS dt
+RETURN format(dt, "DDD'th day of the year,' c'rd day of the week'") AS x
+----
+
+.Result
+[role="queryresult",options="header,footer",cols="1*<m"]
+|===
+
+| x
+| "322th day of the year, 3rd day of the week"
+1+d|Rows: 1
+
+|===
+
+======
+
+.Formatting with day-of-year and localized day-of-week
+======
+
+.Query
+[source, cypher, indent=0]
+----
+WITH datetime('1986-11-18T6:04:45.123456789+01:00[Europe/Berlin]') AS dt
+RETURN format(dt, "DDD'th day of the year,' c'rd day of the week'") AS x
+----
+
+.Result
+[role="queryresult",options="header,footer",cols="1*<m"]
+|===
+
+| x
+| "322th day of the year, 3rd day of the week"
+1+d|Rows: 1
+
+|===
+
+======
+
+.Formatting with clock-hour-of-day (1-24), minute-of-hour and time-zone name
+======
+
+.Query
+[source, cypher, indent=0]
+----
+WITH datetime('1986-11-18T6:04:45.123456789+01:00[Europe/Berlin]') AS dt
+RETURN format(dt, "k:mm z") AS x
+----
+
+.Result
+[role="queryresult",options="header,footer",cols="1*<m"]
+|===
+
+| x
+| "6:04 CET"
+1+d|Rows: 1
+
+|===
+
+======
+
+.Formatting with hour-of-am-pm (0-11), minute-of-hour and localized zone-offset
+======
+
+.Query
+[source, cypher, indent=0]
+----
+WITH datetime('1986-11-18T6:04:45.123456789+01:00[Europe/Berlin]') AS dt
+RETURN format(dt, "K:mm O") AS x
+----
+
+.Result
+[role="queryresult",options="header,footer",cols="1*<m"]
+|===
+
+| x
+| "6:04 GMT+1"
+1+d|Rows: 1
+
+|===
+
+======
+
+.Formatting with month-of-year, day-of-month, milli-of-day, minute-of-hour and second-of-minute
+======
+
+.Query
+[source, cypher, indent=0]
+----
+WITH datetime('1986-11-18T6:04:45.123456789+01:00[Europe/Berlin]') AS dt
+RETURN format(dt, "LLL d,' minute 'm', second 's', millisecond of the day 'A") AS x
+----
+
+.Result
+[role="queryresult",options="header,footer",cols="1*<m"]
+|===
+
+| x
+| "Nov 18, minute 4, second 45, millisecond of the day 21885123"
+1+d|Rows: 1
+
+|===
+
+Three occurrences of `L` (number/text presentation) output the short form ("Nov").
+
+======
+
+.Formatting with nano-of-second and nano-of-day
+======
+
+.Query
+[source, cypher, indent=0]
+----
+WITH datetime('1986-11-18T6:04:45.123456789+01:00[Europe/Berlin]') AS dt
+RETURN format(dt, "'Nano of second: 'n', nano of day: 'N") AS x
+----
+
+.Result
+[role="queryresult",options="header,footer",cols="1*<m"]
+|===
+
+| x
+| "Nano of second: 123456789, nano of day: 21885123456789"
+1+d|Rows: 1
+
+|===
+
+======
+
+.Formatting with quarter-of-year and year-of-era
+======
+
+.Query
+[source, cypher, indent=0]
+----
+WITH datetime('1986-11-18T6:04:45.123456789+01:00[Europe/Berlin]') AS dt
+RETURN format(dt, "QQQQ' of 'yyyy") AS x
+----
+
+.Result
+[role="queryresult",options="header,footer",cols="1*<m"]
+|===
+
+| x
+| "4th quarter of 1986"
 1+d|Rows: 1
 
 |===
 
 ======
 
+.
+======
+
+.Query
+[source, cypher, indent=0]
+----
+WITH datetime('1986-11-18T6:04:45.123456789+01:00[Europe/Berlin]') AS dt
+RETURN format(dt, "pppYY") AS x
+----
+
+.Result
+[role="queryresult",options="header,footer",cols="1*<m"]
+|===
+
+| x
+| " 86"
+1+d|Rows: 1
+
+|===
+
+The three occurrences of `p` add one space character of padding to the two digit form output by two occurrences of `Y`.
+
+======
+
 [[query-functions-temporal-format-duration-types]]
 === Duration types