-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
SqlserverSchema.php
466 lines (418 loc) · 15.1 KB
/
SqlserverSchema.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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Database\Schema;
use Cake\Database\Schema\Table;
/**
* Schema management/reflection features for SQLServer.
*/
class SqlserverSchema extends BaseSchema
{
const DEFAULT_SCHEMA_NAME = 'dbo';
/**
* {@inheritDoc}
*/
public function listTablesSql($config)
{
$sql = 'SELECT TABLE_NAME
FROM INFORMATION_SCHEMA.TABLES
WHERE TABLE_SCHEMA = ?
ORDER BY TABLE_NAME';
$schema = empty($config['schema']) ? static::DEFAULT_SCHEMA_NAME : $config['schema'];
return [$sql, [$schema]];
}
/**
* {@inheritDoc}
*/
public function describeColumnSql($tableName, $config)
{
$sql = "SELECT DISTINCT
AC.name AS [name],
TY.name AS [type],
AC.max_length AS [char_length],
AC.precision AS [precision],
AC.scale AS [scale],
AC.is_identity AS [autoincrement],
AC.is_nullable AS [null],
OBJECT_DEFINITION(AC.default_object_id) AS [default]
FROM sys.[tables] T
INNER JOIN sys.[schemas] S ON S.[schema_id] = T.[schema_id]
INNER JOIN sys.[all_columns] AC ON T.[object_id] = AC.[object_id]
INNER JOIN sys.[types] TY ON TY.[user_type_id] = AC.[user_type_id]
WHERE T.[name] = ? AND S.[name] = ?";
$schema = empty($config['schema']) ? static::DEFAULT_SCHEMA_NAME : $config['schema'];
return [$sql, [$tableName, $schema]];
}
/**
* Convert a column definition to the abstract types.
*
* The returned type will be a type that
* Cake\Database\Type can handle.
*
* @param string $col The column type
* @param int|null $length the column length
* @param int|null $precision The column precision
* @param int|null $scale The column scale
* @return array Array of column information.
* @link http://technet.microsoft.com/en-us/library/ms187752.aspx
*/
protected function _convertColumn($col, $length = null, $precision = null, $scale = null)
{
$col = strtolower($col);
if (in_array($col, ['date', 'time'])) {
return ['type' => $col, 'length' => null];
}
if (strpos($col, 'datetime') !== false) {
return ['type' => 'timestamp', 'length' => null];
}
if ($col === 'int' || $col === 'integer') {
return ['type' => 'integer', 'length' => $precision ?: 10];
}
if ($col === 'bigint') {
return ['type' => 'biginteger', 'length' => $precision ?: 20];
}
if ($col === 'smallint') {
return ['type' => 'integer', 'length' => $precision ?: 5];
}
if ($col === 'tinyint') {
return ['type' => 'integer', 'length' => $precision ?: 3];
}
if ($col === 'bit') {
return ['type' => 'boolean', 'length' => null];
}
if (strpos($col, 'numeric') !== false ||
strpos($col, 'money') !== false ||
strpos($col, 'decimal') !== false
) {
return ['type' => 'decimal', 'length' => $precision, 'precision' => $scale];
}
if ($col === 'real' || $col === 'float') {
return ['type' => 'float', 'length' => null];
}
if (strpos($col, 'varchar') !== false && $length < 0) {
return ['type' => 'text', 'length' => null];
}
if (strpos($col, 'varchar') !== false) {
return ['type' => 'string', 'length' => $length ?: 255];
}
if (strpos($col, 'char') !== false) {
return ['type' => 'string', 'fixed' => true, 'length' => $length];
}
if (strpos($col, 'text') !== false) {
return ['type' => 'text', 'length' => null];
}
if ($col === 'image' || strpos($col, 'binary')) {
return ['type' => 'binary', 'length' => null];
}
if ($col === 'uniqueidentifier') {
return ['type' => 'uuid'];
}
return ['type' => 'text', 'length' => null];
}
/**
* {@inheritDoc}
*/
public function convertColumnDescription(Table $table, $row)
{
$field = $this->_convertColumn(
$row['type'],
$row['char_length'],
$row['precision'],
$row['scale']
);
if (!empty($row['default'])) {
$row['default'] = trim($row['default'], '()');
}
if (!empty($row['autoincrement'])) {
$field['autoIncrement'] = true;
}
if ($field['type'] === 'boolean') {
$row['default'] = (int)$row['default'];
}
$field += [
'null' => $row['null'] === '1' ? true : false,
'default' => $row['default'],
];
$table->addColumn($row['name'], $field);
}
/**
* {@inheritDoc}
*/
public function describeIndexSql($tableName, $config)
{
$sql = "SELECT
I.[name] AS [index_name],
IC.[index_column_id] AS [index_order],
AC.[name] AS [column_name],
I.[is_unique], I.[is_primary_key],
I.[is_unique_constraint]
FROM sys.[tables] AS T
INNER JOIN sys.[schemas] S ON S.[schema_id] = T.[schema_id]
INNER JOIN sys.[indexes] I ON T.[object_id] = I.[object_id]
INNER JOIN sys.[index_columns] IC ON I.[object_id] = IC.[object_id] AND I.[index_id] = IC.[index_id]
INNER JOIN sys.[all_columns] AC ON T.[object_id] = AC.[object_id] AND IC.[column_id] = AC.[column_id]
WHERE T.[is_ms_shipped] = 0 AND I.[type_desc] <> 'HEAP' AND T.[name] = ? AND S.[name] = ?
ORDER BY I.[index_id], IC.[index_column_id]";
$schema = empty($config['schema']) ? static::DEFAULT_SCHEMA_NAME : $config['schema'];
return [$sql, [$tableName, $schema]];
}
/**
* {@inheritDoc}
*/
public function convertIndexDescription(Table $table, $row)
{
$type = Table::INDEX_INDEX;
$name = $row['index_name'];
if ($row['is_primary_key']) {
$name = $type = Table::CONSTRAINT_PRIMARY;
}
if ($row['is_unique_constraint'] && $type === Table::INDEX_INDEX) {
$type = Table::CONSTRAINT_UNIQUE;
}
if ($type === Table::INDEX_INDEX) {
$existing = $table->index($name);
} else {
$existing = $table->constraint($name);
}
$columns = [$row['column_name']];
if (!empty($existing)) {
$columns = array_merge($existing['columns'], $columns);
}
if ($type === Table::CONSTRAINT_PRIMARY || $type === Table::CONSTRAINT_UNIQUE) {
$table->addConstraint($name, [
'type' => $type,
'columns' => $columns
]);
return;
}
$table->addIndex($name, [
'type' => $type,
'columns' => $columns
]);
}
/**
* {@inheritDoc}
*/
public function describeForeignKeySql($tableName, $config)
{
$sql = "SELECT FK.[name] AS [foreign_key_name], FK.[delete_referential_action_desc] AS [delete_type],
FK.[update_referential_action_desc] AS [update_type], C.name AS [column], RT.name AS [reference_table],
RC.name AS [reference_column]
FROM sys.foreign_keys FK
INNER JOIN sys.foreign_key_columns FKC ON FKC.constraint_object_id = FK.object_id
INNER JOIN sys.tables T ON T.object_id = FKC.parent_object_id
INNER JOIN sys.tables RT ON RT.object_id = FKC.referenced_object_id
INNER JOIN sys.schemas S ON S.schema_id = T.schema_id AND S.schema_id = RT.schema_id
INNER JOIN sys.columns C ON C.column_id = FKC.parent_column_id AND C.object_id = FKC.parent_object_id
INNER JOIN sys.columns RC ON RC.column_id = FKC.referenced_column_id AND RC.object_id = FKC.referenced_object_id
WHERE FK.is_ms_shipped = 0 AND T.name = ? AND S.name = ?";
$schema = empty($config['schema']) ? static::DEFAULT_SCHEMA_NAME : $config['schema'];
return [$sql, [$tableName, $schema]];
}
/**
* {@inheritDoc}
*/
public function convertForeignKeyDescription(Table $table, $row)
{
$data = [
'type' => Table::CONSTRAINT_FOREIGN,
'columns' => [$row['column']],
'references' => [$row['reference_table'], $row['reference_column']],
'update' => $this->_convertOnClause($row['update_type']),
'delete' => $this->_convertOnClause($row['delete_type']),
];
$name = $row['foreign_key_name'];
$table->addConstraint($name, $data);
}
/**
* {@inheritDoc}
*/
protected function _foreignOnClause($on)
{
$parent = parent::_foreignOnClause($on);
return $parent === 'RESTRICT' ? parent::_foreignOnClause(Table::ACTION_SET_NULL) : $parent;
}
/**
* {@inheritDoc}
*/
protected function _convertOnClause($clause)
{
switch ($clause) {
case 'NO_ACTION':
return Table::ACTION_NO_ACTION;
case 'CASCADE':
return Table::ACTION_CASCADE;
case 'SET_NULL':
return Table::ACTION_SET_NULL;
case 'SET_DEFAULT':
return Table::ACTION_SET_DEFAULT;
}
return Table::ACTION_SET_NULL;
}
/**
* {@inheritDoc}
*/
public function columnSql(Table $table, $name)
{
$data = $table->column($name);
$out = $this->_driver->quoteIdentifier($name);
$typeMap = [
'integer' => ' INTEGER',
'biginteger' => ' BIGINT',
'boolean' => ' BIT',
'binary' => ' VARBINARY(MAX)',
'float' => ' FLOAT',
'decimal' => ' DECIMAL',
'text' => ' NVARCHAR(MAX)',
'date' => ' DATE',
'time' => ' TIME',
'datetime' => ' DATETIME',
'timestamp' => ' DATETIME',
'uuid' => ' UNIQUEIDENTIFIER'
];
if (isset($typeMap[$data['type']])) {
$out .= $typeMap[$data['type']];
}
if ($data['type'] === 'integer' || $data['type'] === 'biginteger') {
if ([$name] === $table->primaryKey() || $data['autoIncrement'] === true) {
unset($data['null'], $data['default']);
$out .= ' IDENTITY(1, 1)';
}
}
if ($data['type'] === 'string') {
$type = ' NVARCHAR';
if (!empty($data['fixed'])) {
$type = ' NCHAR';
}
if (!isset($data['length'])) {
$data['length'] = 255;
}
$out .= sprintf('%s(%d)', $type, $data['length']);
}
if ($data['type'] === 'float' && isset($data['precision'])) {
$out .= '(' . (int)$data['precision'] . ')';
}
if ($data['type'] === 'decimal' &&
(isset($data['length']) || isset($data['precision']))
) {
$out .= '(' . (int)$data['length'] . ',' . (int)$data['precision'] . ')';
}
if (isset($data['null']) && $data['null'] === false) {
$out .= ' NOT NULL';
}
if (isset($data['null']) && $data['null'] === true) {
$out .= ' DEFAULT NULL';
unset($data['default']);
}
if (isset($data['default']) && $data['type'] !== 'datetime') {
$default = is_bool($data['default']) ? (int)$data['default'] : $this->_driver->schemaValue($data['default']);
$out .= ' DEFAULT ' . $default;
}
return $out;
}
/**
* {@inheritDoc}
*/
public function indexSql(Table $table, $name)
{
$data = $table->index($name);
$columns = array_map(
[$this->_driver, 'quoteIdentifier'],
$data['columns']
);
return sprintf(
'CREATE INDEX %s ON %s (%s)',
$this->_driver->quoteIdentifier($name),
$this->_driver->quoteIdentifier($table->name()),
implode(', ', $columns)
);
}
/**
* {@inheritDoc}
*/
public function constraintSql(Table $table, $name)
{
$data = $table->constraint($name);
$out = 'CONSTRAINT ' . $this->_driver->quoteIdentifier($name);
if ($data['type'] === Table::CONSTRAINT_PRIMARY) {
$out = 'PRIMARY KEY';
}
if ($data['type'] === Table::CONSTRAINT_UNIQUE) {
$out .= ' UNIQUE';
}
return $this->_keySql($out, $data);
}
/**
* Helper method for generating key SQL snippets.
*
* @param string $prefix The key prefix
* @param array $data Key data.
* @return string
*/
protected function _keySql($prefix, $data)
{
$columns = array_map(
[$this->_driver, 'quoteIdentifier'],
$data['columns']
);
if ($data['type'] === Table::CONSTRAINT_FOREIGN) {
return $prefix . sprintf(
' FOREIGN KEY (%s) REFERENCES %s (%s) ON UPDATE %s ON DELETE %s',
implode(', ', $columns),
$this->_driver->quoteIdentifier($data['references'][0]),
$this->_driver->quoteIdentifier($data['references'][1]),
$this->_foreignOnClause($data['update']),
$this->_foreignOnClause($data['delete'])
);
}
return $prefix . ' (' . implode(', ', $columns) . ')';
}
/**
* {@inheritDoc}
*/
public function createTableSql(Table $table, $columns, $constraints, $indexes)
{
$content = array_merge($columns, $constraints);
$content = implode(",\n", array_filter($content));
$tableName = $this->_driver->quoteIdentifier($table->name());
$out = [];
$out[] = sprintf("CREATE TABLE %s (\n%s\n)", $tableName, $content);
foreach ($indexes as $index) {
$out[] = $index;
}
return $out;
}
/**
* {@inheritDoc}
*/
public function truncateTableSql(Table $table)
{
$name = $this->_driver->quoteIdentifier($table->name());
$queries = [
sprintf('DELETE FROM %s', $name)
];
// Restart identity sequences
$pk = $table->primaryKey();
if (count($pk) === 1) {
$column = $table->column($pk[0]);
if (in_array($column['type'], ['integer', 'biginteger'])) {
$queries[] = sprintf(
'DBCC CHECKIDENT(%s, RESEED, 0)',
$name
);
}
}
return $queries;
}
}