MLE PL/SQL Types(mle-js-plsqltypes)
    Preparing search index...

    Class IOracleTimestampTZ

    JavaScript API for Oracle type TIMESTAMP WITH TIME ZONE.

    Index

    Constructors

    Methods

    • Convert this IOracleTimestampTZ 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.

      The function returns an error if the date lies in a DST transition period in the specified time zone and if the Oracle Database parameter ERROR_ON_OVERLAP_TIME is true for the current session.

      Parameters

      • timezone: string

        The time zone string.

      Returns IOracleTimestampTZ

    • Gets the day component in the Gregorian calendar.

      Returns number

      day component as number

    • Gets the fractional second component.

      Returns number

      fractional second component as number

    • Gets the hour component.

      Returns number

      hour component as number

    • Gets the minute component.

      Returns number

      minute component as number

    • Gets the month component in the Gregorian calendar.

      Returns number

      month component as number

    • Gets the second component.

      Returns number

      second component as number

    • Gets the time zone of an IOracleTimestampTZ.

      Returns string

      the time zone name as string

    • Gets the year component in the Gregorian calendar.

      Returns number

      year component as number

    • Converts the given datetime to a string in a given 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

    • Parse a string into an IOracleTimestampTZ. 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 WITH TIME ZONE data type, which is determined by the NLS_TIMESTAMP_TZ_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_TZ parameter).

      The function returns an error if the specified date lies in a DST transition period and if the Oracle Database parameter ERROR_ON_OVERLAP_TIME is true for the current session.

      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_TZ SQL function.

      Returns IOracleTimestampTZ

      an IOracleTimestampTZ object