MySQL  8.0.17
Source Code Documentation
mysql_time.h
Go to the documentation of this file.
1 /* Copyright (c) 2004, 2017, Oracle and/or its affiliates. All rights reserved.
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 also distributed 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 included with MySQL.
13 
14  Without limiting anything contained in the foregoing, this file,
15  which is part of C Driver for MySQL (Connector/C), is also subject to the
16  Universal FOSS Exception, version 1.0, a copy of which can be found at
17  http://oss.oracle.com/licenses/universal-foss-exception.
18 
19  This program is distributed in the hope that it will be useful,
20  but WITHOUT ANY WARRANTY; without even the implied warranty of
21  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22  GNU General Public License, version 2.0, for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with this program; if not, write to the Free Software
26  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
27 
28 #ifndef _mysql_time_h_
29 #define _mysql_time_h_
30 
31 /**
32  @file include/mysql_time.h
33  Time declarations shared between the server and client API:
34  you should not add anything to this header unless it's used
35  (and hence should be visible) in mysql.h.
36  If you're looking for a place to add new time-related declaration,
37  it's most likely my_time.h. See also "C API Handling of Date
38  and Time Values" chapter in documentation.
39 */
40 
41 // Do not not pull in the server header "my_inttypes.h" from client code.
42 // IWYU pragma: no_include "my_inttypes.h"
43 
50 };
51 
52 /*
53  Structure which is used to represent datetime values inside MySQL.
54 
55  We assume that values in this structure are normalized, i.e. year <= 9999,
56  month <= 12, day <= 31, hour <= 23, hour <= 59, hour <= 59. Many functions
57  in server such as my_system_gmt_sec() or make_time() family of functions
58  rely on this (actually now usage of make_*() family relies on a bit weaker
59  restriction). Also functions that produce MYSQL_TIME as result ensure this.
60  There is one exception to this rule though if this structure holds time
61  value (time_type == MYSQL_TIMESTAMP_TIME) days and hour member can hold
62  bigger values.
63 */
64 typedef struct MYSQL_TIME {
65  unsigned int year, month, day, hour, minute, second;
66  unsigned long second_part; /**< microseconds */
67  bool neg;
69 } MYSQL_TIME;
70 
71 #endif /* _mysql_time_h_ */
enum enum_mysql_timestamp_type time_type
Definition: mysql_time.h:68
unsigned long second_part
microseconds
Definition: mysql_time.h:66
unsigned int second
Definition: mysql_time.h:65
Definition: mysql_time.h:45
unsigned int minute
Definition: mysql_time.h:65
struct MYSQL_TIME MYSQL_TIME
Definition: mysql_time.h:46
unsigned int hour
Definition: mysql_time.h:65
unsigned int day
Definition: mysql_time.h:65
bool neg
Definition: mysql_time.h:67
unsigned int year
Definition: mysql_time.h:65
Definition: mysql_time.h:49
Definition: mysql_time.h:64
enum_mysql_timestamp_type
Definition: mysql_time.h:44
Definition: mysql_time.h:47
Definition: mysql_time.h:48
unsigned int month
Definition: mysql_time.h:65