date-time.asciidoc 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[sql-functions-datetime]]
  4. === Date/Time and Interval Functions and Operators
  5. {es-sql} offers a wide range of facilities for performing date/time manipulations.
  6. [[sql-functions-datetime-interval]]
  7. ==== Intervals
  8. A common requirement when dealing with date/time in general revolves around
  9. the notion of `interval`, a topic that is worth exploring in the context of {es} and {es-sql}.
  10. {es} has comprehensive support for <<date-math, date math>> both inside <<date-math-index-names, index names>> and <<mapping-date-format, queries>>.
  11. Inside {es-sql} the former is supported as is by passing the expression in the table name, while the latter is supported through the standard SQL `INTERVAL`.
  12. The table below shows the mapping between {es} and {es-sql}:
  13. [cols="^m,^m"]
  14. |==========================
  15. s|{es}
  16. s|{es-sql}
  17. 2+h| Index/Table datetime math
  18. 2+|<index-{now/M{YYYY.MM}}>
  19. 2+h| Query date/time math
  20. | 1y | INTERVAL 1 YEAR
  21. | 2M | INTERVAL 2 MONTH
  22. | 3w | INTERVAL 21 DAY
  23. | 4d | INTERVAL 4 DAY
  24. | 5h | INTERVAL 5 HOUR
  25. | 6m | INTERVAL 6 MINUTE
  26. | 7s | INTERVAL 7 SECOND
  27. |==========================
  28. `INTERVAL` allows either `YEAR` and `MONTH` to be mixed together _or_ `DAY`, `HOUR`, `MINUTE` and `SECOND`.
  29. TIP: {es-sql} accepts also the plural for each time unit (e.g. both `YEAR` and `YEARS` are valid).
  30. Example of the possible combinations below:
  31. [cols="^,^"]
  32. |===
  33. s|Interval
  34. s|Description
  35. | `INTERVAL '1-2' YEAR TO MONTH` | 1 year and 2 months
  36. | `INTERVAL '3 4' DAYS TO HOURS` | 3 days and 4 hours
  37. | `INTERVAL '5 6:12' DAYS TO MINUTES` | 5 days, 6 hours and 12 minutes
  38. | `INTERVAL '3 4:56:01' DAY TO SECOND` | 3 days, 4 hours, 56 minutes and 1 second
  39. | `INTERVAL '2 3:45:01.23456789' DAY TO SECOND` | 2 days, 3 hours, 45 minutes, 1 second and 234567890 nanoseconds
  40. | `INTERVAL '123:45' HOUR TO MINUTES` | 123 hours and 45 minutes
  41. | `INTERVAL '65:43:21.0123' HOUR TO SECONDS` | 65 hours, 43 minutes, 21 seconds and 12300000 nanoseconds
  42. | `INTERVAL '45:01.23' MINUTES TO SECONDS` | 45 minutes, 1 second and 230000000 nanoseconds
  43. |===
  44. ==== Operators
  45. Basic arithmetic operators (`+`, `-`, etc) support date/time parameters as indicated below:
  46. [source, sql]
  47. --------------------------------------------------
  48. include-tagged::{sql-specs}/docs/docs.csv-spec[dtIntervalPlusInterval]
  49. --------------------------------------------------
  50. [source, sql]
  51. --------------------------------------------------
  52. include-tagged::{sql-specs}/docs/docs.csv-spec[dtDateTimePlusInterval]
  53. --------------------------------------------------
  54. [source, sql]
  55. --------------------------------------------------
  56. include-tagged::{sql-specs}/docs/docs.csv-spec[dtMinusInterval]
  57. --------------------------------------------------
  58. [source, sql]
  59. --------------------------------------------------
  60. include-tagged::{sql-specs}/docs/docs.csv-spec[dtIntervalMinusInterval]
  61. --------------------------------------------------
  62. [source, sql]
  63. --------------------------------------------------
  64. include-tagged::{sql-specs}/docs/docs.csv-spec[dtDateTimeMinusInterval]
  65. --------------------------------------------------
  66. [source, sql]
  67. --------------------------------------------------
  68. include-tagged::{sql-specs}/docs/docs.csv-spec[dtIntervalMul]
  69. --------------------------------------------------
  70. ==== Functions
  71. Functions that target date/time.
  72. [[sql-functions-current-date]]
  73. ==== `CURRENT_DATE/CURDATE`
  74. .Synopsis:
  75. [source, sql]
  76. --------------------------------------------------
  77. CURRENT_DATE
  78. CURRENT_DATE()
  79. CURDATE()
  80. --------------------------------------------------
  81. *Input*: _none_
  82. *Output*: date
  83. .Description:
  84. Returns the date (no time part) when the current query reached the server.
  85. It can be used both as a keyword: `CURRENT_DATE` or as a function with no arguments: `CURRENT_DATE()`.
  86. [NOTE]
  87. Unlike CURRENT_DATE, `CURDATE()` can only be used as a function with no arguments and not as a keyword.
  88. This method always returns the same value for its every occurrence within the same query.
  89. [source, sql]
  90. --------------------------------------------------
  91. include-tagged::{sql-specs}/docs/docs.csv-spec[currentDate]
  92. --------------------------------------------------
  93. [source, sql]
  94. --------------------------------------------------
  95. include-tagged::{sql-specs}/docs/docs.csv-spec[currentDateFunction]
  96. --------------------------------------------------
  97. [source, sql]
  98. --------------------------------------------------
  99. include-tagged::{sql-specs}/docs/docs.csv-spec[curDateFunction]
  100. --------------------------------------------------
  101. Typically, this function (as well as its twin <<sql-functions-today,TODAY())>> function
  102. is used for relative date filtering:
  103. [source, sql]
  104. --------------------------------------------------
  105. include-tagged::{sql-specs}/docs/docs.csv-spec[filterToday]
  106. --------------------------------------------------
  107. [[sql-functions-current-time]]
  108. ==== `CURRENT_TIME/CURTIME`
  109. .Synopsis:
  110. [source, sql]
  111. --------------------------------------------------
  112. CURRENT_TIME
  113. CURRENT_TIME([precision]) <1>
  114. CURTIME
  115. --------------------------------------------------
  116. *Input*:
  117. <1> fractional digits; optional
  118. *Output*: time
  119. .Description:
  120. Returns the time when the current query reached the server.
  121. As a function, `CURRENT_TIME()` accepts _precision_ as an optional
  122. parameter for rounding the second fractional digits (nanoseconds). The default _precision_ is 3,
  123. meaning a milliseconds precision current time will be returned.
  124. This method always returns the same value for its every occurrence within the same query.
  125. [source, sql]
  126. --------------------------------------------------
  127. include-tagged::{sql-specs}/docs/docs.csv-spec[currentTime]
  128. --------------------------------------------------
  129. [source, sql]
  130. --------------------------------------------------
  131. include-tagged::{sql-specs}/docs/docs.csv-spec[currentTimeFunction]
  132. --------------------------------------------------
  133. [source, sql]
  134. --------------------------------------------------
  135. include-tagged::{sql-specs}/docs/docs.csv-spec[curTimeFunction]
  136. --------------------------------------------------
  137. [source, sql]
  138. --------------------------------------------------
  139. include-tagged::{sql-specs}/docs/docs.csv-spec[currentTimeFunctionPrecision]
  140. --------------------------------------------------
  141. Typically, this function is used for relative date/time filtering:
  142. [source, sql]
  143. --------------------------------------------------
  144. include-tagged::{sql-specs}/docs/docs.csv-spec[filterCurrentTime]
  145. --------------------------------------------------
  146. [IMPORTANT]
  147. Currently, using a _precision_ greater than 3 doesn't make any difference to the output of the
  148. function as the maximum number of second fractional digits returned is 3 (milliseconds).
  149. [[sql-functions-current-timestamp]]
  150. ==== `CURRENT_TIMESTAMP`
  151. .Synopsis:
  152. [source, sql]
  153. --------------------------------------------------
  154. CURRENT_TIMESTAMP
  155. CURRENT_TIMESTAMP([precision]) <1>
  156. --------------------------------------------------
  157. *Input*:
  158. <1> fractional digits; optional
  159. *Output*: date/time
  160. .Description:
  161. Returns the date/time when the current query reached the server.
  162. As a function, `CURRENT_TIMESTAMP()` accepts _precision_ as an optional
  163. parameter for rounding the second fractional digits (nanoseconds). The default _precision_ is 3,
  164. meaning a milliseconds precision current date/time will be returned.
  165. This method always returns the same value for its every occurrence within the same query.
  166. [source, sql]
  167. --------------------------------------------------
  168. include-tagged::{sql-specs}/docs/docs.csv-spec[curTs]
  169. --------------------------------------------------
  170. [source, sql]
  171. --------------------------------------------------
  172. include-tagged::{sql-specs}/docs/docs.csv-spec[curTsFunction]
  173. --------------------------------------------------
  174. [source, sql]
  175. --------------------------------------------------
  176. include-tagged::{sql-specs}/docs/docs.csv-spec[curTsFunctionPrecision]
  177. --------------------------------------------------
  178. Typically, this function (as well as its twin <<sql-functions-now,NOW())>> function is used for
  179. relative date/time filtering:
  180. [source, sql]
  181. --------------------------------------------------
  182. include-tagged::{sql-specs}/docs/docs.csv-spec[filterNow]
  183. --------------------------------------------------
  184. [IMPORTANT]
  185. Currently, using a _precision_ greater than 3 doesn't make any difference to the output of the
  186. function as the maximum number of second fractional digits returned is 3 (milliseconds).
  187. [[sql-functions-datetime-add]]
  188. ==== `DATE_ADD/DATEADD/TIMESTAMPADD/TIMESTAMP_ADD`
  189. .Synopsis:
  190. [source, sql]
  191. --------------------------------------------------
  192. DATE_ADD(
  193. string_exp, <1>
  194. integer_exp, <2>
  195. datetime_exp) <3>
  196. --------------------------------------------------
  197. *Input*:
  198. <1> string expression denoting the date/time unit to add to the date/datetime
  199. <2> integer expression denoting how many times the above unit should be added to/from the date/datetime,
  200. if a negative value is used it results to a subtraction from the date/datetime
  201. <3> date/datetime expression
  202. *Output*: datetime
  203. .Description:
  204. Add the given number of date/time units to a date/datetime. If the number of units is negative then it's subtracted from
  205. the date/datetime. If any of the three arguments is `null` a `null` is returned.
  206. [cols="^,^"]
  207. |===
  208. 2+h|Datetime units to add/subtract
  209. s|unit
  210. s|abbreviations
  211. | year | years, yy, yyyy
  212. | quarter | quarters, qq, q
  213. | month | months, mm, m
  214. | dayofyear | dy, y
  215. | day | days, dd, d
  216. | week | weeks, wk, ww
  217. | weekday | weekdays, dw
  218. | hour | hours, hh
  219. | minute | minutes, mi, n
  220. | second | seconds, ss, s
  221. | millisecond | milliseconds, ms
  222. | microsecond | microseconds, mcs
  223. | nanosecond | nanoseconds, ns
  224. |===
  225. [source, sql]
  226. --------------------------------------------------
  227. include-tagged::{sql-specs}/docs/docs.csv-spec[dateAddDateTimeYears]
  228. --------------------------------------------------
  229. [source, sql]
  230. --------------------------------------------------
  231. include-tagged::{sql-specs}/docs/docs.csv-spec[dateAddDateTimeWeeks]
  232. --------------------------------------------------
  233. [source, sql]
  234. --------------------------------------------------
  235. include-tagged::{sql-specs}/docs/docs.csv-spec[dateAddDateTimeSeconds]
  236. --------------------------------------------------
  237. [source, sql]
  238. --------------------------------------------------
  239. include-tagged::{sql-specs}/docs/docs.csv-spec[dateAddDateQuarters]
  240. --------------------------------------------------
  241. [source, sql]
  242. --------------------------------------------------
  243. include-tagged::{sql-specs}/docs/docs.csv-spec[dateAddDateMinutes]
  244. --------------------------------------------------
  245. [[sql-functions-datetime-part]]
  246. ==== `DATE_PART/DATEPART`
  247. .Synopsis:
  248. [source, sql]
  249. --------------------------------------------------
  250. DATE_PART(
  251. string_exp, <1>
  252. datetime_exp) <2>
  253. --------------------------------------------------
  254. *Input*:
  255. <1> string expression denoting the unit to extract from the date/datetime
  256. <2> date/datetime expression
  257. *Output*: integer
  258. .Description:
  259. Extract the specified unit from a date/datetime. If any of the two arguments is `null` a `null` is returned.
  260. It's similar to <<sql-functions-datetime-extract>> but with different names and aliases for the units and
  261. provides more options (e.g.: `TZOFFSET`).
  262. [cols="^,^"]
  263. |===
  264. 2+h|Datetime units to extract
  265. s|unit
  266. s|abbreviations
  267. | year | years, yy, yyyy
  268. | quarter | quarters, qq, q
  269. | month | months, mm, m
  270. | dayofyear | dy, y
  271. | day | days, dd, d
  272. | week | weeks, wk, ww
  273. | weekday | weekdays, dw
  274. | hour | hours, hh
  275. | minute | minutes, mi, n
  276. | second | seconds, ss, s
  277. | millisecond | milliseconds, ms
  278. | microsecond | microseconds, mcs
  279. | nanosecond | nanoseconds, ns
  280. | tzoffset | tz
  281. |===
  282. [source, sql]
  283. --------------------------------------------------
  284. include-tagged::{sql-specs}/docs/docs.csv-spec[datePartDateTimeYears]
  285. --------------------------------------------------
  286. [source, sql]
  287. --------------------------------------------------
  288. include-tagged::{sql-specs}/docs/docs.csv-spec[datePartDateTimeMinutes]
  289. --------------------------------------------------
  290. [source, sql]
  291. --------------------------------------------------
  292. include-tagged::{sql-specs}/docs/docs.csv-spec[datePartDateQuarter]
  293. --------------------------------------------------
  294. [source, sql]
  295. --------------------------------------------------
  296. include-tagged::{sql-specs}/docs/docs.csv-spec[datePartDateMonth]
  297. --------------------------------------------------
  298. [NOTE]
  299. For `week` and `weekday` the unit is extracted using the non-ISO calculation, which means
  300. that a given week is considered to start from Sunday, not Monday.
  301. [source, sql]
  302. --------------------------------------------------
  303. include-tagged::{sql-specs}/docs/docs.csv-spec[datePartDateTimeWeek]
  304. --------------------------------------------------
  305. [NOTE]
  306. The `tzoffset` returns the total number of minutes (signed) that represent the time zone's offset.
  307. [source, sql]
  308. --------------------------------------------------
  309. include-tagged::{sql-specs}/docs/docs.csv-spec[datePartDateTimeTzOffsetPlus]
  310. --------------------------------------------------
  311. [source, sql]
  312. --------------------------------------------------
  313. include-tagged::{sql-specs}/docs/docs.csv-spec[datePartDateTimeTzOffsetMinus]
  314. --------------------------------------------------
  315. [[sql-functions-datetime-trunc]]
  316. ==== `DATE_TRUNC/DATETRUNC`
  317. .Synopsis:
  318. [source, sql]
  319. --------------------------------------------------
  320. DATE_TRUNC(
  321. string_exp, <1>
  322. datetime_exp) <2>
  323. --------------------------------------------------
  324. *Input*:
  325. <1> string expression denoting the unit to which the date/datetime should be truncated to
  326. <2> date/datetime expression
  327. *Output*: datetime
  328. .Description:
  329. Truncate the date/datetime to the specified unit by setting all fields that are less significant than the specified
  330. one to zero (or one, for day, day of week and month). If any of the two arguments is `null` a `null` is returned.
  331. [cols="^,^"]
  332. |===
  333. 2+h|Datetime truncation units
  334. s|unit
  335. s|abbreviations
  336. | millennium | millennia
  337. | century | centuries
  338. | decade | decades
  339. | year | years, yy, yyyy
  340. | quarter | quarters, qq, q
  341. | month | months, mm, m
  342. | week | weeks, wk, ww
  343. | day | days, dd, d
  344. | hour | hours, hh
  345. | minute | minutes, mi, n
  346. | second | seconds, ss, s
  347. | millisecond | milliseconds, ms
  348. | microsecond | microseconds, mcs
  349. | nanosecond | nanoseconds, ns
  350. |===
  351. [source, sql]
  352. --------------------------------------------------
  353. include-tagged::{sql-specs}/docs/docs.csv-spec[truncateDateTimeMillennium]
  354. --------------------------------------------------
  355. [source, sql]
  356. --------------------------------------------------
  357. include-tagged::{sql-specs}/docs/docs.csv-spec[truncateDateTimeWeek]
  358. --------------------------------------------------
  359. [source, sql]
  360. --------------------------------------------------
  361. include-tagged::{sql-specs}/docs/docs.csv-spec[truncateDateTimeMinutes]
  362. --------------------------------------------------
  363. [source, sql]
  364. --------------------------------------------------
  365. include-tagged::{sql-specs}/docs/docs.csv-spec[truncateDateDecades]
  366. --------------------------------------------------
  367. [source, sql]
  368. --------------------------------------------------
  369. include-tagged::{sql-specs}/docs/docs.csv-spec[truncateDateQuarter]
  370. --------------------------------------------------
  371. [[sql-functions-datetime-day]]
  372. ==== `DAY_OF_MONTH/DOM/DAY`
  373. .Synopsis:
  374. [source, sql]
  375. --------------------------------------------------
  376. DAY_OF_MONTH(datetime_exp) <1>
  377. --------------------------------------------------
  378. *Input*:
  379. <1> date/datetime expression
  380. *Output*: integer
  381. .Description:
  382. Extract the day of the month from a date/datetime.
  383. [source, sql]
  384. --------------------------------------------------
  385. include-tagged::{sql-specs}/docs/docs.csv-spec[dayOfMonth]
  386. --------------------------------------------------
  387. [[sql-functions-datetime-dow]]
  388. ==== `DAY_OF_WEEK/DAYOFWEEK/DOW`
  389. .Synopsis:
  390. [source, sql]
  391. --------------------------------------------------
  392. DAY_OF_WEEK(datetime_exp) <1>
  393. --------------------------------------------------
  394. *Input*:
  395. <1> date/datetime expression
  396. *Output*: integer
  397. .Description:
  398. Extract the day of the week from a date/datetime. Sunday is `1`, Monday is `2`, etc.
  399. [source, sql]
  400. --------------------------------------------------
  401. include-tagged::{sql-specs}/docs/docs.csv-spec[dayOfWeek]
  402. --------------------------------------------------
  403. [[sql-functions-datetime-doy]]
  404. ==== `DAY_OF_YEAR/DOY`
  405. .Synopsis:
  406. [source, sql]
  407. --------------------------------------------------
  408. DAY_OF_YEAR(datetime_exp) <1>
  409. --------------------------------------------------
  410. *Input*:
  411. <1> date/datetime expression
  412. *Output*: integer
  413. .Description:
  414. Extract the day of the year from a date/datetime.
  415. [source, sql]
  416. --------------------------------------------------
  417. include-tagged::{sql-specs}/docs/docs.csv-spec[dayOfYear]
  418. --------------------------------------------------
  419. [[sql-functions-datetime-dayname]]
  420. ==== `DAY_NAME/DAYNAME`
  421. .Synopsis:
  422. [source, sql]
  423. --------------------------------------------------
  424. DAY_NAME(datetime_exp) <1>
  425. --------------------------------------------------
  426. *Input*:
  427. <1> date/datetime expression
  428. *Output*: string
  429. .Description:
  430. Extract the day of the week from a date/datetime in text format (`Monday`, `Tuesday`...).
  431. [source, sql]
  432. --------------------------------------------------
  433. include-tagged::{sql-specs}/docs/docs.csv-spec[dayName]
  434. --------------------------------------------------
  435. [[sql-functions-datetime-hour]]
  436. ==== `HOUR_OF_DAY/HOUR`
  437. .Synopsis:
  438. [source, sql]
  439. --------------------------------------------------
  440. HOUR_OF_DAY(datetime_exp) <1>
  441. --------------------------------------------------
  442. *Input*:
  443. <1> date/datetime expression
  444. *Output*: integer
  445. .Description:
  446. Extract the hour of the day from a date/datetime.
  447. [source, sql]
  448. --------------------------------------------------
  449. include-tagged::{sql-specs}/docs/docs.csv-spec[hourOfDay]
  450. --------------------------------------------------
  451. [[sql-functions-datetime-isodow]]
  452. ==== `ISO_DAY_OF_WEEK/ISODAYOFWEEK/ISODOW/IDOW`
  453. .Synopsis:
  454. [source, sql]
  455. --------------------------------------------------
  456. ISO_DAY_OF_WEEK(datetime_exp) <1>
  457. --------------------------------------------------
  458. *Input*:
  459. <1> date/datetime expression
  460. *Output*: integer
  461. .Description:
  462. Extract the day of the week from a date/datetime, following the https://en.wikipedia.org/wiki/ISO_week_date[ISO 8601 standard].
  463. Monday is `1`, Tuesday is `2`, etc.
  464. [source, sql]
  465. --------------------------------------------------
  466. include-tagged::{sql-specs}/docs/docs.csv-spec[isoDayOfWeek]
  467. --------------------------------------------------
  468. [[sql-functions-datetime-isoweek]]
  469. ==== `ISO_WEEK_OF_YEAR/ISOWEEKOFYEAR/ISOWEEK/IWOY/IW`
  470. .Synopsis:
  471. [source, sql]
  472. --------------------------------------------------
  473. ISO_WEEK_OF_YEAR(datetime_exp) <1>
  474. --------------------------------------------------
  475. *Input*:
  476. <1> date/datetime expression
  477. *Output*: integer
  478. .Description:
  479. Extract the week of the year from a date/datetime, following https://en.wikipedia.org/wiki/ISO_week_date[ISO 8601 standard]. The first week
  480. of a year is the first week with a majority (4 or more) of its days in January.
  481. [source, sql]
  482. --------------------------------------------------
  483. include-tagged::{sql-specs}/docs/docs.csv-spec[isoWeekOfYear]
  484. --------------------------------------------------
  485. [[sql-functions-datetime-minuteofday]]
  486. ==== `MINUTE_OF_DAY`
  487. .Synopsis:
  488. [source, sql]
  489. --------------------------------------------------
  490. MINUTE_OF_DAY(datetime_exp) <1>
  491. --------------------------------------------------
  492. *Input*:
  493. <1> date/datetime expression
  494. *Output*: integer
  495. .Description:
  496. Extract the minute of the day from a date/datetime.
  497. [source, sql]
  498. --------------------------------------------------
  499. include-tagged::{sql-specs}/docs/docs.csv-spec[minuteOfDay]
  500. --------------------------------------------------
  501. [[sql-functions-datetime-minute]]
  502. ==== `MINUTE_OF_HOUR/MINUTE`
  503. .Synopsis:
  504. [source, sql]
  505. --------------------------------------------------
  506. MINUTE_OF_HOUR(datetime_exp) <1>
  507. --------------------------------------------------
  508. *Input*:
  509. <1> date/datetime expression
  510. *Output*: integer
  511. .Description:
  512. Extract the minute of the hour from a date/datetime.
  513. [source, sql]
  514. --------------------------------------------------
  515. include-tagged::{sql-specs}/docs/docs.csv-spec[minuteOfHour]
  516. --------------------------------------------------
  517. [[sql-functions-datetime-month]]
  518. ==== `MONTH_OF_YEAR/MONTH`
  519. .Synopsis:
  520. [source, sql]
  521. --------------------------------------------------
  522. MONTH(datetime_exp) <1>
  523. --------------------------------------------------
  524. *Input*:
  525. <1> date/datetime expression
  526. *Output*: integer
  527. .Description:
  528. Extract the month of the year from a date/datetime.
  529. [source, sql]
  530. --------------------------------------------------
  531. include-tagged::{sql-specs}/docs/docs.csv-spec[monthOfYear]
  532. --------------------------------------------------
  533. [[sql-functions-datetime-monthname]]
  534. ==== `MONTH_NAME/MONTHNAME`
  535. .Synopsis:
  536. [source, sql]
  537. --------------------------------------------------
  538. MONTH_NAME(datetime_exp) <1>
  539. --------------------------------------------------
  540. *Input*:
  541. <1> date/datetime expression
  542. *Output*: string
  543. .Description:
  544. Extract the month from a date/datetime in text format (`January`, `February`...).
  545. [source, sql]
  546. --------------------------------------------------
  547. include-tagged::{sql-specs}/docs/docs.csv-spec[monthName]
  548. --------------------------------------------------
  549. [[sql-functions-now]]
  550. ==== `NOW`
  551. .Synopsis:
  552. [source, sql]
  553. --------------------------------------------------
  554. NOW()
  555. --------------------------------------------------
  556. *Input*: _none_
  557. *Output*: datetime
  558. .Description:
  559. This function offers the same functionality as <<sql-functions-current-timestamp,CURRENT_TIMESTAMP()>> function: returns
  560. the datetime when the current query reached the server. This method always returns the same value for its every
  561. occurrence within the same query.
  562. [source, sql]
  563. --------------------------------------------------
  564. include-tagged::{sql-specs}/docs/docs.csv-spec[nowFunction]
  565. --------------------------------------------------
  566. Typically, this function (as well as its twin <<sql-functions-current-timestamp,CURRENT_TIMESTAMP())>> function is used
  567. for relative date/time filtering:
  568. [source, sql]
  569. --------------------------------------------------
  570. include-tagged::{sql-specs}/docs/docs.csv-spec[filterNow]
  571. --------------------------------------------------
  572. [[sql-functions-datetime-second]]
  573. ==== `SECOND_OF_MINUTE/SECOND`
  574. .Synopsis:
  575. [source, sql]
  576. --------------------------------------------------
  577. SECOND_OF_MINUTE(datetime_exp) <1>
  578. --------------------------------------------------
  579. *Input*:
  580. <1> date/datetime expression
  581. *Output*: integer
  582. .Description:
  583. Extract the second of the minute from a date/datetime.
  584. [source, sql]
  585. --------------------------------------------------
  586. include-tagged::{sql-specs}/docs/docs.csv-spec[secondOfMinute]
  587. --------------------------------------------------
  588. [[sql-functions-datetime-quarter]]
  589. ==== `QUARTER`
  590. .Synopsis:
  591. [source, sql]
  592. --------------------------------------------------
  593. QUARTER(datetime_exp) <1>
  594. --------------------------------------------------
  595. *Input*:
  596. <1> date/datetime expression
  597. *Output*: integer
  598. .Description:
  599. Extract the year quarter the date/datetime falls in.
  600. [source, sql]
  601. --------------------------------------------------
  602. include-tagged::{sql-specs}/docs/docs.csv-spec[quarter]
  603. --------------------------------------------------
  604. [[sql-functions-today]]
  605. ==== `TODAY`
  606. .Synopsis:
  607. [source, sql]
  608. --------------------------------------------------
  609. TODAY()
  610. --------------------------------------------------
  611. *Input*: _none_
  612. *Output*: date
  613. .Description:
  614. This function offers the same functionality as <<sql-functions-current-date,CURRENT_DATE()>> function: returns
  615. the date when the current query reached the server. This method always returns the same value for its every occurrence
  616. within the same query.
  617. [source, sql]
  618. --------------------------------------------------
  619. include-tagged::{sql-specs}/docs/docs.csv-spec[todayFunction]
  620. --------------------------------------------------
  621. Typically, this function (as well as its twin <<sql-functions-current-timestamp,CURRENT_TIMESTAMP())>> function is used
  622. for relative date filtering:
  623. [source, sql]
  624. --------------------------------------------------
  625. include-tagged::{sql-specs}/docs/docs.csv-spec[filterToday]
  626. --------------------------------------------------
  627. [[sql-functions-datetime-week]]
  628. ==== `WEEK_OF_YEAR/WEEK`
  629. .Synopsis:
  630. [source, sql]
  631. --------------------------------------------------
  632. WEEK_OF_YEAR(datetime_exp) <1>
  633. --------------------------------------------------
  634. *Input*:
  635. <1> date/datetime expression
  636. *Output*: integer
  637. .Description:
  638. Extract the week of the year from a date/datetime.
  639. [source, sql]
  640. --------------------------------------------------
  641. include-tagged::{sql-specs}/docs/docs.csv-spec[weekOfYear]
  642. --------------------------------------------------
  643. [[sql-functions-datetime-year]]
  644. ==== `YEAR`
  645. .Synopsis:
  646. [source, sql]
  647. --------------------------------------------------
  648. YEAR(datetime_exp) <1>
  649. --------------------------------------------------
  650. *Input*:
  651. <1> date/datetime expression
  652. *Output*: integer
  653. .Description:
  654. Extract the year from a date/datetime.
  655. [source, sql]
  656. --------------------------------------------------
  657. include-tagged::{sql-specs}/docs/docs.csv-spec[year]
  658. --------------------------------------------------
  659. [[sql-functions-datetime-extract]]
  660. ==== `EXTRACT`
  661. .Synopsis:
  662. [source, sql]
  663. --------------------------------------------------
  664. EXTRACT(
  665. datetime_function <1>
  666. FROM datetime_exp) <2>
  667. --------------------------------------------------
  668. *Input*:
  669. <1> date/time function name
  670. <2> date/datetime expression
  671. *Output*: integer
  672. .Description:
  673. Extract fields from a date/datetime by specifying the name of a <<sql-functions-datetime,datetime function>>.
  674. The following
  675. [source, sql]
  676. --------------------------------------------------
  677. include-tagged::{sql-specs}/docs/docs.csv-spec[extractDayOfYear]
  678. --------------------------------------------------
  679. is the equivalent to
  680. [source, sql]
  681. --------------------------------------------------
  682. include-tagged::{sql-specs}/docs/docs.csv-spec[dayOfYear]
  683. --------------------------------------------------