This repository has been archived by the owner on Jan 24, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 19
/
MySQLColumn.php
268 lines (230 loc) · 7.48 KB
/
MySQLColumn.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
<?php
/**
* Spiral Framework.
*
* @license MIT
* @author Anton Titov (Wolfy-J)
*/
declare(strict_types=1);
namespace Spiral\Database\Driver\MySQL\Schema;
use Spiral\Database\Driver\DriverInterface;
use Spiral\Database\Exception\DefaultValueException;
use Spiral\Database\Injection\Fragment;
use Spiral\Database\Injection\FragmentInterface;
use Spiral\Database\Schema\AbstractColumn;
/**
* Attention! You can use only one timestamp or datetime with DATETIME_NOW setting! Thought, it will
* work on multiple fields with MySQL 5.6.6+ version.
*/
class MySQLColumn extends AbstractColumn
{
/**
* Default timestamp expression (driver specific).
*/
public const DATETIME_NOW = 'CURRENT_TIMESTAMP';
/**
* {@inheritdoc}
*/
protected $mapping = [
//Primary sequences
'primary' => [
'type' => 'int',
'size' => 11,
'autoIncrement' => true,
'nullable' => false,
],
'bigPrimary' => [
'type' => 'bigint',
'size' => 20,
'autoIncrement' => true,
'nullable' => false,
],
//Enum type (mapped via method)
'enum' => 'enum',
//Logical types
'boolean' => ['type' => 'tinyint', 'size' => 1],
//Integer types (size can always be changed with size method), longInteger has method alias
//bigInteger
'integer' => ['type' => 'int', 'size' => 11],
'tinyInteger' => ['type' => 'tinyint', 'size' => 4],
'bigInteger' => ['type' => 'bigint', 'size' => 20],
//String with specified length (mapped via method)
'string' => ['type' => 'varchar', 'size' => 255],
//Generic types
'text' => 'text',
'tinyText' => 'tinytext',
'longText' => 'longtext',
//Real types
'double' => 'double',
'float' => 'float',
//Decimal type (mapped via method)
'decimal' => 'decimal',
//Date and Time types
'datetime' => 'datetime',
'date' => 'date',
'time' => 'time',
'timestamp' => ['type' => 'timestamp', 'defaultValue' => null],
//Binary types
'binary' => 'blob',
'tinyBinary' => 'tinyblob',
'longBinary' => 'longblob',
//Additional types
'json' => 'text',
'uuid' => ['type' => 'varchar', 'size' => 36],
];
/**
* {@inheritdoc}
*/
protected $reverseMapping = [
'primary' => [['type' => 'int', 'autoIncrement' => true]],
'bigPrimary' => ['serial', ['type' => 'bigint', 'autoIncrement' => true]],
'enum' => ['enum'],
'boolean' => ['bool', 'boolean', ['type' => 'tinyint', 'size' => 1]],
'integer' => ['int', 'integer', 'smallint', 'mediumint'],
'tinyInteger' => ['tinyint'],
'bigInteger' => ['bigint'],
'string' => ['varchar', 'char'],
'text' => ['text', 'mediumtext'],
'tinyText' => ['tinytext'],
'longText' => ['longtext'],
'double' => ['double'],
'float' => ['float', 'real'],
'decimal' => ['decimal'],
'datetime' => ['datetime'],
'date' => ['date'],
'time' => ['time'],
'timestamp' => ['timestamp'],
'binary' => ['blob', 'binary', 'varbinary'],
'tinyBinary' => ['tinyblob'],
'longBinary' => ['longblob'],
];
/**
* List of types forbids default value set.
*
* @var array
*/
protected $forbiddenDefaults = [
'text',
'mediumtext',
'tinytext',
'longtext',
'blog',
'tinyblob',
'longblob',
];
/**
* Column is auto incremental.
*
* @var bool
*/
protected $autoIncrement = false;
/**
* {@inheritdoc}
*/
public function sqlStatement(DriverInterface $driver): string
{
$defaultValue = $this->defaultValue;
if (in_array($this->type, $this->forbiddenDefaults, true)) {
//Flushing default value for forbidden types
$this->defaultValue = null;
}
$statement = parent::sqlStatement($driver);
$this->defaultValue = $defaultValue;
if ($this->autoIncrement) {
return "{$statement} AUTO_INCREMENT";
}
return $statement;
}
/**
* @param string $table
* @param array $schema
* @param \DateTimeZone $timezone
* @return MySQLColumn
*/
public static function createInstance(
string $table,
array $schema,
\DateTimeZone $timezone = null
): self {
$column = new self($table, $schema['Field'], $timezone);
$column->type = $schema['Type'];
$column->nullable = strtolower($schema['Null']) === 'yes';
$column->defaultValue = $schema['Default'];
$column->autoIncrement = stripos($schema['Extra'], 'auto_increment') !== false;
if (
!preg_match(
'/^(?P<type>[a-z]+)(?:\((?P<options>[^\)]+)\))?/',
$column->type,
$matches
)
) {
//No extra definitions
return $column;
}
$column->type = $matches['type'];
$options = [];
if (!empty($matches['options'])) {
$options = explode(',', $matches['options']);
if (count($options) > 1) {
$column->precision = (int)$options[0];
$column->scale = (int)$options[1];
} else {
$column->size = (int)$options[0];
}
}
// since 8.0 database does not provide size for some of the columns
if ($column->size === 0) {
switch ($column->type) {
case 'int':
$column->size = 11;
break;
case 'bigint':
$column->size = 20;
break;
case 'tinyint':
if ($column->size !== 1) {
$column->size = 4;
}
}
}
//Fetching enum values
if ($options !== [] && $column->getAbstractType() === 'enum') {
$column->enumValues = array_map(
static function ($value) {
return trim($value, $value[0]);
},
$options
);
return $column;
}
//Default value conversions
if ($column->type === 'bit' && $column->hasDefaultValue()) {
//Cutting b\ and '
$column->defaultValue = new Fragment($column->defaultValue);
}
if (
$column->defaultValue === '0000-00-00 00:00:00'
&& $column->getAbstractType() === 'timestamp'
) {
//Normalizing default value for timestamps
$column->defaultValue = 0;
}
return $column;
}
/**
* Ensure that datetime fields are correctly formatted.
*
* @param string $type
* @param string $value
* @return string|FragmentInterface|\DateTime
*
* @throws DefaultValueException
*/
protected function formatDatetime(string $type, $value)
{
if ($value === 'current_timestamp()') {
$value = self::DATETIME_NOW;
}
return parent::formatDatetime($type, $value);
}
}