datetime_object | Tarantool
Документация на русском языке
поддерживается сообществом

datetime_object

object datetime_object

Since 2.10.0.

datetime_object:totable()

Convert the information from a datetime object into the table format. Resulting table has the following fields:

Field name Description
nsec Nanosecods
sec Seconds
min Minutes
hour Hours
day Day number
month Month number
year Year
wday Days since the beginning of the week
yday Days since the beginning of the year
isdst Is the DST (Daylight saving time) applicable for the date. Boolean.
tzoffset Time zone offset from UTC
Return:table with the date and time parameters
Rtype:table

Example:

tarantool> dt = datetime.new {
            sec = 20,
            min = 25,
            hour = 18,

            day = 20,
            month = 8,
            year = 2021,
            }
---
...

tarantool> dt:totable()
---
- sec: 20
  min: 25
  yday: 232
  day: 20
  nsec: 0
  isdst: false
  wday: 6
  tzoffset: 0
  month: 8
  year: 2021
  hour: 18
...
datetime_object:format(['input_string'])

Convert the standard datetime object presentation into a formatted string. The conversion specifications are the same as in the strftime library. Additional specification for nanoseconds is %f which also allows a modifier to control the output precision of fractional part: %5f (see the example below). If no arguments are set for the method, the default conversions are used: '%FT%T.%f%z' (see the example below).

Параметры:
  • input_string (string) – string consisting of zero or more conversion specifications and ordinary characters
Return:

string with the formatted date and time information

Rtype:

string

Example:

tarantool> dt = datetime.new {
            nsec = 123456789,

            sec = 20,
            min = 25,
            hour = 18,

            day = 20,
            month = 8,
            year = 2021,

            tzoffset  = 180
            }
---
...

tarantool> dt:format('%d.%m.%y %H:%M:%S.%5f')
---
- 20.08.21 18:25:20.12345
...

tarantool> dt:format()
---
- 2021-08-20T18:25:20.123456789+0300
...

tarantool> dt:format('%FT%T.%f%z')
---
- 2021-08-20T18:25:20.123456789+0300
...
datetime_object:set([{ units }])

Update the field values in the existing datetime object.

Параметры:
  • units (table) – Table of time units. The time units are the same as for the datetime.new() function.
Return:

updated datetime_object

Rtype:

cdata

Example:

tarantool> dt = datetime.new {
            nsec = 123456789,

            sec = 20,
            min = 25,
            hour = 18,

            day = 20,
            month = 8,
            year = 2021,

            tzoffset  = 180
            }

tarantool> dt:set {msec = 567}
---
- 2021-08-20T18:25:20.567+0300
...

tarantool> dt:set {tzoffset = 60}
---
- 2021-08-20T18:25:20.567+0100
...
datetime_object:parse('input_string'[, {format, tzoffset}])

Convert an input string with the date and time information into a datetime object. The input string should be formatted according to one of the following standards:

  • ISO 8601
  • RFC 3339
  • extended strftime – see description of the format() for details.
Параметры:
  • input_string (string) – string with the date and time information.
  • format (string) – indicator of the input_sting format. Possible values: „iso8601“, „rfc3339“, or strptime-like format string. If no value is set, the default formatting is used.
  • tzoffset (number) – time zone offset from UTC, in minutes.
Return:

a datetime_object

Rtype:

cdata

Example:

tarantool> t = datetime.parse('1970-01-01T00:00:00Z')

tarantool> t
---
- 1970-01-01T00:00:00Z
...

tarantool> t = datetime.parse('1970-01-01T00:00:00', {format = 'iso8601', tzoffset = 180})

tarantool> t
---
- 1970-01-01T00:00:00+0300
...

tarantool> t = datetime.parse('2017-12-27T18:45:32.999999-05:00', {format = 'rfc3339'})

tarantool> t
---
- 2017-12-27T18:45:32.999999-0500
...

tarantool> T = datetime.parse('Thu Jan  1 03:00:00 1970', {format = '%c'})

tarantool> T
---
- 1970-01-01T03:00:00Z
...

tarantool> T = datetime.parse('12/31/2020', {format = '%m/%d/%y'})

tarantool> T
---
- 2020-12-31T00:00:00Z
...

tarantool> T = datetime.parse('1970-01-01T03:00:00.125000000+0300', {format = '%FT%T.%f%z'})

tarantool> T
---
- 1970-01-01T03:00:00.125+0300
...
datetime_object:add(input[, { adjust }])

Modify an existing datetime object by adding values of the input argument.

Параметры:
  • input (table) – an interval object or an equivalent table (see Example #1)
  • adjust (string) – defines how to round days in a month after an arithmetic operation. Possible values: none, last, excess (see Example #2). Defaults to none.
Return:

datetime_object

Rtype:

cdata

Example #1:

tarantool> dt = datetime.new {
            day = 26,
            month = 8,
            year = 2021,
            tzoffset  = 180
            }
---
...

tarantool> iv = datetime.interval.new {day = 7}
---
...

tarantool> dt, iv
---
- 2021-08-26T00:00:00+0300
- +7 days
...

tarantool> dt:add(iv)
---
- 2021-09-02T00:00:00+0300
...

tarantool> dt:add{ day = 7 }
---
- 2021-09-09T00:00:00+0300
...

Example #2:

tarantool> dt = datetime.new {
            day = 29,
            month = 2,
            year = 2020
            }
---
...

tarantool> dt:add{month = 1, adjust = 'none'}
---
- 2020-03-29T00:00:00Z
...

tarantool> dt = datetime.new {
            day = 29,
            month = 2,
            year = 2020
            }
---
...

tarantool> dt:add{month = 1, adjust = 'last'}
---
- 2020-03-31T00:00:00Z
...

tarantool> dt = datetime.new {
            day = 31,
            month = 1,
            year = 2020
            }
---
...

tarantool> dt:add{month = 1, adjust = 'excess'}
---
- 2020-03-02T00:00:00Z
...
datetime_object:sub({ input[, adjust ] }])

Modify an existing datetime object by subtracting values of the input argument.

Параметры:
  • input (table) – an interval object or an equivalent table (see Example)
  • adjust (string) – defines how to round days in a month after an arithmetic operation. Possible values: none, last, excess. Defaults to none. The logic is similar to the one of the :add() method – see Example #2.
Return:

datetime_object

Rtype:

cdata

Example:

tarantool> dt = datetime.new {
            day = 26,
            month = 8,
            year = 2021,
            tzoffset  = 180
            }
---
...

tarantool> iv = datetime.interval.new {day = 5}
---
...

tarantool> dt, iv
---
- 2021-08-26T00:00:00+0300
- +5 days
...

tarantool> dt:sub(iv)
---
- 2021-08-21T00:00:00+0300
...

tarantool> dt:sub{ day = 1 }
---
- 2021-08-20T00:00:00+0300
...
Нашли ответ на свой вопрос?
Обратная связь