mysql_time.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. /* Copyright (c) 2004, 2021, Oracle and/or its affiliates.
  2. This program is free software; you can redistribute it and/or modify
  3. it under the terms of the GNU General Public License, version 2.0,
  4. as published by the Free Software Foundation.
  5. This program is also distributed with certain software (including
  6. but not limited to OpenSSL) that is licensed under separate terms,
  7. as designated in a particular file or component or in included license
  8. documentation. The authors of MySQL hereby grant you an additional
  9. permission to link the program and your derivative works with the
  10. separately licensed software that they have included with MySQL.
  11. Without limiting anything contained in the foregoing, this file,
  12. which is part of C Driver for MySQL (Connector/C), is also subject to the
  13. Universal FOSS Exception, version 1.0, a copy of which can be found at
  14. http://oss.oracle.com/licenses/universal-foss-exception.
  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. You should have received a copy of the GNU General Public License
  20. along with this program; if not, write to the Free Software
  21. Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
  22. #ifndef _mysql_time_h_
  23. #define _mysql_time_h_
  24. /**
  25. @file include/mysql_time.h
  26. Time declarations shared between the server and client API:
  27. you should not add anything to this header unless it's used
  28. (and hence should be visible) in mysql.h.
  29. If you're looking for a place to add new time-related declaration,
  30. it's most likely my_time.h. See also "C API Handling of Date
  31. and Time Values" chapter in documentation.
  32. */
  33. // Do not not pull in the server header "my_inttypes.h" from client code.
  34. // IWYU pragma: no_include "my_inttypes.h"
  35. enum enum_mysql_timestamp_type {
  36. MYSQL_TIMESTAMP_NONE = -2,
  37. MYSQL_TIMESTAMP_ERROR = -1,
  38. /// Stores year, month and day components.
  39. MYSQL_TIMESTAMP_DATE = 0,
  40. /**
  41. Stores all date and time components.
  42. Value is in UTC for `TIMESTAMP` type.
  43. Value is in local time zone for `DATETIME` type.
  44. */
  45. MYSQL_TIMESTAMP_DATETIME = 1,
  46. /// Stores hour, minute, second and microsecond.
  47. MYSQL_TIMESTAMP_TIME = 2,
  48. /**
  49. A temporary type for `DATETIME` or `TIMESTAMP` types equipped with time
  50. zone information. After the time zone information is reconciled, the type is
  51. converted to MYSQL_TIMESTAMP_DATETIME.
  52. */
  53. MYSQL_TIMESTAMP_DATETIME_TZ = 3
  54. };
  55. /*
  56. Structure which is used to represent datetime values inside MySQL.
  57. We assume that values in this structure are normalized, i.e. year <= 9999,
  58. month <= 12, day <= 31, hour <= 23, hour <= 59, hour <= 59. Many functions
  59. in server such as my_system_gmt_sec() or make_time() family of functions
  60. rely on this (actually now usage of make_*() family relies on a bit weaker
  61. restriction). Also functions that produce MYSQL_TIME as result ensure this.
  62. There is one exception to this rule though if this structure holds time
  63. value (time_type == MYSQL_TIMESTAMP_TIME) days and hour member can hold
  64. bigger values.
  65. */
  66. typedef struct MYSQL_TIME {
  67. unsigned int year, month, day, hour, minute, second;
  68. unsigned long second_part; /**< microseconds */
  69. bool neg;
  70. enum enum_mysql_timestamp_type time_type;
  71. /// The time zone displacement, specified in seconds.
  72. int time_zone_displacement;
  73. } MYSQL_TIME;
  74. #endif /* _mysql_time_h_ */