MySQL 8.4.3
Source Code Documentation
sql_time.h
Go to the documentation of this file.
1/* Copyright (c) 2006, 2024, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is designed to work with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have either included with
13 the program or referenced in the documentation.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
23
24#ifndef SQL_TIME_INCLUDED
25#define SQL_TIME_INCLUDED
26
27/**
28 @ingroup SQL_TIME
29 @{
30
31 @file sql/sql_time.h
32
33 Interface for server time utilities.
34*/
35
36#include "my_config.h"
37
38#include <stddef.h>
39#ifdef HAVE_SYS_TIME_H
40#include <sys/time.h>
41#endif
42#include <sys/types.h>
43
44#include "field_types.h" // enum_field_types
45#include "lex_string.h"
46#include "my_dbug.h"
47#include "my_inttypes.h"
48#include "my_time.h"
50#include "mysql_time.h" /* enum_mysql_timestamp_type */
51#include "sql/sql_error.h" /* Sql_condition */
52#include "sql_string.h"
53
54class THD;
55class Time_zone;
56class my_decimal;
57
58/**
59 Representation of time formats.
60 */
64};
65
66/**
67 Collection of strings describing date/time formats.
68 */
70 const char *format_name;
71 const char *date_format;
72 const char *datetime_format;
73 const char *time_format;
74};
75
77 bool *not_exist);
79 const Time_zone &tz,
80 my_timeval *tm, int *warnings);
81bool datetime_to_timeval(const MYSQL_TIME *t, const Time_zone &tz,
82 my_timeval *tm, int *warnings);
87bool decimal_to_time(const my_decimal *decimal, MYSQL_TIME *ltime);
88bool double_to_datetime(double nr, MYSQL_TIME *ltime, my_time_flags_t flags);
89bool double_to_time(double nr, MYSQL_TIME *ltime);
90
93bool my_double_to_datetime_with_warn(double nr, MYSQL_TIME *ltime,
98bool my_double_to_time_with_warn(double nr, MYSQL_TIME *ltime);
101void time_to_datetime(THD *thd, const MYSQL_TIME *tm, const Time_zone &tz,
102 MYSQL_TIME *dt);
103void time_to_datetime(THD *thd, const MYSQL_TIME *in, MYSQL_TIME *out);
104
107 const ErrConvString &val,
109 const char *field_name);
110
111const char *get_date_time_format_str(const Known_date_time_format *format,
113void make_date(const Date_time_format *format, const MYSQL_TIME *l_time,
114 String *str);
115void make_time(const Date_time_format *format, const MYSQL_TIME *l_time,
116 String *str, uint dec);
117void make_datetime(const Date_time_format *format, const MYSQL_TIME *l_time,
118 String *str, uint dec);
119bool my_TIME_to_str(const MYSQL_TIME *ltime, String *str, uint dec);
120
122
123void propagate_datetime_overflow_helper(THD *thd, int *warnings);
124
125/**
126 Wrapper function which will propagate any DATETIME_OVERFLOW warnings
127 to the THD. Overload for the case where a warnings bitset already
128 exists which can be inspected before the value of the mysys
129 function is passed on.
130
131 @param thd Thread context
132 @param warnings bitset used mysys function
133 @param t value mysys function which is passed on
134 @returns t
135 */
136template <class T>
137inline T propagate_datetime_overflow(THD *thd, int *warnings, T t) {
139 return t;
140}
141
142/**
143 Wrapper function which will propagate any DATETIME_OVERFLOW warnings
144 to the THD. Overload for the case when a warnings bitset must be
145 created and inspected to call a mysys function. The mysys function
146 must be invoked by the closure argument which invoked with a
147 pointer to the warnings bitset as argument.
148
149 @param thd Thread context
150 @param clos closure to call with empty warnings bitset
151 @return return value of closure
152 */
153template <class CLOS>
154inline auto propagate_datetime_overflow(THD *thd, CLOS &&clos) {
155 int warnings = 0;
156 return propagate_datetime_overflow(thd, &warnings, clos(&warnings));
157}
158
161
162bool str_to_time(const CHARSET_INFO *cs, const char *str, size_t length,
165
166/**
167 Converts a time String value to MYSQL_TIME. Forwards to the version
168 taking an explicit charset, c-string and length.
169
170 @return False on success, true on error.
171 */
172inline bool str_to_time(const String *str, MYSQL_TIME *ltime,
174 return str_to_time(str->charset(), str->ptr(), str->length(), ltime, flags,
175 status);
176}
177
178bool str_to_datetime(const CHARSET_INFO *cs, const char *str, size_t length,
181
182/**
183 Converts a datetime String value to MYSQL_TIME. Forwards to the
184 version taking an explicit charset, c-string and length.
185
186 @return False on success, true on error.
187*/
188inline bool str_to_datetime(const String *str, MYSQL_TIME *ltime,
190 return str_to_datetime(str->charset(), str->ptr(), str->length(), ltime,
191 flags, status);
192}
193
195
198 longlong packed_value);
199
200/**
201 Return the timstamp value corresponding the field type passed as argument.
202
203 @param type field type
204 @return corresponding timestamp type
205 */
207 enum enum_field_types type) {
208 switch (type) {
209 case MYSQL_TYPE_TIME:
211 case MYSQL_TYPE_DATE:
216 default:
218 }
219}
220
221/**
222 This function gets GMT time and adds value of time_zone to get
223 the local time. This function is used when server wants a timestamp
224 value from dictionary system.
225
226 @return time converted to local time
227*/
228
230
231/**
232 In lieu of a proper constructor for the C struct MYSQL_TIME, this method
233 initializes the struct.
234*/
235MYSQL_TIME my_time_set(uint y, uint m, uint d, uint h, uint mi, uint s,
236 unsigned long ms, bool negative,
238/**
239 Return the number of significant second fraction decimals in ts, e.g.
240 for ts->second_part == 120300, return 4.
241
242 @param ts the time value for which we want the number of decmals
243 @return the number of decimals
244*/
245uint actual_decimals(const MYSQL_TIME *ts);
246
247/**
248 For a time fraction with a given number of decimals, return maximum fraction,
249 if any, can be are present in a time value. For example, if 2 decimals are
250 specified, return 990000. If none, 0.
251
252 @param decimals the number of decimals
253 @return the maximum fraction
254*/
255size_t max_fraction(uint decimals);
256
257/**
258 @} (end of ingroup SQL_TIME)
259*/
260
261#endif /* SQL_TIME_INCLUDED */
Definition: sql_error.h:225
enum_severity_level
Enumeration value describing the severity of the condition.
Definition: sql_error.h:63
Using this class is fraught with peril, and you need to be very careful when doing so.
Definition: sql_string.h:167
For each client connection we create a separate thread with THD serving as a thread/connection descri...
Definition: sql_lexer_thd.h:36
This class represents abstract time zone and provides basic interface for MYSQL_TIME <-> my_time_t co...
Definition: tztime.h:49
my_decimal class limits 'decimal_t' type to what we need in MySQL.
Definition: my_decimal.h:95
This file contains the field type.
enum_field_types
Column types for MySQL Note: Keep include/mysql/components/services/bits/stored_program_bits....
Definition: field_types.h:55
@ MYSQL_TYPE_TIME
Definition: field_types.h:67
@ MYSQL_TYPE_DATE
Definition: field_types.h:66
@ MYSQL_TYPE_TIMESTAMP
Definition: field_types.h:63
@ MYSQL_TYPE_DATETIME
Definition: field_types.h:68
static const std::string dec("DECRYPTION")
const char * get_date_time_format_str(const Known_date_time_format *format, enum_mysql_timestamp_type type)
Return format string according format name.
Definition: sql_time.cc:665
my_decimal * my_decimal_from_datetime_packed(my_decimal *dec, enum enum_field_types type, longlong packed_value)
Unpack packed numeric temporal value to date/time value and then convert to decimal representation.
Definition: sql_time.cc:837
bool make_truncated_value_warning(THD *thd, Sql_condition::enum_severity_level level, const ErrConvString &val, enum_mysql_timestamp_type time_type, const char *field_name)
Create and add a truncated value warning to the THD.
Definition: sql_time.cc:757
bool decimal_to_datetime(const my_decimal *decimal, MYSQL_TIME *ltime, my_time_flags_t flags)
Convert decimal value to datetime.
Definition: sql_time.cc:265
void make_time(const Date_time_format *format, const MYSQL_TIME *l_time, String *str, uint dec)
Convert TIME value to String.
Definition: sql_time.cc:703
bool my_double_to_datetime_with_warn(double nr, MYSQL_TIME *ltime, my_time_flags_t flags)
Convert double value to datetime value with a warning.
Definition: sql_time.cc:333
bool date_add_interval_with_warn(THD *, MYSQL_TIME *ltime, interval_type int_type, Interval interval)
Uses propagate_datetime_overflow() to handle and propagate any warnings from date_add_interval() to t...
Definition: sql_time.cc:805
bool str_to_time_with_warn(String *str, MYSQL_TIME *l_time)
Convert a time string to a MYSQL_TIME struct and produce a warning if string was cut during conversio...
Definition: sql_time.cc:620
void make_datetime(const Date_time_format *format, const MYSQL_TIME *l_time, String *str, uint dec)
Convert DATETIME value to String.
Definition: sql_time.cc:731
T propagate_datetime_overflow(THD *thd, int *warnings, T t)
Wrapper function which will propagate any DATETIME_OVERFLOW warnings to the THD.
Definition: sql_time.h:137
ulonglong gmt_time_to_local_time(ulonglong time)
This function gets GMT time and adds value of time_zone to get the local time.
Definition: sql_time.cc:868
uint actual_decimals(const MYSQL_TIME *ts)
Return the number of significant second fraction decimals in ts, e.g.
Definition: sql_time.cc:895
bool my_double_to_time_with_warn(double nr, MYSQL_TIME *ltime)
Convert double number to TIME.
Definition: sql_time.cc:472
bool my_longlong_to_time_with_warn(longlong nr, MYSQL_TIME *ltime)
Convert longlong number to TIME.
Definition: sql_time.cc:500
void propagate_datetime_overflow_helper(THD *thd, int *warnings)
Propagates a DATETIME_OVERFLOW warning from warnings bitfield to DA in thd.
Definition: sql_time.cc:818
const LEX_CSTRING interval_type_to_name[]
Name description of interval names used in statements.
Definition: sql_time.cc:70
enum_mysql_timestamp_type field_type_to_timestamp_type(enum enum_field_types type)
Return the timstamp value corresponding the field type passed as argument.
Definition: sql_time.h:206
size_t max_fraction(uint decimals)
For a time fraction with a given number of decimals, return maximum fraction, if any,...
Definition: sql_time.cc:904
bool double_to_datetime(double nr, MYSQL_TIME *ltime, my_time_flags_t flags)
Convert double value to datetime.
Definition: sql_time.cc:316
bool str_to_time(const CHARSET_INFO *cs, const char *str, size_t length, MYSQL_TIME *l_time, my_time_flags_t flags, MYSQL_TIME_STATUS *status)
Character set-aware version of str_to_time().
Definition: sql_time.cc:152
bool datetime_to_timeval(const MYSQL_TIME *t, const Time_zone &tz, my_timeval *tm, int *warnings)
Convert a datetime MYSQL_TIME representation to corresponding "struct timeval" value.
Definition: sql_time.cc:605
my_time_flags_t DatetimeConversionFlags(const THD *thd)
Generate flags to use when converting a string to a date or datetime value.
Definition: sql_time.cc:108
bool str_to_datetime(const CHARSET_INFO *cs, const char *str, size_t length, MYSQL_TIME *l_time, my_time_flags_t flags, MYSQL_TIME_STATUS *status)
Character set-aware version of str_to_datetime().
Definition: sql_time.cc:173
void make_date(const Date_time_format *format, const MYSQL_TIME *l_time, String *str)
Convert DATE value to String.
Definition: sql_time.cc:717
bool double_to_time(double nr, MYSQL_TIME *ltime)
Convert double number to TIME.
Definition: sql_time.cc:455
MYSQL_TIME my_time_set(uint y, uint m, uint d, uint h, uint mi, uint s, unsigned long ms, bool negative, enum_mysql_timestamp_type type)
In lieu of a proper constructor for the C struct MYSQL_TIME, this method initializes the struct.
Definition: sql_time.cc:889
bool str_to_datetime_with_warn(String *str, MYSQL_TIME *l_time, my_time_flags_t flags)
Convert a timestamp string to a MYSQL_TIME value and produce a warning if string was truncated during...
Definition: sql_time.cc:198
bool my_TIME_to_str(const MYSQL_TIME *ltime, String *str, uint dec)
Convert TIME/DATE/DATETIME value to String.
Definition: sql_time.cc:745
bool decimal_to_time(const my_decimal *decimal, MYSQL_TIME *ltime)
Convert decimal number to TIME.
Definition: sql_time.cc:408
bool my_longlong_to_datetime_with_warn(longlong nr, MYSQL_TIME *ltime, my_time_flags_t flags)
Convert longlong value to datetime value with a warning.
Definition: sql_time.cc:364
bool my_decimal_to_datetime_with_warn(const my_decimal *decimal, MYSQL_TIME *ltime, my_time_flags_t flags)
Convert decimal value to datetime value with a warning.
Definition: sql_time.cc:283
bool datetime_with_no_zero_in_date_to_timeval(const MYSQL_TIME *t, const Time_zone &tz, my_timeval *tm, int *warnings)
Converts a datetime in MYSQL_TIME representation to corresponding struct timeval value.
Definition: sql_time.cc:539
bool my_decimal_to_time_with_warn(const my_decimal *decimal, MYSQL_TIME *ltime)
Convert decimal number to TIME.
Definition: sql_time.cc:425
my_time_t TIME_to_timestamp(const MYSQL_TIME *t, const Time_zone &tz, bool *not_exist)
void time_to_datetime(THD *thd, const MYSQL_TIME *tm, const Time_zone &tz, MYSQL_TIME *dt)
static int flags[50]
Definition: hp_test1.cc:40
A better implementation of the UNIX ctype(3) library.
Some integer typedefs for easier portability.
unsigned long long int ulonglong
Definition: my_inttypes.h:56
unsigned char uchar
Definition: my_inttypes.h:52
long long int longlong
Definition: my_inttypes.h:55
Interface for low level time utilities.
unsigned int my_time_flags_t
Flags to str_to_datetime and number_to_datetime.
Definition: my_time.h:94
interval_type
Available interval types used in any statement.
Definition: my_time.h:455
int64_t my_time_t
Portable time_t replacement.
Definition: my_time_t.h:32
Time declarations shared between the server and client API: you should not add anything to this heade...
enum_mysql_timestamp_type
Definition: mysql_time.h:45
@ MYSQL_TIMESTAMP_TIME
Stores hour, minute, second and microsecond.
Definition: mysql_time.h:60
@ MYSQL_TIMESTAMP_DATETIME
Stores all date and time components.
Definition: mysql_time.h:57
@ MYSQL_TIMESTAMP_DATE
Stores year, month and day components.
Definition: mysql_time.h:50
@ MYSQL_TIMESTAMP_NONE
Definition: mysql_time.h:46
static int interval
Definition: mysqladmin.cc:71
std::string str(const mysqlrouter::ConfigGenerator::Options::Endpoint &ep)
Definition: config_generator.cc:1081
Definition: commit_order_queue.h:34
bool length(const dd::Spatial_reference_system *srs, const Geometry *g1, double *length, bool *null) noexcept
Computes the length of linestrings and multilinestrings.
Definition: length.cc:76
required uint32 status
Definition: replication_asynchronous_connection_failover.proto:61
required string type
Definition: replication_group_member_actions.proto:34
Our own string classes, used pervasively throughout the executor.
Definition: m_ctype.h:423
Representation of time formats.
Definition: sql_time.h:61
LEX_CSTRING format
Definition: sql_time.h:63
uchar positions[8]
Definition: sql_time.h:62
Struct representing a duration.
Definition: my_time.h:228
Collection of strings describing date/time formats.
Definition: sql_time.h:69
const char * time_format
Definition: sql_time.h:73
const char * datetime_format
Definition: sql_time.h:72
const char * date_format
Definition: sql_time.h:71
const char * format_name
Definition: sql_time.h:70
Definition: mysql_lex_string.h:40
Structure to return status from str_to_datetime(), str_to_time(), number_to_datetime(),...
Definition: my_time.h:170
Definition: mysql_time.h:82
A structure to store a decimal value together with its precision and number of decimals TODO: HCS-100...
Definition: protocol_local_v2.h:43
Replacement of system's struct timeval to ensure we can carry 64 bit values even on a platform which ...
Definition: my_time_t.h:45
Include file for Sun RPC to compile out of the box.