Skip to content

Commit 1bcc629

Browse files
committed
document JPA compatibility of extract() field types
Signed-off-by: Gavin King <[email protected]>
1 parent b1c69a2 commit 1bcc629

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

documentation/src/main/asciidoc/querylanguage/Expressions.adoc

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -687,32 +687,32 @@ The special function `extract()` obtains a single field of a date, time, or date
687687
- Its first argument is an expression that evaluates to a date, time, or datetime.
688688
- Its second argument is a date/time _field type_.
689689

690-
Field types include:
690+
Recognized Field types are listed below.
691691

692-
[cols="~,^15,^10,~"]
692+
[cols="20,^15,^10,~,^15"]
693693
|===
694-
| Field | Type | Range | Notes
695-
696-
| `day` | `Integer` | 1-31 | Calendar day of month
697-
| `month` | `Integer` | 1-12 |
698-
| `year` | `Integer` | |
699-
| `week` | `Integer` | 1-53 | ISO-8601 week number (different to `week of year`)
700-
| `quarter` | `Integer` | 1-4 | Quarter defined as 3 months
701-
| `hour` | `Integer` | 0-23 | Standard 24-hour time
702-
| `minute` | `Integer` | 0-59 |
703-
| `second` | `Float` | 0-59 | Includes fractional seconds
704-
| `nanosecond` | `Long` | | Granularity varies by database
705-
| `day of week` | `Integer` | 1-7 |
706-
| `day of month` | `Integer` | 1-31 | Synonym for `day`
707-
| `day of year` | `Integer` | 1-365 |
708-
| `week of month` | `Integer` | 1-5 |
709-
| `week of year` | `Integer` | 1-53 |
710-
| `epoch` | `Long` | | Elapsed seconds since January 1, 1970
711-
| `date` | `LocalDate` | | Date part of a datetime
712-
| `time` | `LocalTime` | | Time part of a datetime
713-
| `offset` | `ZoneOffset` | | Timezone offset
714-
| `offset hour` | `Integer` | | Hours of offset
715-
| `offset minute` | `Integer` | 0-59 | Minutes of offset
694+
| Field | Type | Range | Notes | JPA standard
695+
696+
| `day` | `Integer` | 1-31 | Calendar day of month | ✔
697+
| `month` | `Integer` | 1-12 | | ✔
698+
| `year` | `Integer` | | | ✔
699+
| `week` | `Integer` | 1-53 | ISO-8601 week number (different to `week of year`) | ✔
700+
| `quarter` | `Integer` | 1-4 | Quarter defined as 3 months | ✔
701+
| `hour` | `Integer` | 0-23 | Standard 24-hour time | ✔
702+
| `minute` | `Integer` | 0-59 | | ✔
703+
| `second` | `Float` | 0-59 | Includes fractional seconds | ✔
704+
| `nanosecond` | `Long` | | Granularity varies by database | ✖
705+
| `day of week` | `Integer` | 1-7 | | ✖
706+
| `day of month` | `Integer` | 1-31 | Synonym for `day` | ✖
707+
| `day of year` | `Integer` | 1-365 | | ✖
708+
| `week of month` | `Integer` | 1-5 | | ✖
709+
| `week of year` | `Integer` | 1-53 | | ✖
710+
| `epoch` | `Long` | | Elapsed seconds since January 1, 1970 | ✖
711+
| `date` | `LocalDate` | | Date part of a datetime | ✔
712+
| `time` | `LocalTime` | | Time part of a datetime | ✔
713+
| `offset` | `ZoneOffset` | | Timezone offset | ✖
714+
| `offset hour` | `Integer` | | Hours of offset | ✖
715+
| `offset minute` | `Integer` | 0-59 | Minutes of offset | ✖
716716
|===
717717

718718
For a full list of field types, see the Javadoc for https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/query/TemporalUnit.html[`TemporalUnit`].

0 commit comments

Comments
 (0)