1 /* Copyright (c) 2004, 2021, 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 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 Street, Fifth Floor, Boston, MA 02110-1301, USA */
27 
28 #ifndef _mysql_time_h_
29 #define _mysql_time_h_
30 
31 /*
32   Time declarations shared between the server and client API:
33   you should not add anything to this header unless it's used
34   (and hence should be visible) in mysql.h.
35   If you're looking for a place to add new time-related declaration,
36   it's most likely my_time.h. See also "C API Handling of Date
37   and Time Values" chapter in documentation.
38 */
39 
40 enum enum_mysql_timestamp_type
41 {
42   MYSQL_TIMESTAMP_NONE= -2, MYSQL_TIMESTAMP_ERROR= -1,
43   MYSQL_TIMESTAMP_DATE= 0, MYSQL_TIMESTAMP_DATETIME= 1, MYSQL_TIMESTAMP_TIME= 2
44 };
45 
46 
47 /*
48   Structure which is used to represent datetime values inside MySQL.
49 
50   We assume that values in this structure are normalized, i.e. year <= 9999,
51   month <= 12, day <= 31, hour <= 23, hour <= 59, hour <= 59. Many functions
52   in server such as my_system_gmt_sec() or make_time() family of functions
53   rely on this (actually now usage of make_*() family relies on a bit weaker
54   restriction). Also functions that produce MYSQL_TIME as result ensure this.
55   There is one exception to this rule though if this structure holds time
56   value (time_type == MYSQL_TIMESTAMP_TIME) days and hour member can hold
57   bigger values.
58 */
59 typedef struct st_mysql_time
60 {
61   unsigned int  year, month, day, hour, minute, second;
62   unsigned long second_part;  /**< microseconds */
63   my_bool       neg;
64   enum enum_mysql_timestamp_type time_type;
65 } MYSQL_TIME;
66 
67 #endif /* _mysql_time_h_ */
68