date.h File Reference

#include <math.h>
#include "datatype/timestamp.h"
#include "fmgr.h"
#include "pgtime.h"

Include dependency graph for date.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	TimeTzADT

Macros
#define	DATEVAL_NOBEGIN   ((DateADT) PG_INT32_MIN)
#define	DATEVAL_NOEND   ((DateADT) PG_INT32_MAX)
#define	DATE_NOBEGIN(j)   ((j) = DATEVAL_NOBEGIN)
#define	DATE_IS_NOBEGIN(j)   ((j) == DATEVAL_NOBEGIN)
#define	DATE_NOEND(j)   ((j) = DATEVAL_NOEND)
#define	DATE_IS_NOEND(j)   ((j) == DATEVAL_NOEND)
#define	DATE_NOT_FINITE(j)   (DATE_IS_NOBEGIN(j) || DATE_IS_NOEND(j))
#define	MAX_TIME_PRECISION   6
#define	PG_GETARG_DATEADT(n)   DatumGetDateADT(PG_GETARG_DATUM(n))
#define	PG_GETARG_TIMEADT(n)   DatumGetTimeADT(PG_GETARG_DATUM(n))
#define	PG_GETARG_TIMETZADT_P(n)   DatumGetTimeTzADTP(PG_GETARG_DATUM(n))
#define	PG_RETURN_DATEADT(x)   return DateADTGetDatum(x)
#define	PG_RETURN_TIMEADT(x)   return TimeADTGetDatum(x)
#define	PG_RETURN_TIMETZADT_P(x)   return TimeTzADTPGetDatum(x)

Typedefs
typedef int32	DateADT
typedef int64	TimeADT

Functions
static DateADT	DatumGetDateADT (Datum X)
static TimeADT	DatumGetTimeADT (Datum X)
static TimeTzADT *	DatumGetTimeTzADTP (Datum X)
static Datum	DateADTGetDatum (DateADT X)
static Datum	TimeADTGetDatum (TimeADT X)
static Datum	TimeTzADTPGetDatum (const TimeTzADT *X)
double	date2timestamp_no_overflow (DateADT dateVal)
Timestamp	date2timestamp_opt_overflow (DateADT dateVal, int *overflow)
TimestampTz	date2timestamptz_opt_overflow (DateADT dateVal, int *overflow)
int32	date_cmp_timestamp_internal (DateADT dateVal, Timestamp dt2)
int32	date_cmp_timestamptz_internal (DateADT dateVal, TimestampTz dt2)
void	EncodeSpecialDate (DateADT dt, char *str)
int	time2tm (TimeADT time, struct pg_tm *tm, fsec_t *fsec)
int	timetz2tm (TimeTzADT *time, struct pg_tm *tm, fsec_t *fsec, int *tzp)
int	tm2time (struct pg_tm *tm, fsec_t fsec, TimeADT *result)
int	tm2timetz (struct pg_tm *tm, fsec_t fsec, int tz, TimeTzADT *result)
bool	time_overflows (int hour, int min, int sec, fsec_t fsec)
bool	float_time_overflows (int hour, int min, double sec)
void	AdjustTimeForTypmod (TimeADT *time, int32 typmod)

Macro Definition Documentation

DATE_IS_NOBEGIN

#define DATE_IS_NOBEGIN

(

j

)

((j) == DATEVAL_NOBEGIN)

Definition at line 40 of file date.h.

DATE_IS_NOEND

#define DATE_IS_NOEND

(

j

)

((j) == DATEVAL_NOEND)

Definition at line 42 of file date.h.

DATE_NOBEGIN

#define DATE_NOBEGIN

(

j

)

((j) = DATEVAL_NOBEGIN)

Definition at line 39 of file date.h.

DATE_NOEND

#define DATE_NOEND

(

j

)

((j) = DATEVAL_NOEND)

Definition at line 41 of file date.h.

DATE_NOT_FINITE

#define DATE_NOT_FINITE

(

j

)

(DATE_IS_NOBEGIN(j) || DATE_IS_NOEND(j))

