Skip to content

ISO 8601 notice for format() #1442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rsill-neo4j wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

ISO 8601 notice for format() #1442

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions modules/ROOT/pages/functions/temporal/format.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ The `format()` function creates dynamically formatted string representations of
| *Description* 3+| Returns the temporal value as an ISO-formatted `STRING` or as a `STRING` formatted by the provided pattern.
.3+| *Arguments* | *Name* | *Type* | *Description*
| `value` | `DATE \| LOCAL TIME \| ZONED TIME \| LOCAL DATETIME \| ZONED DATETIME \| DURATION` | A temporal value to be formatted.
| `pattern` | `STRING` | A pattern used to format the temporal value. If the pattern is not provided the value will be formatted according to ISO 8601.
| `pattern` | `STRING` | A pattern used to format the temporal value. If the pattern is not provided the value is in most cases formatted according to ISO 8601.
| *Returns* 3+| `STRING`
|===

.Considerations
|===
| The output format can be customized via the `pattern` parameter.
| The `pattern` parameter follows the link:https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/time/format/DateTimeFormatter.html[Java DateTimeFormatter].
| If no pattern is specified, the function returns an ISO-formatted string.
| If no pattern is specified, the function returns an ISO-formatted string with some exceptions where the Cypher implementation is more lenient than ISO 8601, for instance when using seconds in a timezone.
| Most characters 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.
| Any character that is not reserved, other than `[`, `]`, `{`, `}`, `#`, and `'`, are output directly. To ensure future compatibility it is recommended to wrap all characters that you want to output directly with single quotes.
Expand Down