PostgreSQL Source Code git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
timestamp.h
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * timestamp.h
4 * Definitions for the SQL "timestamp" and "interval" types.
5 *
6 * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
8 *
9 * src/include/utils/timestamp.h
10 *
11 *-------------------------------------------------------------------------
12 */
13#ifndef TIMESTAMP_H
14#define TIMESTAMP_H
15
16#include "datatype/timestamp.h"
17#include "fmgr.h"
18#include "pgtime.h"
19
20
21/*
22 * Functions for fmgr-callable functions.
23 *
24 * For Timestamp, we make use of the same support routines as for int64.
25 * Therefore Timestamp is pass-by-reference if and only if int64 is!
26 */
27static inline Timestamp
29{
30 return (Timestamp) DatumGetInt64(X);
31}
32
33static inline TimestampTz
35{
36 return (TimestampTz) DatumGetInt64(X);
37}
38
39static inline Interval *
41{
42 return (Interval *) DatumGetPointer(X);
43}
44
45static inline Datum
47{
48 return Int64GetDatum(X);
49}
50
51static inline Datum
53{
54 return Int64GetDatum(X);
55}
56
57static inline Datum
59{
60 return PointerGetDatum(X);
61}
62
63#define PG_GETARG_TIMESTAMP(n) DatumGetTimestamp(PG_GETARG_DATUM(n))
64#define PG_GETARG_TIMESTAMPTZ(n) DatumGetTimestampTz(PG_GETARG_DATUM(n))
65#define PG_GETARG_INTERVAL_P(n) DatumGetIntervalP(PG_GETARG_DATUM(n))
66
67#define PG_RETURN_TIMESTAMP(x) return TimestampGetDatum(x)
68#define PG_RETURN_TIMESTAMPTZ(x) return TimestampTzGetDatum(x)
69#define PG_RETURN_INTERVAL_P(x) return IntervalPGetDatum(x)
70
71
72#define TIMESTAMP_MASK(b) (1 << (b))
73#define INTERVAL_MASK(b) (1 << (b))
74
75/* Macros to handle packing and unpacking the typmod field for intervals */
76#define INTERVAL_FULL_RANGE (0x7FFF)
77#define INTERVAL_RANGE_MASK (0x7FFF)
78#define INTERVAL_FULL_PRECISION (0xFFFF)
79#define INTERVAL_PRECISION_MASK (0xFFFF)
80#define INTERVAL_TYPMOD(p,r) ((((r) & INTERVAL_RANGE_MASK) << 16) | ((p) & INTERVAL_PRECISION_MASK))
81#define INTERVAL_PRECISION(t) ((t) & INTERVAL_PRECISION_MASK)
82#define INTERVAL_RANGE(t) (((t) >> 16) & INTERVAL_RANGE_MASK)
83
84/* Macros for doing timestamp arithmetic without assuming timestamp's units */
85#define TimestampTzPlusMilliseconds(tz,ms) ((tz) + ((ms) * (int64) 1000))
86#define TimestampTzPlusSeconds(tz,s) ((tz) + ((s) * (int64) 1000000))
87
88
89/* Set at postmaster start */
91
92/* Set at configuration reload */
94
95
96/* Internal routines (not fmgr-callable) */
97
98extern int32 anytimestamp_typmod_check(bool istz, int32 typmod);
99
104 long *secs, int *microsecs);
106 TimestampTz stop_time);
108 TimestampTz stop_time,
109 int msec);
110
113
114extern const char *timestamptz_to_str(TimestampTz t);
115
116extern int tm2timestamp(struct pg_tm *tm, fsec_t fsec, int *tzp, Timestamp *result);
117extern int timestamp2tm(Timestamp dt, int *tzp, struct pg_tm *tm,
118 fsec_t *fsec, const char **tzn, pg_tz *attimezone);
119extern void dt2time(Timestamp jd, int *hour, int *min, int *sec, fsec_t *fsec);
120
121extern void interval2itm(Interval span, struct pg_itm *itm);
122extern int itm2interval(struct pg_itm *itm, Interval *span);
123extern int itmin2interval(struct pg_itm_in *itm_in, Interval *span);
124
125extern Timestamp SetEpochTimestamp(void);
126extern void GetEpochTime(struct pg_tm *tm);
127
128extern int timestamp_cmp_internal(Timestamp dt1, Timestamp dt2);
129
130/* timestamp comparison works for timestamptz also */
131#define timestamptz_cmp_internal(dt1,dt2) timestamp_cmp_internal(dt1, dt2)
132
134 int *overflow);
136 TimestampTz dt2);
137
138extern int isoweek2j(int year, int week);
139extern void isoweek2date(int woy, int *year, int *mon, int *mday);
140extern void isoweekdate2date(int isoweek, int wday, int *year, int *mon, int *mday);
141extern int date2isoweek(int year, int mon, int mday);
142extern int date2isoyear(int year, int mon, int mday);
143extern int date2isoyearday(int year, int mon, int mday);
144
146
147#endif /* TIMESTAMP_H */
#define PGDLLIMPORT
Definition: c.h:1274
int32_t int32
Definition: c.h:481
int64 Timestamp
Definition: timestamp.h:38
int64 TimestampTz
Definition: timestamp.h:39
int32 fsec_t
Definition: timestamp.h:41
Datum Int64GetDatum(int64 X)
Definition: fmgr.c:1807
static struct pg_tm tm
Definition: localtime.c:104
static time_t start_time
Definition: pg_ctl.c:95
int64 pg_time_t
Definition: pgtime.h:23
int64 timestamp
static int64 DatumGetInt64(Datum X)
Definition: postgres.h:385
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:322
uintptr_t Datum
Definition: postgres.h:64
static Pointer DatumGetPointer(Datum X)
Definition: postgres.h:312
Definition: pgtime.h:35
Definition: pgtz.h:66
void dt2time(Timestamp jd, int *hour, int *min, int *sec, fsec_t *fsec)
Definition: timestamp.c:1864
int timestamp_cmp_internal(Timestamp dt1, Timestamp dt2)
Definition: timestamp.c:2191
long TimestampDifferenceMilliseconds(TimestampTz start_time, TimestampTz stop_time)
Definition: timestamp.c:1756
void isoweek2date(int woy, int *year, int *mon, int *mday)
Definition: timestamp.c:5216
void GetEpochTime(struct pg_tm *tm)
Definition: timestamp.c:2149
int itmin2interval(struct pg_itm_in *itm_in, Interval *span)
Definition: timestamp.c:2096
int isoweek2j(int year, int week)
Definition: timestamp.c:5196
TimestampTz time_t_to_timestamptz(pg_time_t tm)
Definition: timestamp.c:1801
static Datum TimestampTzGetDatum(TimestampTz X)
Definition: timestamp.h:52
int date2isoweek(int year, int mon, int mday)
Definition: timestamp.c:5247
Timestamp SetEpochTimestamp(void)
Definition: timestamp.c:2171
static Datum TimestampGetDatum(Timestamp X)
Definition: timestamp.h:46
static Datum IntervalPGetDatum(const Interval *X)
Definition: timestamp.h:58
TimestampTz timestamp2timestamptz_opt_overflow(Timestamp timestamp, int *overflow)
Definition: timestamp.c:6400
int date2isoyearday(int year, int mon, int mday)
Definition: timestamp.c:5359
int tm2timestamp(struct pg_tm *tm, fsec_t fsec, int *tzp, Timestamp *result)
Definition: timestamp.c:1987
void TimestampDifference(TimestampTz start_time, TimestampTz stop_time, long *secs, int *microsecs)
Definition: timestamp.c:1720
bool TimestampTimestampTzRequiresRewrite(void)
Definition: timestamp.c:6369
void isoweekdate2date(int isoweek, int wday, int *year, int *mon, int *mday)
Definition: timestamp.c:5229
int32 timestamp_cmp_timestamptz_internal(Timestamp timestampVal, TimestampTz dt2)
Definition: timestamp.c:2318
bool TimestampDifferenceExceeds(TimestampTz start_time, TimestampTz stop_time, int msec)
Definition: timestamp.c:1780
PGDLLIMPORT TimestampTz PgReloadTime
Definition: timestamp.c:56
PGDLLIMPORT TimestampTz PgStartTime
Definition: timestamp.c:53
int timestamp2tm(Timestamp dt, int *tzp, struct pg_tm *tm, fsec_t *fsec, const char **tzn, pg_tz *attimezone)
Definition: timestamp.c:1891
int32 anytimestamp_typmod_check(bool istz, int32 typmod)
Definition: timestamp.c:124
TimestampTz GetCurrentTimestamp(void)
Definition: timestamp.c:1644
const char * timestamptz_to_str(TimestampTz t)
Definition: timestamp.c:1843
static Interval * DatumGetIntervalP(Datum X)
Definition: timestamp.h:40
Timestamp GetSQLLocalTimestamp(int32 typmod)
Definition: timestamp.c:1676
void interval2itm(Interval span, struct pg_itm *itm)
Definition: timestamp.c:2028
static Timestamp DatumGetTimestamp(Datum X)
Definition: timestamp.h:28
int itm2interval(struct pg_itm *itm, Interval *span)
Definition: timestamp.c:2058
pg_time_t timestamptz_to_time_t(TimestampTz t)
Definition: timestamp.c:1823
static TimestampTz DatumGetTimestampTz(Datum X)
Definition: timestamp.h:34
int date2isoyear(int year, int mon, int mday)
Definition: timestamp.c:5302
TimestampTz GetSQLCurrentTimestamp(int32 typmod)
Definition: timestamp.c:1662