PostgreSQL Source Code: src/include/utils/timestamp.h Source File

PostgreSQL Source Code git master
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-2025, 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
28 DatumGetTimestamp(Datum X)
29{
30 return (Timestamp) DatumGetInt64(X);
31}
32
33static inline TimestampTz
34 DatumGetTimestampTz(Datum X)
35{
36 return (TimestampTz) DatumGetInt64(X);
37}
38
39static inline Interval *
40 DatumGetIntervalP(Datum X)
41{
42 return (Interval *) DatumGetPointer(X);
43}
44
45static inline Datum
46 TimestampGetDatum(Timestamp X)
47{
48 return Int64GetDatum(X);
49}
50
51static inline Datum
52 TimestampTzGetDatum(TimestampTz X)
53{
54 return Int64GetDatum(X);
55}
56
57static inline Datum
58 IntervalPGetDatum(const Interval *X)
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/* Helper for simple subtraction between two timestamps */
89static inline uint64
90 TimestampDifferenceMicroseconds(TimestampTz start_time,
91 TimestampTz stop_time)
92{
93 if (start_time >= stop_time)
94 return 0;
95 return (uint64) stop_time - start_time;
96}
97
98/* Set at postmaster start */
99extern PGDLLIMPORT TimestampTz PgStartTime;
100
101/* Set at configuration reload */
102extern PGDLLIMPORT TimestampTz PgReloadTime;
103
104
105/* Internal routines (not fmgr-callable) */
106
107extern int32 anytimestamp_typmod_check(bool istz, int32 typmod);
108
109extern TimestampTz GetCurrentTimestamp(void);
110extern TimestampTz GetSQLCurrentTimestamp(int32 typmod);
111extern Timestamp GetSQLLocalTimestamp(int32 typmod);
112extern void TimestampDifference(TimestampTz start_time, TimestampTz stop_time,
113 long *secs, int *microsecs);
114extern long TimestampDifferenceMilliseconds(TimestampTz start_time,
115 TimestampTz stop_time);
116extern bool TimestampDifferenceExceeds(TimestampTz start_time,
117 TimestampTz stop_time,
118 int msec);
119extern bool TimestampDifferenceExceedsSeconds(TimestampTz start_time,
120 TimestampTz stop_time,
121 int threshold_sec);
122
123extern TimestampTz time_t_to_timestamptz(pg_time_t tm);
124extern pg_time_t timestamptz_to_time_t(TimestampTz t);
125
126extern const char *timestamptz_to_str(TimestampTz t);
127
128extern int tm2timestamp(struct pg_tm *tm, fsec_t fsec, int *tzp, Timestamp *result);
129extern int timestamp2tm(Timestamp dt, int *tzp, struct pg_tm *tm,
130 fsec_t *fsec, const char **tzn, pg_tz *attimezone);
131extern void dt2time(Timestamp jd, int *hour, int *min, int *sec, fsec_t *fsec);
132
133extern void interval2itm(Interval span, struct pg_itm *itm);
134extern int itm2interval(struct pg_itm *itm, Interval *span);
135extern int itmin2interval(struct pg_itm_in *itm_in, Interval *span);
136
137extern Timestamp SetEpochTimestamp(void);
138extern void GetEpochTime(struct pg_tm *tm);
139
140extern int timestamp_cmp_internal(Timestamp dt1, Timestamp dt2);
141
142/* timestamp comparison works for timestamptz also */
143 #define timestamptz_cmp_internal(dt1,dt2) timestamp_cmp_internal(dt1, dt2)
144
145extern TimestampTz timestamp2timestamptz_opt_overflow(Timestamp timestamp,
146 int *overflow);
147extern Timestamp timestamptz2timestamp_opt_overflow(TimestampTz timestamp,
148 int *overflow);
149
150extern int32 timestamp_cmp_timestamptz_internal(Timestamp timestampVal,
151 TimestampTz dt2);
152
153extern int isoweek2j(int year, int week);
154extern void isoweek2date(int woy, int *year, int *mon, int *mday);
155extern void isoweekdate2date(int isoweek, int wday, int *year, int *mon, int *mday);
156extern int date2isoweek(int year, int mon, int mday);
157extern int date2isoyear(int year, int mon, int mday);
158extern int date2isoyearday(int year, int mon, int mday);
159
160extern bool TimestampTimestampTzRequiresRewrite(void);
161
162#endif /* TIMESTAMP_H */
#define PGDLLIMPORT
Definition: c.h:1319
int32_t int32
Definition: c.h:534
uint64_t uint64
Definition: c.h:539
int64 Timestamp
Definition: timestamp.h:38
int64 TimestampTz
Definition: timestamp.h:39
int32 fsec_t
Definition: timestamp.h:41
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 Datum Int64GetDatum(int64 X)
Definition: postgres.h:403
static int64 DatumGetInt64(Datum X)
Definition: postgres.h:393
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:332
uint64_t Datum
Definition: postgres.h:70
static Pointer DatumGetPointer(Datum X)
Definition: postgres.h:322
Definition: timestamp.h:83
Definition: timestamp.h:66
Definition: pgtime.h:35
Definition: pgtz.h:66
void dt2time(Timestamp jd, int *hour, int *min, int *sec, fsec_t *fsec)
Definition: timestamp.c:1883
int timestamp_cmp_internal(Timestamp dt1, Timestamp dt2)
Definition: timestamp.c:2210
long TimestampDifferenceMilliseconds(TimestampTz start_time, TimestampTz stop_time)
Definition: timestamp.c:1757
void isoweek2date(int woy, int *year, int *mon, int *mday)
Definition: timestamp.c:5261
void GetEpochTime(struct pg_tm *tm)
Definition: timestamp.c:2168
int itmin2interval(struct pg_itm_in *itm_in, Interval *span)
Definition: timestamp.c:2115
int isoweek2j(int year, int week)
Definition: timestamp.c:5241
TimestampTz time_t_to_timestamptz(pg_time_t tm)
Definition: timestamp.c:1820
static Datum TimestampTzGetDatum(TimestampTz X)
Definition: timestamp.h:52
int date2isoweek(int year, int mon, int mday)
Definition: timestamp.c:5292
Timestamp SetEpochTimestamp(void)
Definition: timestamp.c:2190
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:6445
int date2isoyearday(int year, int mon, int mday)
Definition: timestamp.c:5404
int tm2timestamp(struct pg_tm *tm, fsec_t fsec, int *tzp, Timestamp *result)
Definition: timestamp.c:2006
void TimestampDifference(TimestampTz start_time, TimestampTz stop_time, long *secs, int *microsecs)
Definition: timestamp.c:1721
bool TimestampDifferenceExceedsSeconds(TimestampTz start_time, TimestampTz stop_time, int threshold_sec)
Definition: timestamp.c:1795
bool TimestampTimestampTzRequiresRewrite(void)
Definition: timestamp.c:6414
void isoweekdate2date(int isoweek, int wday, int *year, int *mon, int *mday)
Definition: timestamp.c:5274
int32 timestamp_cmp_timestamptz_internal(Timestamp timestampVal, TimestampTz dt2)
Definition: timestamp.c:2363
bool TimestampDifferenceExceeds(TimestampTz start_time, TimestampTz stop_time, int msec)
Definition: timestamp.c:1781
PGDLLIMPORT TimestampTz PgReloadTime
Definition: timestamp.c:57
PGDLLIMPORT TimestampTz PgStartTime
Definition: timestamp.c:54
Timestamp timestamptz2timestamp_opt_overflow(TimestampTz timestamp, int *overflow)
Definition: timestamp.c:6532
int timestamp2tm(Timestamp dt, int *tzp, struct pg_tm *tm, fsec_t *fsec, const char **tzn, pg_tz *attimezone)
Definition: timestamp.c:1910
int32 anytimestamp_typmod_check(bool istz, int32 typmod)
Definition: timestamp.c:125
TimestampTz GetCurrentTimestamp(void)
Definition: timestamp.c:1645
const char * timestamptz_to_str(TimestampTz t)
Definition: timestamp.c:1862
static Interval * DatumGetIntervalP(Datum X)
Definition: timestamp.h:40
Timestamp GetSQLLocalTimestamp(int32 typmod)
Definition: timestamp.c:1677
void interval2itm(Interval span, struct pg_itm *itm)
Definition: timestamp.c:2047
static uint64 TimestampDifferenceMicroseconds(TimestampTz start_time, TimestampTz stop_time)
Definition: timestamp.h:90
static Timestamp DatumGetTimestamp(Datum X)
Definition: timestamp.h:28
int itm2interval(struct pg_itm *itm, Interval *span)
Definition: timestamp.c:2077
pg_time_t timestamptz_to_time_t(TimestampTz t)
Definition: timestamp.c:1842
static TimestampTz DatumGetTimestampTz(Datum X)
Definition: timestamp.h:34
int date2isoyear(int year, int mon, int mday)
Definition: timestamp.c:5347
TimestampTz GetSQLCurrentTimestamp(int32 typmod)
Definition: timestamp.c:1663

AltStyle によって変換されたページ (->オリジナル) /