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
|
<?php
/**
* PHPPgAdmin v6.0.0-RC2
*/
namespace PHPPgAdmin\Database\Traits;
/**
* Common trait for column manipulation.
*/
trait ColumnTrait
{
/**
* Add a new column to a table.
*
* @param string $table The table to add to
* @param string $column The name of the new column
* @param string $type The type of the column
* @param bool $array True if array type, false otherwise
* @param int $length The optional size of the column (ie. 30 for varchar(30))
* @param bool $notnull True if NOT NULL, false otherwise
* @param mixed $default The default for the column. '' for none.
* @param string $comment comment for the column
*
* @return array first element is 0 on success, second element is sql sentence
*/
public function addColumn($table, $column, $type, $array, $length, $notnull, $default, $comment)
{
$f_schema = $this->_schema;
$this->fieldClean($f_schema);
$this->fieldClean($table);
$this->fieldClean($column);
$this->clean($type);
$this->clean($length);
if ($length == '') {
$sql = "ALTER TABLE \"{$f_schema}\".\"{$table}\" ADD COLUMN \"{$column}\" {$type}";
} else {
switch ($type) {
// Have to account for weird placing of length for with/without
// time zone types
case 'timestamp with time zone':
case 'timestamp without time zone':
$qual = substr($type, 9);
$sql = "ALTER TABLE \"{$f_schema}\".\"{$table}\" ADD COLUMN \"{$column}\" timestamp({$length}){$qual}";
break;
case 'time with time zone':
case 'time without time zone':
$qual = substr($type, 4);
$sql = "ALTER TABLE \"{$f_schema}\".\"{$table}\" ADD COLUMN \"{$column}\" time({$length}){$qual}";
break;
default:
$sql = "ALTER TABLE \"{$f_schema}\".\"{$table}\" ADD COLUMN \"{$column}\" {$type}({$length})";
}
}
// Add array qualifier, if requested
if ($array) {
$sql .= '[]';
}
// If we have advanced column adding, add the extra qualifiers
if ($this->hasCreateFieldWithConstraints()) {
// NOT NULL clause
if ($notnull) {
$sql .= ' NOT NULL';
}
// DEFAULT clause
if ($default != '') {
$sql .= ' DEFAULT '.$default;
}
}
$status = $this->beginTransaction();
if ($status != 0) {
return [-1, $sql];
}
$status = $this->execute($sql);
if ($status != 0) {
$this->rollbackTransaction();
return [-1, $sql];
}
$status = $this->setComment('COLUMN', $column, $table, $comment);
if ($status != 0) {
$this->rollbackTransaction();
return [-1, $sql];
}
$status = $this->endTransaction();
return [$status, $sql];
}
/**
* Alters a column in a table.
*
* @param string $table The table in which the column resides
* @param string $column The column to alter
* @param string $name The new name for the column
* @param bool $notnull (boolean) True if not null, false otherwise
* @param bool $oldnotnull (boolean) True if column is already not null, false otherwise
* @param mixed $default The new default for the column
* @param mixed $olddefault The old default for the column
* @param string $type The new type for the column
* @param int $length The optional size of the column (ie. 30 for varchar(30))
* @param bool $array True if array type, false otherwise
* @param string $oldtype The old type for the column
* @param string $comment Comment for the column
*
* @return array 0 success
*/
public function alterColumn(
$table,
$column,
$name,
$notnull,
$oldnotnull,
$default,
$olddefault,
$type,
$length,
$array,
$oldtype,
$comment
) {
// Begin transaction
$status = $this->beginTransaction();
$sql = '';
$sqlrename = '';
if ($status != 0) {
$this->rollbackTransaction();
return [-6, $sql];
}
// Rename the column, if it has been changed
if ($column != $name) {
list($status, $sqlrename) = $this->renameColumn($table, $column, $name);
if ($status != 0) {
$this->rollbackTransaction();
return [-4, $sql];
}
}
$f_schema = $this->_schema;
$this->fieldClean($f_schema);
$this->fieldClean($name);
$this->fieldClean($table);
$this->fieldClean($column);
$toAlter = [];
// Create the command for changing nullability
if ($notnull != $oldnotnull) {
$toAlter[] = "ALTER COLUMN \"{$name}\" ".($notnull ? 'SET' : 'DROP').' NOT NULL';
}
// Add default, if it has changed
if ($default != $olddefault) {
if ($default == '') {
$toAlter[] = "ALTER COLUMN \"{$name}\" DROP DEFAULT";
} else {
$toAlter[] = "ALTER COLUMN \"{$name}\" SET DEFAULT {$default}";
}
}
// Add type, if it has changed
if ($length == '') {
$ftype = $type;
} else {
switch ($type) {
// Have to account for weird placing of length for with/without
// time zone types
case 'timestamp with time zone':
case 'timestamp without time zone':
$qual = substr($type, 9);
$ftype = "timestamp({$length}){$qual}";
break;
case 'time with time zone':
case 'time without time zone':
$qual = substr($type, 4);
$ftype = "time({$length}){$qual}";
break;
default:
$ftype = "{$type}({$length})";
}
}
// Add array qualifier, if requested
if ($array) {
$ftype .= '[]';
}
if ($ftype != $oldtype) {
$toAlter[] = "ALTER COLUMN \"{$name}\" TYPE {$ftype}";
}
// Attempt to process the batch alteration, if anything has been changed
if (!empty($toAlter)) {
// Initialise an empty SQL string
$sql = "ALTER TABLE \"{$f_schema}\".\"{$table}\" "
.implode(',', $toAlter);
$status = $this->execute($sql);
if ($status != 0) {
$this->rollbackTransaction();
return [-1, $sql];
}
}
// Update the comment on the column
$status = $this->setComment('COLUMN', $name, $table, $comment);
if ($status != 0) {
$this->rollbackTransaction();
return [-5, $sql];
}
return [$this->endTransaction(), $sqlrename.'<br>'.$sql];
}
/**
* Renames a column in a table.
*
* @param string $table The table containing the column to be renamed
* @param string $column The column to be renamed
* @param string $newName The new name for the column
*
* @return array [0 if operation was successful, sql of sentence]
*/
public function renameColumn($table, $column, $newName)
{
$f_schema = $this->_schema;
$this->fieldClean($f_schema);
$this->fieldClean($table);
$this->fieldClean($column);
$this->fieldClean($newName);
$sql = "ALTER TABLE \"{$f_schema}\".\"{$table}\" RENAME COLUMN \"{$column}\" TO \"{$newName}\"";
$status = $this->execute($sql);
return [$status, $sql];
}
/**
* Sets default value of a column.
*
* @param string $table The table from which to drop
* @param string $column The column name to set
* @param mixed $default The new default value
*
* @return int 0 if operation was successful
*/
public function setColumnDefault($table, $column, $default)
{
$f_schema = $this->_schema;
$this->fieldClean($f_schema);
$this->fieldClean($table);
$this->fieldClean($column);
$sql = "ALTER TABLE \"{$f_schema}\".\"{$table}\" ALTER COLUMN \"{$column}\" SET DEFAULT {$default}";
return $this->execute($sql);
}
/**
* Sets whether or not a column can contain NULLs.
*
* @param string $table The table that contains the column
* @param string $column The column to alter
* @param bool $state True to set null, false to set not null
*
* @return int 0 if operation was successful
*/
public function setColumnNull($table, $column, $state)
{
$f_schema = $this->_schema;
$this->fieldClean($f_schema);
$this->fieldClean($table);
$this->fieldClean($column);
$sql = "ALTER TABLE \"{$f_schema}\".\"{$table}\" ALTER COLUMN \"{$column}\" ".($state ? 'DROP' : 'SET').' NOT NULL';
return $this->execute($sql);
}
/**
* Drops a column from a table.
*
* @param string $table The table from which to drop a column
* @param string $column The column to be dropped
* @param bool $cascade True to cascade drop, false to restrict
*
* @return array [int status, string sql sentence]
*/
public function dropColumn($table, $column, $cascade)
{
$f_schema = $this->_schema;
$this->fieldClean($f_schema);
$this->fieldClean($table);
$this->fieldClean($column);
$sql = "ALTER TABLE \"{$f_schema}\".\"{$table}\" DROP COLUMN \"{$column}\"";
if ($cascade) {
$sql .= ' CASCADE';
}
$status = $this->execute($sql);
return [$status, $sql];
}
/**
* Drops default value of a column.
*
* @param string $table The table from which to drop
* @param string $column The column name to drop default
*
* @return int 0 if operation was successful
*/
public function dropColumnDefault($table, $column)
{
$f_schema = $this->_schema;
$this->fieldClean($f_schema);
$this->fieldClean($table);
$this->fieldClean($column);
$sql = "ALTER TABLE \"{$f_schema}\".\"{$table}\" ALTER COLUMN \"{$column}\" DROP DEFAULT";
return $this->execute($sql);
}
abstract public function fieldClean(&$str);
abstract public function beginTransaction();
abstract public function rollbackTransaction();
abstract public function endTransaction();
abstract public function execute($sql);
abstract public function setComment($obj_type, $obj_name, $table, $comment, $basetype = null);
abstract public function selectSet($sql);
abstract public function clean(&$str);
abstract public function phpBool($parameter);
abstract public function hasCreateTableLikeWithConstraints();
abstract public function hasCreateTableLikeWithIndexes();
abstract public function hasTablespaces();
abstract public function delete($table, $conditions, $schema = '');
abstract public function fieldArrayClean(&$arr);
abstract public function hasCreateFieldWithConstraints();
abstract public function getAttributeNames($table, $atts);
}
|