SQLAlchemy 2.0.47__cp313-cp313t-win32.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (274) hide show
  1. sqlalchemy/__init__.py +283 -0
  2. sqlalchemy/connectors/__init__.py +18 -0
  3. sqlalchemy/connectors/aioodbc.py +184 -0
  4. sqlalchemy/connectors/asyncio.py +429 -0
  5. sqlalchemy/connectors/pyodbc.py +250 -0
  6. sqlalchemy/cyextension/__init__.py +6 -0
  7. sqlalchemy/cyextension/collections.cp313t-win32.pyd +0 -0
  8. sqlalchemy/cyextension/collections.pyx +409 -0
  9. sqlalchemy/cyextension/immutabledict.cp313t-win32.pyd +0 -0
  10. sqlalchemy/cyextension/immutabledict.pxd +8 -0
  11. sqlalchemy/cyextension/immutabledict.pyx +133 -0
  12. sqlalchemy/cyextension/processors.cp313t-win32.pyd +0 -0
  13. sqlalchemy/cyextension/processors.pyx +68 -0
  14. sqlalchemy/cyextension/resultproxy.cp313t-win32.pyd +0 -0
  15. sqlalchemy/cyextension/resultproxy.pyx +102 -0
  16. sqlalchemy/cyextension/util.cp313t-win32.pyd +0 -0
  17. sqlalchemy/cyextension/util.pyx +90 -0
  18. sqlalchemy/dialects/__init__.py +62 -0
  19. sqlalchemy/dialects/_typing.py +30 -0
  20. sqlalchemy/dialects/mssql/__init__.py +88 -0
  21. sqlalchemy/dialects/mssql/aioodbc.py +63 -0
  22. sqlalchemy/dialects/mssql/base.py +4093 -0
  23. sqlalchemy/dialects/mssql/information_schema.py +285 -0
  24. sqlalchemy/dialects/mssql/json.py +129 -0
  25. sqlalchemy/dialects/mssql/provision.py +185 -0
  26. sqlalchemy/dialects/mssql/pymssql.py +126 -0
  27. sqlalchemy/dialects/mssql/pyodbc.py +760 -0
  28. sqlalchemy/dialects/mysql/__init__.py +104 -0
  29. sqlalchemy/dialects/mysql/aiomysql.py +250 -0
  30. sqlalchemy/dialects/mysql/asyncmy.py +231 -0
  31. sqlalchemy/dialects/mysql/base.py +3949 -0
  32. sqlalchemy/dialects/mysql/cymysql.py +106 -0
  33. sqlalchemy/dialects/mysql/dml.py +225 -0
  34. sqlalchemy/dialects/mysql/enumerated.py +282 -0
  35. sqlalchemy/dialects/mysql/expression.py +146 -0
  36. sqlalchemy/dialects/mysql/json.py +91 -0
  37. sqlalchemy/dialects/mysql/mariadb.py +72 -0
  38. sqlalchemy/dialects/mysql/mariadbconnector.py +322 -0
  39. sqlalchemy/dialects/mysql/mysqlconnector.py +302 -0
  40. sqlalchemy/dialects/mysql/mysqldb.py +314 -0
  41. sqlalchemy/dialects/mysql/provision.py +153 -0
  42. sqlalchemy/dialects/mysql/pymysql.py +158 -0
  43. sqlalchemy/dialects/mysql/pyodbc.py +157 -0
  44. sqlalchemy/dialects/mysql/reflection.py +727 -0
  45. sqlalchemy/dialects/mysql/reserved_words.py +570 -0
  46. sqlalchemy/dialects/mysql/types.py +835 -0
  47. sqlalchemy/dialects/oracle/__init__.py +81 -0
  48. sqlalchemy/dialects/oracle/base.py +3802 -0
  49. sqlalchemy/dialects/oracle/cx_oracle.py +1555 -0
  50. sqlalchemy/dialects/oracle/dictionary.py +507 -0
  51. sqlalchemy/dialects/oracle/oracledb.py +941 -0
  52. sqlalchemy/dialects/oracle/provision.py +297 -0
  53. sqlalchemy/dialects/oracle/types.py +316 -0
  54. sqlalchemy/dialects/oracle/vector.py +365 -0
  55. sqlalchemy/dialects/postgresql/__init__.py +167 -0
  56. sqlalchemy/dialects/postgresql/_psycopg_common.py +189 -0
  57. sqlalchemy/dialects/postgresql/array.py +519 -0
  58. sqlalchemy/dialects/postgresql/asyncpg.py +1284 -0
  59. sqlalchemy/dialects/postgresql/base.py +5378 -0
  60. sqlalchemy/dialects/postgresql/dml.py +339 -0
  61. sqlalchemy/dialects/postgresql/ext.py +540 -0
  62. sqlalchemy/dialects/postgresql/hstore.py +406 -0
  63. sqlalchemy/dialects/postgresql/json.py +404 -0
  64. sqlalchemy/dialects/postgresql/named_types.py +524 -0
  65. sqlalchemy/dialects/postgresql/operators.py +129 -0
  66. sqlalchemy/dialects/postgresql/pg8000.py +669 -0
  67. sqlalchemy/dialects/postgresql/pg_catalog.py +326 -0
  68. sqlalchemy/dialects/postgresql/provision.py +183 -0
  69. sqlalchemy/dialects/postgresql/psycopg.py +862 -0
  70. sqlalchemy/dialects/postgresql/psycopg2.py +892 -0
  71. sqlalchemy/dialects/postgresql/psycopg2cffi.py +61 -0
  72. sqlalchemy/dialects/postgresql/ranges.py +1031 -0
  73. sqlalchemy/dialects/postgresql/types.py +313 -0
  74. sqlalchemy/dialects/sqlite/__init__.py +57 -0
  75. sqlalchemy/dialects/sqlite/aiosqlite.py +482 -0
  76. sqlalchemy/dialects/sqlite/base.py +3056 -0
  77. sqlalchemy/dialects/sqlite/dml.py +263 -0
  78. sqlalchemy/dialects/sqlite/json.py +92 -0
  79. sqlalchemy/dialects/sqlite/provision.py +229 -0
  80. sqlalchemy/dialects/sqlite/pysqlcipher.py +157 -0
  81. sqlalchemy/dialects/sqlite/pysqlite.py +756 -0
  82. sqlalchemy/dialects/type_migration_guidelines.txt +145 -0
  83. sqlalchemy/engine/__init__.py +62 -0
  84. sqlalchemy/engine/_py_processors.py +136 -0
  85. sqlalchemy/engine/_py_row.py +128 -0
  86. sqlalchemy/engine/_py_util.py +74 -0
  87. sqlalchemy/engine/base.py +3390 -0
  88. sqlalchemy/engine/characteristics.py +155 -0
  89. sqlalchemy/engine/create.py +893 -0
  90. sqlalchemy/engine/cursor.py +2298 -0
  91. sqlalchemy/engine/default.py +2394 -0
  92. sqlalchemy/engine/events.py +965 -0
  93. sqlalchemy/engine/interfaces.py +3471 -0
  94. sqlalchemy/engine/mock.py +134 -0
  95. sqlalchemy/engine/processors.py +61 -0
  96. sqlalchemy/engine/reflection.py +2102 -0
  97. sqlalchemy/engine/result.py +2399 -0
  98. sqlalchemy/engine/row.py +400 -0
  99. sqlalchemy/engine/strategies.py +16 -0
  100. sqlalchemy/engine/url.py +924 -0
  101. sqlalchemy/engine/util.py +167 -0
  102. sqlalchemy/event/__init__.py +26 -0
  103. sqlalchemy/event/api.py +220 -0
  104. sqlalchemy/event/attr.py +676 -0
  105. sqlalchemy/event/base.py +472 -0
  106. sqlalchemy/event/legacy.py +258 -0
  107. sqlalchemy/event/registry.py +390 -0
  108. sqlalchemy/events.py +17 -0
  109. sqlalchemy/exc.py +832 -0
  110. sqlalchemy/ext/__init__.py +11 -0
  111. sqlalchemy/ext/associationproxy.py +2027 -0
  112. sqlalchemy/ext/asyncio/__init__.py +25 -0
  113. sqlalchemy/ext/asyncio/base.py +281 -0
  114. sqlalchemy/ext/asyncio/engine.py +1471 -0
  115. sqlalchemy/ext/asyncio/exc.py +21 -0
  116. sqlalchemy/ext/asyncio/result.py +965 -0
  117. sqlalchemy/ext/asyncio/scoping.py +1599 -0
  118. sqlalchemy/ext/asyncio/session.py +1947 -0
  119. sqlalchemy/ext/automap.py +1701 -0
  120. sqlalchemy/ext/baked.py +570 -0
  121. sqlalchemy/ext/compiler.py +600 -0
  122. sqlalchemy/ext/declarative/__init__.py +65 -0
  123. sqlalchemy/ext/declarative/extensions.py +564 -0
  124. sqlalchemy/ext/horizontal_shard.py +478 -0
  125. sqlalchemy/ext/hybrid.py +1535 -0
  126. sqlalchemy/ext/indexable.py +364 -0
  127. sqlalchemy/ext/instrumentation.py +450 -0
  128. sqlalchemy/ext/mutable.py +1085 -0
  129. sqlalchemy/ext/mypy/__init__.py +6 -0
  130. sqlalchemy/ext/mypy/apply.py +324 -0
  131. sqlalchemy/ext/mypy/decl_class.py +515 -0
  132. sqlalchemy/ext/mypy/infer.py +590 -0
  133. sqlalchemy/ext/mypy/names.py +335 -0
  134. sqlalchemy/ext/mypy/plugin.py +303 -0
  135. sqlalchemy/ext/mypy/util.py +357 -0
  136. sqlalchemy/ext/orderinglist.py +439 -0
  137. sqlalchemy/ext/serializer.py +185 -0
  138. sqlalchemy/future/__init__.py +16 -0
  139. sqlalchemy/future/engine.py +15 -0
  140. sqlalchemy/inspection.py +174 -0
  141. sqlalchemy/log.py +288 -0
  142. sqlalchemy/orm/__init__.py +171 -0
  143. sqlalchemy/orm/_orm_constructors.py +2661 -0
  144. sqlalchemy/orm/_typing.py +179 -0
  145. sqlalchemy/orm/attributes.py +2845 -0
  146. sqlalchemy/orm/base.py +971 -0
  147. sqlalchemy/orm/bulk_persistence.py +2135 -0
  148. sqlalchemy/orm/clsregistry.py +571 -0
  149. sqlalchemy/orm/collections.py +1627 -0
  150. sqlalchemy/orm/context.py +3334 -0
  151. sqlalchemy/orm/decl_api.py +2004 -0
  152. sqlalchemy/orm/decl_base.py +2192 -0
  153. sqlalchemy/orm/dependency.py +1302 -0
  154. sqlalchemy/orm/descriptor_props.py +1092 -0
  155. sqlalchemy/orm/dynamic.py +300 -0
  156. sqlalchemy/orm/evaluator.py +379 -0
  157. sqlalchemy/orm/events.py +3252 -0
  158. sqlalchemy/orm/exc.py +237 -0
  159. sqlalchemy/orm/identity.py +302 -0
  160. sqlalchemy/orm/instrumentation.py +754 -0
  161. sqlalchemy/orm/interfaces.py +1496 -0
  162. sqlalchemy/orm/loading.py +1686 -0
  163. sqlalchemy/orm/mapped_collection.py +557 -0
  164. sqlalchemy/orm/mapper.py +4444 -0
  165. sqlalchemy/orm/path_registry.py +809 -0
  166. sqlalchemy/orm/persistence.py +1788 -0
  167. sqlalchemy/orm/properties.py +935 -0
  168. sqlalchemy/orm/query.py +3459 -0
  169. sqlalchemy/orm/relationships.py +3508 -0
  170. sqlalchemy/orm/scoping.py +2148 -0
  171. sqlalchemy/orm/session.py +5280 -0
  172. sqlalchemy/orm/state.py +1168 -0
  173. sqlalchemy/orm/state_changes.py +196 -0
  174. sqlalchemy/orm/strategies.py +3470 -0
  175. sqlalchemy/orm/strategy_options.py +2568 -0
  176. sqlalchemy/orm/sync.py +164 -0
  177. sqlalchemy/orm/unitofwork.py +796 -0
  178. sqlalchemy/orm/util.py +2403 -0
  179. sqlalchemy/orm/writeonly.py +674 -0
  180. sqlalchemy/pool/__init__.py +44 -0
  181. sqlalchemy/pool/base.py +1524 -0
  182. sqlalchemy/pool/events.py +375 -0
  183. sqlalchemy/pool/impl.py +588 -0
  184. sqlalchemy/py.typed +0 -0
  185. sqlalchemy/schema.py +69 -0
  186. sqlalchemy/sql/__init__.py +145 -0
  187. sqlalchemy/sql/_dml_constructors.py +132 -0
  188. sqlalchemy/sql/_elements_constructors.py +1872 -0
  189. sqlalchemy/sql/_orm_types.py +20 -0
  190. sqlalchemy/sql/_py_util.py +75 -0
  191. sqlalchemy/sql/_selectable_constructors.py +763 -0
  192. sqlalchemy/sql/_typing.py +482 -0
  193. sqlalchemy/sql/annotation.py +587 -0
  194. sqlalchemy/sql/base.py +2293 -0
  195. sqlalchemy/sql/cache_key.py +1057 -0
  196. sqlalchemy/sql/coercions.py +1404 -0
  197. sqlalchemy/sql/compiler.py +8081 -0
  198. sqlalchemy/sql/crud.py +1752 -0
  199. sqlalchemy/sql/ddl.py +1444 -0
  200. sqlalchemy/sql/default_comparator.py +551 -0
  201. sqlalchemy/sql/dml.py +1850 -0
  202. sqlalchemy/sql/elements.py +5589 -0
  203. sqlalchemy/sql/events.py +458 -0
  204. sqlalchemy/sql/expression.py +159 -0
  205. sqlalchemy/sql/functions.py +2158 -0
  206. sqlalchemy/sql/lambdas.py +1442 -0
  207. sqlalchemy/sql/naming.py +209 -0
  208. sqlalchemy/sql/operators.py +2623 -0
  209. sqlalchemy/sql/roles.py +323 -0
  210. sqlalchemy/sql/schema.py +6222 -0
  211. sqlalchemy/sql/selectable.py +7265 -0
  212. sqlalchemy/sql/sqltypes.py +3930 -0
  213. sqlalchemy/sql/traversals.py +1024 -0
  214. sqlalchemy/sql/type_api.py +2368 -0
  215. sqlalchemy/sql/util.py +1485 -0
  216. sqlalchemy/sql/visitors.py +1164 -0
  217. sqlalchemy/testing/__init__.py +96 -0
  218. sqlalchemy/testing/assertions.py +994 -0
  219. sqlalchemy/testing/assertsql.py +520 -0
  220. sqlalchemy/testing/asyncio.py +135 -0
  221. sqlalchemy/testing/config.py +434 -0
  222. sqlalchemy/testing/engines.py +483 -0
  223. sqlalchemy/testing/entities.py +117 -0
  224. sqlalchemy/testing/exclusions.py +476 -0
  225. sqlalchemy/testing/fixtures/__init__.py +28 -0
  226. sqlalchemy/testing/fixtures/base.py +384 -0
  227. sqlalchemy/testing/fixtures/mypy.py +332 -0
  228. sqlalchemy/testing/fixtures/orm.py +227 -0
  229. sqlalchemy/testing/fixtures/sql.py +482 -0
  230. sqlalchemy/testing/pickleable.py +155 -0
  231. sqlalchemy/testing/plugin/__init__.py +6 -0
  232. sqlalchemy/testing/plugin/bootstrap.py +51 -0
  233. sqlalchemy/testing/plugin/plugin_base.py +828 -0
  234. sqlalchemy/testing/plugin/pytestplugin.py +892 -0
  235. sqlalchemy/testing/profiling.py +329 -0
  236. sqlalchemy/testing/provision.py +603 -0
  237. sqlalchemy/testing/requirements.py +1945 -0
  238. sqlalchemy/testing/schema.py +198 -0
  239. sqlalchemy/testing/suite/__init__.py +19 -0
  240. sqlalchemy/testing/suite/test_cte.py +237 -0
  241. sqlalchemy/testing/suite/test_ddl.py +389 -0
  242. sqlalchemy/testing/suite/test_deprecations.py +153 -0
  243. sqlalchemy/testing/suite/test_dialect.py +776 -0
  244. sqlalchemy/testing/suite/test_insert.py +630 -0
  245. sqlalchemy/testing/suite/test_reflection.py +3557 -0
  246. sqlalchemy/testing/suite/test_results.py +504 -0
  247. sqlalchemy/testing/suite/test_rowcount.py +258 -0
  248. sqlalchemy/testing/suite/test_select.py +2010 -0
  249. sqlalchemy/testing/suite/test_sequence.py +317 -0
  250. sqlalchemy/testing/suite/test_types.py +2147 -0
  251. sqlalchemy/testing/suite/test_unicode_ddl.py +189 -0
  252. sqlalchemy/testing/suite/test_update_delete.py +139 -0
  253. sqlalchemy/testing/util.py +535 -0
  254. sqlalchemy/testing/warnings.py +52 -0
  255. sqlalchemy/types.py +74 -0
  256. sqlalchemy/util/__init__.py +162 -0
  257. sqlalchemy/util/_collections.py +712 -0
  258. sqlalchemy/util/_concurrency_py3k.py +288 -0
  259. sqlalchemy/util/_has_cy.py +40 -0
  260. sqlalchemy/util/_py_collections.py +541 -0
  261. sqlalchemy/util/compat.py +421 -0
  262. sqlalchemy/util/concurrency.py +110 -0
  263. sqlalchemy/util/deprecations.py +401 -0
  264. sqlalchemy/util/langhelpers.py +2203 -0
  265. sqlalchemy/util/preloaded.py +150 -0
  266. sqlalchemy/util/queue.py +322 -0
  267. sqlalchemy/util/tool_support.py +201 -0
  268. sqlalchemy/util/topological.py +120 -0
  269. sqlalchemy/util/typing.py +734 -0
  270. sqlalchemy-2.0.47.dist-info/METADATA +243 -0
  271. sqlalchemy-2.0.47.dist-info/RECORD +274 -0
  272. sqlalchemy-2.0.47.dist-info/WHEEL +5 -0
  273. sqlalchemy-2.0.47.dist-info/licenses/LICENSE +19 -0
  274. sqlalchemy-2.0.47.dist-info/top_level.txt +1 -0