Definition at line 43 of file date.h.

DATEVAL_NOBEGIN

#define DATEVAL_NOBEGIN   ((DateADT) PG_INT32_MIN)

Definition at line 36 of file date.h.

DATEVAL_NOEND

#define DATEVAL_NOEND   ((DateADT) PG_INT32_MAX)

Definition at line 37 of file date.h.

MAX_TIME_PRECISION

#define MAX_TIME_PRECISION   6

Definition at line 45 of file date.h.

PG_GETARG_DATEADT

#define PG_GETARG_DATEADT

(

n

)

DatumGetDateADT(PG_GETARG_DATUM(n))

Definition at line 89 of file date.h.

PG_GETARG_TIMEADT

#define PG_GETARG_TIMEADT

(

n

)

DatumGetTimeADT(PG_GETARG_DATUM(n))

Definition at line 90 of file date.h.

PG_GETARG_TIMETZADT_P

#define PG_GETARG_TIMETZADT_P

(

n

)

DatumGetTimeTzADTP(PG_GETARG_DATUM(n))

Definition at line 91 of file date.h.

PG_RETURN_DATEADT

#define PG_RETURN_DATEADT

(

x

)

return DateADTGetDatum(x)

Definition at line 93 of file date.h.

PG_RETURN_TIMEADT

#define PG_RETURN_TIMEADT

(

x

)

return TimeADTGetDatum(x)

Definition at line 94 of file date.h.

PG_RETURN_TIMETZADT_P

#define PG_RETURN_TIMETZADT_P

(

x

)

return TimeTzADTPGetDatum(x)

Definition at line 95 of file date.h.

Typedef Documentation

DateADT

typedef int32 DateADT

Definition at line 23 of file date.h.

TimeADT

typedef int64 TimeADT

Definition at line 25 of file date.h.

Function Documentation

AdjustTimeForTypmod()

void AdjustTimeForTypmod	(	TimeADT *	time,
		int32	typmod
	)

Definition at line 1653 of file date.c.

{
    static const int64 TimeScales[MAX_TIME_PRECISION + 1] = {
        INT64CONST(1000000),
        INT64CONST(100000),
        INT64CONST(10000),
        INT64CONST(1000),
        INT64CONST(100),
        INT64CONST(10),
        INT64CONST(1)
    };
 
    static const int64 TimeOffsets[MAX_TIME_PRECISION + 1] = {
        INT64CONST(500000),
        INT64CONST(50000),
        INT64CONST(5000),
        INT64CONST(500),
        INT64CONST(50),
        INT64CONST(5),
        INT64CONST(0)
    };
 
    if (typmod >= 0 && typmod <= MAX_TIME_PRECISION)
    {
        if (*time >= INT64CONST(0))
            *time = ((*time + TimeOffsets[typmod]) / TimeScales[typmod]) *
                TimeScales[typmod];
        else
            *time = -((((-*time) + TimeOffsets[typmod]) / TimeScales[typmod]) *
                      TimeScales[typmod]);
    }
}

References MAX_TIME_PRECISION.

Referenced by current_time(), parse_datetime(), sql_localtime(), time_in(), time_recv(), time_scale(), timetz_in(), timetz_recv(), and timetz_scale().

date2timestamp_no_overflow()

double date2timestamp_no_overflow

(

DateADT

dateVal

)

Definition at line 728 of file date.c.

{
    double      result;
 
    if (DATE_IS_NOBEGIN(dateVal))
        result = -DBL_MAX;
    else if (DATE_IS_NOEND(dateVal))
        result = DBL_MAX;
    else
    {
        /* date is days since 2000, timestamp is microseconds since same... */
        result = dateVal * (double) USECS_PER_DAY;
    }
 
    return result;
}

References DATE_IS_NOBEGIN, DATE_IS_NOEND, and USECS_PER_DAY.

Referenced by convert_timevalue_to_scalar().

date2timestamp_opt_overflow()

Timestamp date2timestamp_opt_overflow	(	DateADT	dateVal,
		int *	overflow
	)

