Class IOracleTimestamp

JavaScript API for Oracle type TIMESTAMP.

Index

Constructors

Methods

addInterval atSessionTimeZone atTimeZone getDay getHour getMinute getMonth getSecond getYear subtractInterval subtractIntoDayToSecond subtractIntoYearToMonth toString compare fromString

Constructors

constructor

new IOracleTimestamp(): IOracleTimestamp
Returns IOracleTimestamp

Methods

addInterval

addInterval(
interval: IOracleIntervalDayToSecond | IOracleIntervalYearToMonth,
): IOracleTimestamp
Adds an interval to the timestamp to obtain a new timestamp
Parameters
- interval: IOracleIntervalDayToSecond | IOracleIntervalYearToMonth
  the interval used to obtain the new timestamp
Returns IOracleTimestamp
resulting timestamp

atSessionTimeZone

atSessionTimeZone(): IOracleTimestampTZ
Converts to an IOracleTimestampTZ using the session time zone.

Returns IOracleTimestampTZ

atTimeZone

atTimeZone(timezone: string): IOracleTimestampTZ
Converts to an IOracleTimestampTZ in the specified time zone. The time zone string has to contain either a time zone offset of the form '(+|-)HH:MM' or a time zone region name.
Parameters
- timezone: string
  The time zone string.
Returns IOracleTimestampTZ

getDay

getDay(): number
Gets the day component in the Gregorian calendar.

Returns number
day component as number

getHour

getHour(): number
Gets the hour component.

Returns number
hour component as number

getMinute

getMinute(): number
Gets the minute component.

Returns number
minute component as number

getMonth

getMonth(): number
Gets the month component in the Gregorian calendar.

Returns number
month component as number

getSecond

getSecond(): number
Gets the second component, including the fractional part.

Returns number
second component as number

getYear

getYear(): number
Gets the year component in the Gregorian calendar.

Returns number
year component as number

subtractInterval

subtractInterval(
interval: IOracleIntervalDayToSecond | IOracleIntervalYearToMonth,
): IOracleTimestamp
Subtracts an interval from the timestamp to obtain a new timestamp
Parameters
- interval: IOracleIntervalDayToSecond | IOracleIntervalYearToMonth
  the interval used to obtain the new timestamp
Returns IOracleTimestamp
resulting timestamp

subtractIntoDayToSecond

subtractIntoDayToSecond(other: IOracleTimestamp): IOracleIntervalDayToSecond
Subtracts another timestamp from the timestamp to obtain a day-to-second interval.
Parameters
- other: IOracleTimestamp
  the other timestamp used as subtrahend
Returns IOracleIntervalDayToSecond
year-to-month interval defined by the two timestamps

subtractIntoYearToMonth

subtractIntoYearToMonth(other: IOracleTimestamp): IOracleIntervalYearToMonth
Subtracts another timestamp from the timestamp to obtain a year-to-month interval
Parameters
- other: IOracleTimestamp
  the other timestamp used as subtrahend
Returns IOracleIntervalYearToMonth
year-to-month interval defined by the two timestamps

toString

toString(format?: string, nlsParam?: string): string
Converts the given datetime to a string in a certain format. An optional datetime format model and an optional NLS parameter string can be provided. If no format model and/or no NLS parameter string is provided, the respective default values for the session are used.

If an NLS parameter string is specified, it has the effect of temporarily altering the session's NLS settings for the duration of the call to this method. The NLS parameter string may set the NLS_DATE_LANGUAGE parameter.

If a datetime format model is specified, it overrides the datetime format determined by NLS settings.
Parameters
- Optionalformat: string
  datetime format model
- OptionalnlsParam: string
  optional NLS parameter string
Returns string
a string of the timestamp

`Static`compare

compare(date1: IOracleTimestamp, date2: IOracleTimestamp): number
Compares two IOracleTimestamp values. Returns -1 if date1 < date2, 0 if they are equal, and 1 if date1 > date2.
Parameters
- date1: IOracleTimestamp
- date2: IOracleTimestamp
Returns number
the result of the comparison as a number between -1 and +1.

`Static`fromString

fromString(date: string, format?: string, nlsParam?: string): any
Parse a string into an IOracleTimestamp. An optional datetime format model and an optional NLS parameter string can be provided. If no format model is specified, the string must be in the default format for the Oracle TIMESTAMP data type, which is determined by the NLS_TIMESTAMP_FORMAT parameter.

If an NLS parameter string is specified, it has the effect of temporarily altering the session's NLS settings for the duration of the call to this method. The NLS parameter string may set the NLS_DATE_LANGUAGE parameter.

If a datetime format model is specified, it overrides the datetime format determined by NLS settings (i.e. the setting of the NLS_TIMESTAMP FORMAT parameter).
Parameters
- date: string
  date represented as a string
- Optionalformat: string
  optional datetime format model
- OptionalnlsParam: string
  optional NLS parameter string. Must have the same format as the NLS argument to the TO_TIMESTAMP SQL function.
Returns any
an IOracleTimestamp object

Class IOracleTimestamp

Index

Constructors

Methods

Constructors

constructor

Returns IOracleTimestamp

Methods

addInterval

Parameters

Returns IOracleTimestamp

atSessionTimeZone

Returns IOracleTimestampTZ

atTimeZone

Parameters

Returns IOracleTimestampTZ

getDay

Returns number

getHour

Returns number

getMinute

Returns number

getMonth

Returns number

getSecond

Returns number

getYear

Returns number

subtractInterval

Parameters

Returns IOracleTimestamp

subtractIntoDayToSecond

Parameters

Returns IOracleIntervalDayToSecond

subtractIntoYearToMonth

Parameters

Returns IOracleIntervalYearToMonth

toString

Parameters

Returns string

Staticcompare

Parameters

Returns number

StaticfromString

Parameters

Returns any

Settings

On This Page

`Static`compare

`Static`fromString