@@ -0,0 +1,835 @@
1
+ # dialects/mysql/types.py
2
+ # Copyright (C) 2005-2026 the SQLAlchemy authors and contributors
3
+ # <see AUTHORS file>
4
+ #
5
+ # This module is part of SQLAlchemy and is released under
6
+ # the MIT License: https://www.opensource.org/licenses/mit-license.php
7
+ from __future__ import annotations
8
+
9
+ import datetime
10
+ import decimal
11
+ from typing import Any
12
+ from typing import Iterable
13
+ from typing import Optional
14
+ from typing import TYPE_CHECKING
15
+ from typing import Union
16
+
17
+ from ... import exc
18
+ from ... import util
19
+ from ...sql import sqltypes
20
+
21
+ if TYPE_CHECKING:
22
+ from .base import MySQLDialect
23
+ from ...engine.interfaces import Dialect
24
+ from ...sql.type_api import _BindProcessorType
25
+ from ...sql.type_api import _ResultProcessorType
26
+ from ...sql.type_api import TypeEngine
27
+
28
+
29
+ class _NumericType:
30
+ """Base for MySQL numeric types.
31
+
32
+ This is the base both for NUMERIC as well as INTEGER, hence
33
+ it's a mixin.
34
+
35
+ """
36
+
37
+ def __init__(
38
+ self, unsigned: bool = False, zerofill: bool = False, **kw: Any
39
+ ):
40
+ self.unsigned = unsigned
41
+ self.zerofill = zerofill
42
+ super().__init__(**kw)
43
+
44
+ def __repr__(self) -> str:
45
+ return util.generic_repr(
46
+ self, to_inspect=[_NumericType, sqltypes.Numeric]
47
+ )
48
+
49
+
50
+ class _FloatType(_NumericType, sqltypes.Float[Union[decimal.Decimal, float]]):
51
+ def __init__(
52
+ self,
53
+ precision: Optional[int] = None,
54
+ scale: Optional[int] = None,
55
+ asdecimal: bool = True,
56
+ **kw: Any,
57
+ ):
58
+ if isinstance(self, (REAL, DOUBLE)) and (
59
+ (precision is None and scale is not None)
60
+ or (precision is not None and scale is None)
61
+ ):
62
+ raise exc.ArgumentError(
63
+ "You must specify both precision and scale or omit "
64
+ "both altogether."
65
+ )
66
+ super().__init__(precision=precision, asdecimal=asdecimal, **kw)
67
+ self.scale = scale
68
+
69
+ def __repr__(self) -> str:
70
+ return util.generic_repr(
71
+ self, to_inspect=[_FloatType, _NumericType, sqltypes.Float]
72
+ )
73
+
74
+
75
+ class _IntegerType(_NumericType, sqltypes.Integer):
76
+ def __init__(self, display_width: Optional[int] = None, **kw: Any):
77
+ self.display_width = display_width
78
+ super().__init__(**kw)
79
+
80
+ def __repr__(self) -> str:
81
+ return util.generic_repr(
82
+ self, to_inspect=[_IntegerType, _NumericType, sqltypes.Integer]
83
+ )
84
+
85
+
86
+ class _StringType(sqltypes.String):
87
+ """Base for MySQL string types."""
88
+
89
+ def __init__(
90
+ self,
91
+ charset: Optional[str] = None,
92
+ collation: Optional[str] = None,
93
+ ascii: bool = False, # noqa
94
+ binary: bool = False,
95
+ unicode: bool = False,
96
+ national: bool = False,
97
+ **kw: Any,
98
+ ):
99
+ self.charset = charset
100
+
101
+ # allow collate= or collation=
102
+ kw.setdefault("collation", kw.pop("collate", collation))
103
+
104
+ self.ascii = ascii
105
+ self.unicode = unicode
106
+ self.binary = binary
107
+ self.national = national
108
+ super().__init__(**kw)
109
+
110
+ def __repr__(self) -> str:
111
+ return util.generic_repr(
112
+ self, to_inspect=[_StringType, sqltypes.String]
113
+ )
114
+
115
+
116
+ class _MatchType(
117
+ sqltypes.Float[Union[decimal.Decimal, float]], sqltypes.MatchType
118
+ ):
119
+ def __init__(self, **kw: Any):
120
+ # TODO: float arguments?
121
+ sqltypes.Float.__init__(self) # type: ignore[arg-type]
122
+ sqltypes.MatchType.__init__(self)
123
+
124
+
125
+ class NUMERIC(_NumericType, sqltypes.NUMERIC[Union[decimal.Decimal, float]]):
126
+ """MySQL NUMERIC type."""
127
+
128
+ __visit_name__ = "NUMERIC"
129
+
130
+ def __init__(
131
+ self,
132
+ precision: Optional[int] = None,
133
+ scale: Optional[int] = None,
134
+ asdecimal: bool = True,
135
+ **kw: Any,
136
+ ):
137
+ """Construct a NUMERIC.
138
+
139
+ :param precision: Total digits in this number. If scale and precision
140
+ are both None, values are stored to limits allowed by the server.
141
+
142
+ :param scale: The number of digits after the decimal point.
143
+
144
+ :param unsigned: a boolean, optional.
145
+
146
+ :param zerofill: Optional. If true, values will be stored as strings
147
+ left-padded with zeros. Note that this does not effect the values
148
+ returned by the underlying database API, which continue to be
149
+ numeric.
150
+
151
+ """
152
+ super().__init__(
153
+ precision=precision, scale=scale, asdecimal=asdecimal, **kw
154
+ )
155
+
156
+
157
+ class DECIMAL(_NumericType, sqltypes.DECIMAL[Union[decimal.Decimal, float]]):
158
+ """MySQL DECIMAL type."""
159
+
160
+ __visit_name__ = "DECIMAL"
161
+
162
+ def __init__(
163
+ self,
164
+ precision: Optional[int] = None,
165
+ scale: Optional[int] = None,
166
+ asdecimal: bool = True,
167
+ **kw: Any,
168
+ ):
169
+ """Construct a DECIMAL.
170
+
171
+ :param precision: Total digits in this number. If scale and precision
172
+ are both None, values are stored to limits allowed by the server.
173
+
174
+ :param scale: The number of digits after the decimal point.
175
+
176
+ :param unsigned: a boolean, optional.
177
+
178
+ :param zerofill: Optional. If true, values will be stored as strings
179
+ left-padded with zeros. Note that this does not effect the values
180
+ returned by the underlying database API, which continue to be
181
+ numeric.
182
+
183
+ """
184
+ super().__init__(
185
+ precision=precision, scale=scale, asdecimal=asdecimal, **kw
186
+ )
187
+
188
+
189
+ class DOUBLE(_FloatType, sqltypes.DOUBLE[Union[decimal.Decimal, float]]):
190
+ """MySQL DOUBLE type."""
191
+
192
+ __visit_name__ = "DOUBLE"
193
+
194
+ def __init__(
195
+ self,
196
+ precision: Optional[int] = None,
197
+ scale: Optional[int] = None,
198
+ asdecimal: bool = True,
199
+ **kw: Any,
200
+ ):
201
+ """Construct a DOUBLE.
202
+
203
+ .. note::
204
+
205
+ The :class:`.DOUBLE` type by default converts from float
206
+ to Decimal, using a truncation that defaults to 10 digits.
207
+ Specify either ``scale=n`` or ``decimal_return_scale=n`` in order
208
+ to change this scale, or ``asdecimal=False`` to return values
209
+ directly as Python floating points.
210
+
211
+ :param precision: Total digits in this number. If scale and precision
212
+ are both None, values are stored to limits allowed by the server.
213
+
214
+ :param scale: The number of digits after the decimal point.
215
+
216
+ :param unsigned: a boolean, optional.
217
+
218
+ :param zerofill: Optional. If true, values will be stored as strings
219
+ left-padded with zeros. Note that this does not effect the values
220
+ returned by the underlying database API, which continue to be
221
+ numeric.
222
+
223
+ """
224
+ super().__init__(
225
+ precision=precision, scale=scale, asdecimal=asdecimal, **kw
226
+ )
227
+
228
+
229
+ class REAL(_FloatType, sqltypes.REAL[Union[decimal.Decimal, float]]):
230
+ """MySQL REAL type."""
231
+
232
+ __visit_name__ = "REAL"
233
+
234
+ def __init__(
235
+ self,
236
+ precision: Optional[int] = None,
237
+ scale: Optional[int] = None,
238
+ asdecimal: bool = True,
239
+ **kw: Any,
240
+ ):
241
+ """Construct a REAL.
242
+
243
+ .. note::
244
+
245
+ The :class:`.REAL` type by default converts from float
246
+ to Decimal, using a truncation that defaults to 10 digits.
247
+ Specify either ``scale=n`` or ``decimal_return_scale=n`` in order
248
+ to change this scale, or ``asdecimal=False`` to return values
249
+ directly as Python floating points.
250
+
251
+ :param precision: Total digits in this number. If scale and precision
252
+ are both None, values are stored to limits allowed by the server.
253
+
254
+ :param scale: The number of digits after the decimal point.
255
+
256
+ :param unsigned: a boolean, optional.
257
+
258
+ :param zerofill: Optional. If true, values will be stored as strings
259
+ left-padded with zeros. Note that this does not effect the values
260
+ returned by the underlying database API, which continue to be
261
+ numeric.
262
+
263
+ """
264
+ super().__init__(
265
+ precision=precision, scale=scale, asdecimal=asdecimal, **kw
266
+ )
267
+
268
+
269
+ class FLOAT(_FloatType, sqltypes.FLOAT[Union[decimal.Decimal, float]]):
270
+ """MySQL FLOAT type."""
271
+
272
+ __visit_name__ = "FLOAT"
273
+
274
+ def __init__(
275
+ self,
276
+ precision: Optional[int] = None,
277
+ scale: Optional[int] = None,
278
+ asdecimal: bool = False,
279
+ **kw: Any,
280
+ ):
281
+ """Construct a FLOAT.
282
+
283
+ :param precision: Total digits in this number. If scale and precision
284
+ are both None, values are stored to limits allowed by the server.
285
+
286
+ :param scale: The number of digits after the decimal point.
287
+
288
+ :param unsigned: a boolean, optional.
289
+
290
+ :param zerofill: Optional. If true, values will be stored as strings
291
+ left-padded with zeros. Note that this does not effect the values
292
+ returned by the underlying database API, which continue to be
293
+ numeric.
294
+
295
+ """
296
+ super().__init__(
297
+ precision=precision, scale=scale, asdecimal=asdecimal, **kw
298
+ )
299
+
300
+ def bind_processor(
301
+ self, dialect: Dialect
302
+ ) -> Optional[_BindProcessorType[Union[decimal.Decimal, float]]]:
303
+ return None
304
+
305
+
306
+ class INTEGER(_IntegerType, sqltypes.INTEGER):
307
+ """MySQL INTEGER type."""
308
+
309
+ __visit_name__ = "INTEGER"
310
+
311
+ def __init__(self, display_width: Optional[int] = None, **kw: Any):
312
+ """Construct an INTEGER.
313
+
314
+ :param display_width: Optional, maximum display width for this number.
315
+
316
+ :param unsigned: a boolean, optional.
317
+
318
+ :param zerofill: Optional. If true, values will be stored as strings
319
+ left-padded with zeros. Note that this does not effect the values
320
+ returned by the underlying database API, which continue to be
321
+ numeric.
322
+
323
+ """
324
+ super().__init__(display_width=display_width, **kw)
325
+
326
+
327
+ class BIGINT(_IntegerType, sqltypes.BIGINT):
328
+ """MySQL BIGINTEGER type."""
329
+
330
+ __visit_name__ = "BIGINT"
331
+
332
+ def __init__(self, display_width: Optional[int] = None, **kw: Any):
333
+ """Construct a BIGINTEGER.
334
+
335
+ :param display_width: Optional, maximum display width for this number.
336
+
337
+ :param unsigned: a boolean, optional.
338
+
339
+ :param zerofill: Optional. If true, values will be stored as strings
340
+ left-padded with zeros. Note that this does not effect the values
341
+ returned by the underlying database API, which continue to be
342
+ numeric.
343
+
344
+ """
345
+ super().__init__(display_width=display_width, **kw)
346
+
347
+
348
+ class MEDIUMINT(_IntegerType):
349
+ """MySQL MEDIUMINTEGER type."""
350
+
351
+ __visit_name__ = "MEDIUMINT"
352
+
353
+ def __init__(self, display_width: Optional[int] = None, **kw: Any):
354
+ """Construct a MEDIUMINTEGER
355
+
356
+ :param display_width: Optional, maximum display width for this number.
357
+
358
+ :param unsigned: a boolean, optional.
359
+
360
+ :param zerofill: Optional. If true, values will be stored as strings
361
+ left-padded with zeros. Note that this does not effect the values
362
+ returned by the underlying database API, which continue to be
363
+ numeric.
364
+
365
+ """
366
+ super().__init__(display_width=display_width, **kw)
367
+
368
+
369
+ class TINYINT(_IntegerType):
370
+ """MySQL TINYINT type."""
371
+
372
+ __visit_name__ = "TINYINT"
373
+
374
+ def __init__(self, display_width: Optional[int] = None, **kw: Any):
375
+ """Construct a TINYINT.
376
+
377
+ :param display_width: Optional, maximum display width for this number.
378
+
379
+ :param unsigned: a boolean, optional.
380
+
381
+ :param zerofill: Optional. If true, values will be stored as strings
382
+ left-padded with zeros. Note that this does not effect the values
383
+ returned by the underlying database API, which continue to be
384
+ numeric.
385
+
386
+ """
387
+ super().__init__(display_width=display_width, **kw)
388
+
389
+ def _compare_type_affinity(self, other: TypeEngine[Any]) -> bool:
390
+ return (
391
+ self._type_affinity is other._type_affinity
392
+ or other._type_affinity is sqltypes.Boolean
393
+ )
394
+
395
+
396
+ class SMALLINT(_IntegerType, sqltypes.SMALLINT):
397
+ """MySQL SMALLINTEGER type."""
398
+
399
+ __visit_name__ = "SMALLINT"
400
+
401
+ def __init__(self, display_width: Optional[int] = None, **kw: Any):
402
+ """Construct a SMALLINTEGER.
403
+
404
+ :param display_width: Optional, maximum display width for this number.
405
+
406
+ :param unsigned: a boolean, optional.
407
+
408
+ :param zerofill: Optional. If true, values will be stored as strings
409
+ left-padded with zeros. Note that this does not effect the values
410
+ returned by the underlying database API, which continue to be
411
+ numeric.
412
+
413
+ """
414
+ super().__init__(display_width=display_width, **kw)
415
+
416
+
417
+ class BIT(sqltypes.TypeEngine[Any]):
418
+ """MySQL BIT type.
419
+
420
+ This type is for MySQL 5.0.3 or greater for MyISAM, and 5.0.5 or greater
421
+ for MyISAM, MEMORY, InnoDB and BDB. For older versions, use a
422
+ MSTinyInteger() type.
423
+
424
+ """
425
+
426
+ __visit_name__ = "BIT"
427
+
428
+ def __init__(self, length: Optional[int] = None):
429
+ """Construct a BIT.
430
+
431
+ :param length: Optional, number of bits.
432
+
433
+ """
434
+ self.length = length
435
+
436
+ def result_processor(
437
+ self, dialect: MySQLDialect, coltype: object # type: ignore[override]
438
+ ) -> Optional[_ResultProcessorType[Any]]:
439
+ """Convert a MySQL's 64 bit, variable length binary string to a
440
+ long."""
441
+
442
+ if dialect.supports_native_bit:
443
+ return None
444
+
445
+ def process(value: Optional[Iterable[int]]) -> Optional[int]:
446
+ if value is not None:
447
+ v = 0
448
+ for i in value:
449
+ v = v << 8 | i
450
+ return v
451
+ return value
452
+
453
+ return process
454
+
455
+
456
+ class TIME(sqltypes.TIME):
457
+ """MySQL TIME type."""
458
+
459
+ __visit_name__ = "TIME"
460
+
461
+ def __init__(self, timezone: bool = False, fsp: Optional[int] = None):
462
+ """Construct a MySQL TIME type.
463
+
464
+ :param timezone: not used by the MySQL dialect.
465
+ :param fsp: fractional seconds precision value.
466
+ MySQL 5.6 supports storage of fractional seconds;
467
+ this parameter will be used when emitting DDL
468
+ for the TIME type.
469
+
470
+ .. note::
471
+
472
+ DBAPI driver support for fractional seconds may
473
+ be limited; current support includes
474
+ MySQL Connector/Python.
475
+
476
+ """
477
+ super().__init__(timezone=timezone)
478
+ self.fsp = fsp
479
+
480
+ def result_processor(
481
+ self, dialect: Dialect, coltype: object
482
+ ) -> _ResultProcessorType[datetime.time]:
483
+ time = datetime.time
484
+
485
+ def process(value: Any) -> Optional[datetime.time]:
486
+ # convert from a timedelta value
487
+ if value is not None:
488
+ microseconds = value.microseconds
489
+ seconds = value.seconds
490
+ minutes = seconds // 60
491
+ return time(
492
+ minutes // 60,
493
+ minutes % 60,
494
+ seconds - minutes * 60,
495
+ microsecond=microseconds,
496
+ )
497
+ else:
498
+ return None
499
+
500
+ return process
501
+
502
+
503
+ class TIMESTAMP(sqltypes.TIMESTAMP):
504
+ """MySQL TIMESTAMP type."""
505
+
506
+ __visit_name__ = "TIMESTAMP"
507
+
508
+ def __init__(self, timezone: bool = False, fsp: Optional[int] = None):
509
+ """Construct a MySQL TIMESTAMP type.
510
+
511
+ :param timezone: not used by the MySQL dialect.
512
+ :param fsp: fractional seconds precision value.
513
+ MySQL 5.6.4 supports storage of fractional seconds;
514
+ this parameter will be used when emitting DDL
515
+ for the TIMESTAMP type.
516
+
517
+ .. note::
518
+
519
+ DBAPI driver support for fractional seconds may
520
+ be limited; current support includes
521
+ MySQL Connector/Python.
522
+
523
+ """
524
+ super().__init__(timezone=timezone)
525
+ self.fsp = fsp
526
+
527
+
528
+ class DATETIME(sqltypes.DATETIME):
529
+ """MySQL DATETIME type."""
530
+
531
+ __visit_name__ = "DATETIME"
532
+
533
+ def __init__(self, timezone: bool = False, fsp: Optional[int] = None):
534
+ """Construct a MySQL DATETIME type.
535
+
536
+ :param timezone: not used by the MySQL dialect.
537
+ :param fsp: fractional seconds precision value.
538
+ MySQL 5.6.4 supports storage of fractional seconds;
539
+ this parameter will be used when emitting DDL
540
+ for the DATETIME type.
541
+
542
+ .. note::
543
+
544
+ DBAPI driver support for fractional seconds may
545
+ be limited; current support includes
546
+ MySQL Connector/Python.
547
+
548
+ """
549
+ super().__init__(timezone=timezone)
550
+ self.fsp = fsp
551
+
552
+
553
+ class YEAR(sqltypes.TypeEngine[Any]):
554
+ """MySQL YEAR type, for single byte storage of years 1901-2155."""
555
+
556
+ __visit_name__ = "YEAR"
557
+
558
+ def __init__(self, display_width: Optional[int] = None):
559
+ self.display_width = display_width
560
+
561
+
562
+ class TEXT(_StringType, sqltypes.TEXT):
563
+ """MySQL TEXT type, for character storage encoded up to 2^16 bytes."""
564
+
565
+ __visit_name__ = "TEXT"
566
+
567
+ def __init__(self, length: Optional[int] = None, **kw: Any):
568
+ """Construct a TEXT.
569
+
570
+ :param length: Optional, if provided the server may optimize storage
571
+ by substituting the smallest TEXT type sufficient to store
572
+ ``length`` bytes of characters.
573
+
574
+ :param charset: Optional, a column-level character set for this string
575
+ value. Takes precedence to 'ascii' or 'unicode' short-hand.
576
+
577
+ :param collation: Optional, a column-level collation for this string
578
+ value. Takes precedence to 'binary' short-hand.
579
+
580
+ :param ascii: Defaults to False: short-hand for the ``latin1``
581
+ character set, generates ASCII in schema.
582
+
583
+ :param unicode: Defaults to False: short-hand for the ``ucs2``
584
+ character set, generates UNICODE in schema.
585
+
586
+ :param national: Optional. If true, use the server's configured
587
+ national character set.
588
+
589
+ :param binary: Defaults to False: short-hand, pick the binary
590
+ collation type that matches the column's character set. Generates
591
+ BINARY in schema. This does not affect the type of data stored,
592
+ only the collation of character data.
593
+
594
+ """
595
+ super().__init__(length=length, **kw)
596
+
597
+
598
+ class TINYTEXT(_StringType):
599
+ """MySQL TINYTEXT type, for character storage encoded up to 2^8 bytes."""
600
+
601
+ __visit_name__ = "TINYTEXT"
602
+
603
+ def __init__(self, **kwargs: Any):
604
+ """Construct a TINYTEXT.
605
+
606
+ :param charset: Optional, a column-level character set for this string
607
+ value. Takes precedence to 'ascii' or 'unicode' short-hand.
608
+
609
+ :param collation: Optional, a column-level collation for this string
610
+ value. Takes precedence to 'binary' short-hand.
611
+
612
+ :param ascii: Defaults to False: short-hand for the ``latin1``
613
+ character set, generates ASCII in schema.
614
+
615
+ :param unicode: Defaults to False: short-hand for the ``ucs2``
616
+ character set, generates UNICODE in schema.
617
+
618
+ :param national: Optional. If true, use the server's configured
619
+ national character set.
620
+
621
+ :param binary: Defaults to False: short-hand, pick the binary
622
+ collation type that matches the column's character set. Generates
623
+ BINARY in schema. This does not affect the type of data stored,
624
+ only the collation of character data.
625
+
626
+ """
627
+ super().__init__(**kwargs)
628
+
629
+
630
+ class MEDIUMTEXT(_StringType):
631
+ """MySQL MEDIUMTEXT type, for character storage encoded up
632
+ to 2^24 bytes."""
633
+
634
+ __visit_name__ = "MEDIUMTEXT"
635
+
636
+ def __init__(self, **kwargs: Any):
637
+ """Construct a MEDIUMTEXT.
638
+
639
+ :param charset: Optional, a column-level character set for this string
640
+ value. Takes precedence to 'ascii' or 'unicode' short-hand.
641
+
642
+ :param collation: Optional, a column-level collation for this string
643
+ value. Takes precedence to 'binary' short-hand.
644
+
645
+ :param ascii: Defaults to False: short-hand for the ``latin1``
646
+ character set, generates ASCII in schema.
647
+
648
+ :param unicode: Defaults to False: short-hand for the ``ucs2``
649
+ character set, generates UNICODE in schema.
650
+
651
+ :param national: Optional. If true, use the server's configured
652
+ national character set.
653
+
654
+ :param binary: Defaults to False: short-hand, pick the binary
655
+ collation type that matches the column's character set. Generates
656
+ BINARY in schema. This does not affect the type of data stored,
657
+ only the collation of character data.
658
+
659
+ """
660
+ super().__init__(**kwargs)
661
+
662
+
663
+ class LONGTEXT(_StringType):
664
+ """MySQL LONGTEXT type, for character storage encoded up to 2^32 bytes."""
665
+
666
+ __visit_name__ = "LONGTEXT"
667
+
668
+ def __init__(self, **kwargs: Any):
669
+ """Construct a LONGTEXT.
670
+
671
+ :param charset: Optional, a column-level character set for this string
672
+ value. Takes precedence to 'ascii' or 'unicode' short-hand.
673
+
674
+ :param collation: Optional, a column-level collation for this string
675
+ value. Takes precedence to 'binary' short-hand.
676
+
677
+ :param ascii: Defaults to False: short-hand for the ``latin1``
678
+ character set, generates ASCII in schema.
679
+
680
+ :param unicode: Defaults to False: short-hand for the ``ucs2``
681
+ character set, generates UNICODE in schema.
682
+
683
+ :param national: Optional. If true, use the server's configured
684
+ national character set.
685
+
686
+ :param binary: Defaults to False: short-hand, pick the binary
687
+ collation type that matches the column's character set. Generates
688
+ BINARY in schema. This does not affect the type of data stored,
689
+ only the collation of character data.
690
+
691
+ """
692
+ super().__init__(**kwargs)
693
+
694
+
695
+ class VARCHAR(_StringType, sqltypes.VARCHAR):
696
+ """MySQL VARCHAR type, for variable-length character data."""
697
+
698
+ __visit_name__ = "VARCHAR"
699
+
700
+ def __init__(self, length: Optional[int] = None, **kwargs: Any) -> None:
701
+ """Construct a VARCHAR.
702
+
703
+ :param charset: Optional, a column-level character set for this string
704
+ value. Takes precedence to 'ascii' or 'unicode' short-hand.
705
+
706
+ :param collation: Optional, a column-level collation for this string
707
+ value. Takes precedence to 'binary' short-hand.
708
+
709
+ :param ascii: Defaults to False: short-hand for the ``latin1``
710
+ character set, generates ASCII in schema.
711
+
712
+ :param unicode: Defaults to False: short-hand for the ``ucs2``
713
+ character set, generates UNICODE in schema.
714
+
715
+ :param national: Optional. If true, use the server's configured
716
+ national character set.
717
+
718
+ :param binary: Defaults to False: short-hand, pick the binary
719
+ collation type that matches the column's character set. Generates
720
+ BINARY in schema. This does not affect the type of data stored,
721
+ only the collation of character data.
722
+
723
+ """
724
+ super().__init__(length=length, **kwargs)
725
+
726
+
727
+ class CHAR(_StringType, sqltypes.CHAR):
728
+ """MySQL CHAR type, for fixed-length character data."""
729
+
730
+ __visit_name__ = "CHAR"
731
+
732
+ def __init__(self, length: Optional[int] = None, **kwargs: Any):
733
+ """Construct a CHAR.
734
+
735
+ :param length: Maximum data length, in characters.
736
+
737
+ :param binary: Optional, use the default binary collation for the
738
+ national character set. This does not affect the type of data
739
+ stored, use a BINARY type for binary data.
740
+
741
+ :param collation: Optional, request a particular collation. Must be
742
+ compatible with the national character set.
743
+
744
+ """
745
+ super().__init__(length=length, **kwargs)
746
+
747
+ @classmethod
748
+ def _adapt_string_for_cast(cls, type_: sqltypes.String) -> sqltypes.CHAR:
749
+ # copy the given string type into a CHAR
750
+ # for the purposes of rendering a CAST expression
751
+ type_ = sqltypes.to_instance(type_)
752
+ if isinstance(type_, sqltypes.CHAR):
753
+ return type_
754
+ elif isinstance(type_, _StringType):
755
+ return CHAR(
756
+ length=type_.length,
757
+ charset=type_.charset,
758
+ collation=type_.collation,
759
+ ascii=type_.ascii,
760
+ binary=type_.binary,
761
+ unicode=type_.unicode,
762
+ national=False, # not supported in CAST
763
+ )
764
+ else:
765
+ return CHAR(length=type_.length)
766
+
767
+
768
+ class NVARCHAR(_StringType, sqltypes.NVARCHAR):
769
+ """MySQL NVARCHAR type.
770
+
771
+ For variable-length character data in the server's configured national
772
+ character set.
773
+ """
774
+
775
+ __visit_name__ = "NVARCHAR"
776
+
777
+ def __init__(self, length: Optional[int] = None, **kwargs: Any):
778
+ """Construct an NVARCHAR.
779
+
780
+ :param length: Maximum data length, in characters.
781
+
782
+ :param binary: Optional, use the default binary collation for the
783
+ national character set. This does not affect the type of data
784
+ stored, use a BINARY type for binary data.
785
+
786
+ :param collation: Optional, request a particular collation. Must be
787
+ compatible with the national character set.
788
+
789
+ """
790
+ kwargs["national"] = True
791
+ super().__init__(length=length, **kwargs)
792
+
793
+
794
+ class NCHAR(_StringType, sqltypes.NCHAR):
795
+ """MySQL NCHAR type.
796
+
797
+ For fixed-length character data in the server's configured national
798
+ character set.
799
+ """
800
+
801
+ __visit_name__ = "NCHAR"
802
+
803
+ def __init__(self, length: Optional[int] = None, **kwargs: Any):
804
+ """Construct an NCHAR.
805
+
806
+ :param length: Maximum data length, in characters.
807
+
808
+ :param binary: Optional, use the default binary collation for the
809
+ national character set. This does not affect the type of data
810
+ stored, use a BINARY type for binary data.
811
+
812
+ :param collation: Optional, request a particular collation. Must be
813
+ compatible with the national character set.
814
+
815
+ """
816
+ kwargs["national"] = True
817
+ super().__init__(length=length, **kwargs)
818
+
819
+
820
+ class TINYBLOB(sqltypes._Binary):
821
+ """MySQL TINYBLOB type, for binary data up to 2^8 bytes."""
822
+
823
+ __visit_name__ = "TINYBLOB"
824
+
825
+
826
+ class MEDIUMBLOB(sqltypes._Binary):
827
+ """MySQL MEDIUMBLOB type, for binary data up to 2^24 bytes."""
828
+
829
+ __visit_name__ = "MEDIUMBLOB"
830
+
831
+
832
+ class LONGBLOB(sqltypes._Binary):
833
+ """MySQL LONGBLOB type, for binary data up to 2^32 bytes."""
834
+
835
+ __visit_name__ = "LONGBLOB"