Class IOracleTimestamp

JavaScript API for Oracle type TIMESTAMP.

Hierarchy

IOracleTimestamp

Index

Constructors

Methods

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

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

Returns
resulting timestamp
Parameters
- interval: IOracleIntervalDayToSecond | IOracleIntervalYearToMonth
  
  the interval used to obtain the new timestamp
Returns IOracleTimestamp

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

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.

Returns
the result of the comparison as a number between -1 and +1.
Parameters
- date1: IOracleTimestamp
- date2: IOracleTimestamp
Returns number

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).

Returns
an IOracleTimestamp object
Parameters
- date: string
  
  date represented as a string
- Optional format: string
  
  optional datetime format model
- Optional nlsParam: string
  
  optional NLS parameter string. Must have the same format as the NLS argument to the TO_TIMESTAMP SQL function.
Returns any

getDay

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

Returns
day component as number

Returns number

getHour

getHour(): number
Gets the hour component.

Returns
hour component as number

Returns number

getMinute

getMinute(): number
Gets the minute component.

Returns
minute component as number

Returns number

getMonth

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

Returns
month component as number

Returns number

getSecond

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

Returns
second component as number

Returns number

getYear

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

Returns
year component as number

Returns number

subtractInterval

subtractInterval(interval: IOracleIntervalDayToSecond | IOracleIntervalYearToMonth): IOracleTimestamp
Subtracts an interval from the timestamp to obtain a new timestamp

Returns
resulting timestamp
Parameters
- interval: IOracleIntervalDayToSecond | IOracleIntervalYearToMonth
  
  the interval used to obtain the new timestamp
Returns IOracleTimestamp

subtractIntoDayToSecond

subtractIntoDayToSecond(other: IOracleTimestamp): IOracleIntervalDayToSecond
Subtracts another timestamp from the timestamp to obtain a day-to-second interval.

Returns
year-to-month interval defined by the two timestamps
Parameters
- other: IOracleTimestamp
  
  the other timestamp used as subtrahend
Returns IOracleIntervalDayToSecond

subtractIntoYearToMonth

subtractIntoYearToMonth(other: IOracleTimestamp): IOracleIntervalYearToMonth
Subtracts another timestamp from the timestamp to obtain a year-to-month interval

Returns
year-to-month interval defined by the two timestamps
Parameters
- other: IOracleTimestamp
  
  the other timestamp used as subtrahend
Returns IOracleIntervalYearToMonth

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.

Returns
a string of the timestamp
Parameters
- Optional format: string
  
  datetime format model
- Optional nlsParam: string
  
  optional NLS parameter string
Returns string

Class IOracleTimestamp

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns IOracleTimestamp

Methods

addInterval

Returns

Parameters

interval: IOracleIntervalDayToSecond | IOracleIntervalYearToMonth

Returns IOracleTimestamp

atSessionTimeZone

Returns IOracleTimestampTZ

atTimeZone

Parameters

timezone: string

Returns IOracleTimestampTZ

compare

Returns

Parameters

date1: IOracleTimestamp

date2: IOracleTimestamp

Returns number

fromString

Returns

Parameters

date: string

Optional format: string

Optional nlsParam: string

Returns any

getDay

Returns

Returns number

getHour

Returns

Returns number

getMinute

Returns

Returns number

getMonth

Returns

Returns number

getSecond

Returns

Returns number

getYear

Returns

Returns number

subtractInterval

Returns

Parameters

interval: IOracleIntervalDayToSecond | IOracleIntervalYearToMonth

Returns IOracleTimestamp

subtractIntoDayToSecond

Returns

Parameters

other: IOracleTimestamp

Returns IOracleIntervalDayToSecond

subtractIntoYearToMonth

Returns

Parameters

other: IOracleTimestamp

Returns IOracleIntervalYearToMonth

toString

Returns

Parameters

Optional format: string

Optional nlsParam: string

Returns string

Settings

Member Visibility

Theme

`Optional` format: string

`Optional` nlsParam: string

`Optional` format: string

`Optional` nlsParam: string