Definition at line 572 of file date.c.

{
    Timestamp   result;
 
    if (overflow)
        *overflow = 0;
 
    if (DATE_IS_NOBEGIN(dateVal))
        TIMESTAMP_NOBEGIN(result);
    else if (DATE_IS_NOEND(dateVal))
        TIMESTAMP_NOEND(result);
    else
    {
        /*
         * Since dates have the same minimum values as timestamps, only upper
         * boundary need be checked for overflow.
         */
        if (dateVal >= (TIMESTAMP_END_JULIAN - POSTGRES_EPOCH_JDATE))
        {
            if (overflow)
            {
                *overflow = 1;
                TIMESTAMP_NOEND(result);
                return result;
            }
            else
            {
                ereport(ERROR,
                        (errcode(ERRCODE_DATETIME_VALUE_OUT_OF_RANGE),
                         errmsg("date out of range for timestamp")));
            }
        }
 
        /* date is days since 2000, timestamp is microseconds since same... */
        result = dateVal * USECS_PER_DAY;
    }
 
    return result;
}

References DATE_IS_NOBEGIN, DATE_IS_NOEND, ereport, errcode(), errmsg(), ERROR, POSTGRES_EPOCH_JDATE, TIMESTAMP_END_JULIAN, TIMESTAMP_NOBEGIN, TIMESTAMP_NOEND, and USECS_PER_DAY.

Referenced by date2timestamp(), and date_cmp_timestamp_internal().

date2timestamptz_opt_overflow()

TimestampTz date2timestamptz_opt_overflow	(	DateADT	dateVal,
		int *	overflow
	)

Definition at line 632 of file date.c.

{
    TimestampTz result;
    struct pg_tm tt,
               *tm = &tt;
    int         tz;
 
    if (overflow)
        *overflow = 0;
 
    if (DATE_IS_NOBEGIN(dateVal))
        TIMESTAMP_NOBEGIN(result);
    else if (DATE_IS_NOEND(dateVal))
        TIMESTAMP_NOEND(result);
    else
    {
        /*
         * Since dates have the same minimum values as timestamps, only upper
         * boundary need be checked for overflow.
         */
        if (dateVal >= (TIMESTAMP_END_JULIAN - POSTGRES_EPOCH_JDATE))
        {
            if (overflow)
            {
                *overflow = 1;
                TIMESTAMP_NOEND(result);
                return result;
            }
            else
            {
                ereport(ERROR,
                        (errcode(ERRCODE_DATETIME_VALUE_OUT_OF_RANGE),
                         errmsg("date out of range for timestamp")));
            }
        }
 
        j2date(dateVal + POSTGRES_EPOCH_JDATE,
               &(tm->tm_year), &(tm->tm_mon), &(tm->tm_mday));
        tm->tm_hour = 0;
        tm->tm_min = 0;
        tm->tm_sec = 0;
        tz = DetermineTimeZoneOffset(tm, session_timezone);
 
        result = dateVal * USECS_PER_DAY + tz * USECS_PER_SEC;
 
        /*
         * Since it is possible to go beyond allowed timestamptz range because
         * of time zone, check for allowed timestamp range after adding tz.
         */
        if (!IS_VALID_TIMESTAMP(result))
        {
            if (overflow)
            {
                if (result < MIN_TIMESTAMP)
                {
                    *overflow = -1;
                    TIMESTAMP_NOBEGIN(result);
                }
                else
                {
                    *overflow = 1;
                    TIMESTAMP_NOEND(result);
                }
            }
            else
            {
                ereport(ERROR,
                        (errcode(ERRCODE_DATETIME_VALUE_OUT_OF_RANGE),
                         errmsg("date out of range for timestamp")));
            }
        }
    }
 
    return result;
}

References DATE_IS_NOBEGIN, DATE_IS_NOEND, DetermineTimeZoneOffset(), ereport, errcode(), errmsg(), ERROR, IS_VALID_TIMESTAMP, j2date(), MIN_TIMESTAMP, POSTGRES_EPOCH_JDATE, session_timezone, TIMESTAMP_END_JULIAN, TIMESTAMP_NOBEGIN, TIMESTAMP_NOEND, tm, pg_tm::tm_hour, pg_tm::tm_mday, pg_tm::tm_min, pg_tm::tm_mon, pg_tm::tm_sec, pg_tm::tm_year, USECS_PER_DAY, and USECS_PER_SEC.

Referenced by date2timestamptz(), and date_cmp_timestamptz_internal().

date_cmp_timestamp_internal()

int32 date_cmp_timestamp_internal	(	DateADT	dateVal,
		Timestamp	dt2
	)

Definition at line 751 of file date.c.

{
    Timestamp   dt1;
    int         overflow;
 
    dt1 = date2timestamp_opt_overflow(dateVal, &overflow);
    if (overflow > 0)
    {
        /* dt1 is larger than any finite timestamp, but less than infinity */
        return TIMESTAMP_IS_NOEND(dt2) ? -1 : +1;
    }
    Assert(overflow == 0);      /* -1 case cannot occur */
 
    return timestamp_cmp_internal(dt1, dt2);
}

References Assert(), date2timestamp_opt_overflow(), timestamp_cmp_internal(), and TIMESTAMP_IS_NOEND.

Referenced by cmpDateToTimestamp(), date_cmp_timestamp(), date_eq_timestamp(), date_ge_timestamp(), date_gt_timestamp(), date_le_timestamp(), date_lt_timestamp(), date_ne_timestamp(), timestamp_cmp_date(), timestamp_eq_date(), timestamp_ge_date(), timestamp_gt_date(), timestamp_le_date(), timestamp_lt_date(), and timestamp_ne_date().

date_cmp_timestamptz_internal()

int32 date_cmp_timestamptz_internal	(	DateADT	dateVal,
		TimestampTz	dt2
	)

Definition at line 831 of file date.c.

{
    TimestampTz dt1;
    int         overflow;
 
    dt1 = date2timestamptz_opt_overflow(dateVal, &overflow);
    if (overflow > 0)
    {
        /* dt1 is larger than any finite timestamp, but less than infinity */
        return TIMESTAMP_IS_NOEND(dt2) ? -1 : +1;
    }
    if (overflow < 0)
    {
        /* dt1 is less than any finite timestamp, but more than -infinity */
        return TIMESTAMP_IS_NOBEGIN(dt2) ? +1 : -1;
    }
 
    return timestamptz_cmp_internal(dt1, dt2);
}

References date2timestamptz_opt_overflow(), TIMESTAMP_IS_NOBEGIN, TIMESTAMP_IS_NOEND, and timestamptz_cmp_internal.

Referenced by cmpDateToTimestampTz(), date_cmp_timestamptz(), date_eq_timestamptz(), date_ge_timestamptz(), date_gt_timestamptz(), date_le_timestamptz(), date_lt_timestamptz(), date_ne_timestamptz(), timestamptz_cmp_date(), timestamptz_eq_date(), timestamptz_ge_date(), timestamptz_gt_date(), timestamptz_le_date(), timestamptz_lt_date(), and timestamptz_ne_date().

DateADTGetDatum()

static Datum DateADTGetDatum ( DateADT  X )

inlinestatic

Definition at line 72 of file date.h.

{
    return Int32GetDatum(X);
}

References Int32GetDatum().

Referenced by current_date(), daterange_canonical(), gbt_date_penalty(), gbt_dateeq(), gbt_datege(), gbt_dategt(), gbt_datekey_cmp(), gbt_datele(), gbt_datelt(), gbt_num_fetch(), gdb_date_dist(), leftmostvalue_date(), and parse_datetime().

DatumGetDateADT()

static DateADT DatumGetDateADT ( Datum  X )

inlinestatic

Definition at line 54 of file date.h.

{
    return (DateADT) DatumGetInt32(X);
}

References DatumGetInt32().

Referenced by compareDatetime(), convert_timevalue_to_scalar(), daterange_canonical(), gbt_num_compress(), JsonEncodeDateTime(), and map_sql_value_to_xml_value().

DatumGetTimeADT()

static TimeADT DatumGetTimeADT ( Datum  X )

inlinestatic

Definition at line 60 of file date.h.

{
    return (TimeADT) DatumGetInt64(X);
}

References DatumGetInt64().

Referenced by convert_timevalue_to_scalar(), gbt_num_compress(), and JsonEncodeDateTime().

DatumGetTimeTzADTP()

static TimeTzADT* DatumGetTimeTzADTP ( Datum  X )

inlinestatic

Definition at line 66 of file date.h.

{
    return (TimeTzADT *) DatumGetPointer(X);
}

References DatumGetPointer().

Referenced by convert_timevalue_to_scalar(), gbt_timetz_compress(), and JsonEncodeDateTime().

EncodeSpecialDate()

void EncodeSpecialDate	(	DateADT	dt,
		char *	str
	)

Definition at line 292 of file date.c.

{
    if (DATE_IS_NOBEGIN(dt))
        strcpy(str, EARLY);
    else if (DATE_IS_NOEND(dt))
        strcpy(str, LATE);
    else                        /* shouldn't happen */
        elog(ERROR, "invalid argument for EncodeSpecialDate");
}

References DATE_IS_NOBEGIN, DATE_IS_NOEND, EARLY, elog(), ERROR, LATE, and generate_unaccent_rules::str.

Referenced by date_out(), and JsonEncodeDateTime().

float_time_overflows()

bool float_time_overflows	(	int	hour,
		int	min,
		double	sec
	)

Definition at line 1459 of file date.c.

{
    /* Range-check the fields individually. */
    if (hour < 0 || hour > HOURS_PER_DAY ||
        min < 0 || min >= MINS_PER_HOUR)
        return true;
 
    /*
     * "sec", being double, requires extra care.  Cope with NaN, and round off
     * before applying the range check to avoid unexpected errors due to
     * imprecise input.  (We assume rint() behaves sanely with infinities.)
     */
    if (isnan(sec))
        return true;
    sec = rint(sec * USECS_PER_SEC);
    if (sec < 0 || sec > SECS_PER_MINUTE * USECS_PER_SEC)
        return true;
 
    /*
     * Because we allow, eg, hour = 24 or sec = 60, we must check separately
     * that the total time value doesn't exceed 24:00:00.  This must match the
     * way that callers will convert the fields to a time.
     */
    if (((((hour * MINS_PER_HOUR + min) * SECS_PER_MINUTE)
          * USECS_PER_SEC) + (int64) sec) > USECS_PER_DAY)
        return true;
 
    return false;
}

References HOURS_PER_DAY, MINS_PER_HOUR, SECS_PER_MINUTE, USECS_PER_DAY, and USECS_PER_SEC.

Referenced by make_time(), and make_timestamp_internal().

time2tm()

int time2tm	(	TimeADT	time,
		struct pg_tm *	tm,
		fsec_t *	fsec
	)

Definition at line 1496 of file date.c.

{
    tm->tm_hour = time / USECS_PER_HOUR;
    time -= tm->tm_hour * USECS_PER_HOUR;
    tm->tm_min = time / USECS_PER_MINUTE;
    time -= tm->tm_min * USECS_PER_MINUTE;
    tm->tm_sec = time / USECS_PER_SEC;
    time -= tm->tm_sec * USECS_PER_SEC;
    *fsec = time;
    return 0;
}

References tm, pg_tm::tm_hour, pg_tm::tm_min, pg_tm::tm_sec, USECS_PER_HOUR, USECS_PER_MINUTE, and USECS_PER_SEC.

Referenced by JsonEncodeDateTime(), time_out(), time_part_common(), and time_timetz().

time_overflows()

bool time_overflows	(	int	hour,
		int	min,
		int	sec,
		fsec_t	fsec
	)

Definition at line 1435 of file date.c.

{
    /* Range-check the fields individually. */
    if (hour < 0 || hour > HOURS_PER_DAY ||
        min < 0 || min >= MINS_PER_HOUR ||
        sec < 0 || sec > SECS_PER_MINUTE ||
        fsec < 0 || fsec > USECS_PER_SEC)
        return true;
 
    /*
     * Because we allow, eg, hour = 24 or sec = 60, we must check separately
     * that the total time value doesn't exceed 24:00:00.
     */
    if ((((((hour * MINS_PER_HOUR + min) * SECS_PER_MINUTE)
           + sec) * USECS_PER_SEC) + fsec) > USECS_PER_DAY)
        return true;
 
    return false;
}

References HOURS_PER_DAY, MINS_PER_HOUR, SECS_PER_MINUTE, USECS_PER_DAY, and USECS_PER_SEC.

Referenced by DecodeDateTime(), and DecodeTimeOnly().

TimeADTGetDatum()

static Datum TimeADTGetDatum ( TimeADT  X )

inlinestatic

Definition at line 78 of file date.h.

{
    return Int64GetDatum(X);
}

References Int64GetDatum().

Referenced by gbt_num_fetch(), leftmostvalue_time(), parse_datetime(), and sql_localtime().

timetz2tm()

int timetz2tm	(	TimeTzADT *	time,
		struct pg_tm *	tm,
		fsec_t *	fsec,
		int *	tzp
	)

Definition at line 2403 of file date.c.

{
    TimeOffset  trem = time->time;
 
    tm->tm_hour = trem / USECS_PER_HOUR;
    trem -= tm->tm_hour * USECS_PER_HOUR;
    tm->tm_min = trem / USECS_PER_MINUTE;
    trem -= tm->tm_min * USECS_PER_MINUTE;
    tm->tm_sec = trem / USECS_PER_SEC;
    *fsec = trem - tm->tm_sec * USECS_PER_SEC;
 
    if (tzp != NULL)
        *tzp = time->zone;
 
    return 0;
}

References TimeTzADT::time, tm, pg_tm::tm_hour, pg_tm::tm_min, pg_tm::tm_sec, USECS_PER_HOUR, USECS_PER_MINUTE, USECS_PER_SEC, and TimeTzADT::zone.

Referenced by JsonEncodeDateTime(), timetz_out(), and timetz_part_common().

TimeTzADTPGetDatum()

static Datum TimeTzADTPGetDatum ( const TimeTzADT *  X )

inlinestatic

Definition at line 84 of file date.h.

{
    return PointerGetDatum(X);
}

References PointerGetDatum().

Referenced by current_time(), leftmostvalue_timetz(), and parse_datetime().

tm2time()

int tm2time	(	struct pg_tm *	tm,
		fsec_t	fsec,
		TimeADT *	result
	)

Definition at line 1424 of file date.c.

{
    *result = ((((tm->tm_hour * MINS_PER_HOUR + tm->tm_min) * SECS_PER_MINUTE) + tm->tm_sec)
               * USECS_PER_SEC) + fsec;
    return 0;
}

References MINS_PER_HOUR, SECS_PER_MINUTE, tm, pg_tm::tm_hour, pg_tm::tm_min, pg_tm::tm_sec, and USECS_PER_SEC.

Referenced by parse_datetime(), sql_localtime(), and time_in().

tm2timetz()

int tm2timetz	(	struct pg_tm *	tm,
		fsec_t	fsec,
		int	tz,
		TimeTzADT *	result
	)

Definition at line 2263 of file date.c.

{
    result->time = ((((tm->tm_hour * MINS_PER_HOUR + tm->tm_min) * SECS_PER_MINUTE) + tm->tm_sec) *
                    USECS_PER_SEC) + fsec;
    result->zone = tz;
 
    return 0;
}

References MINS_PER_HOUR, SECS_PER_MINUTE, TimeTzADT::time, tm, pg_tm::tm_hour, pg_tm::tm_min, pg_tm::tm_sec, USECS_PER_SEC, and TimeTzADT::zone.

Referenced by current_time(), parse_datetime(), timestamptz_timetz(), and timetz_in().