-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
FirebirdSchemaManager.php
641 lines (588 loc) · 26.4 KB
/
FirebirdSchemaManager.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
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.org>.
*/
namespace Doctrine\DBAL\Schema;
/**
* xxx
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @author Lorenzo Alberton <l.alberton@quipo.it> (PEAR MDB2 Interbase driver)
* @version $Revision$
* @since 2.0
*/
class FirebirdSchemaManager extends AbstractSchemaManager
{
/**
* list all tables in the current database
*
* @return array data array
*/
public function listTables($database = null)
{
$query = 'SELECT RDB$RELATION_NAME FROM RDB$RELATIONS WHERE RDB$SYSTEM_FLAG=0 AND RDB$VIEW_BLR IS NULL';
return $this->conn->fetchColumn($query);
}
/**
* list all fields in a tables in the current database
*
* @param string $table name of table that should be used in method
* @return mixed data array on success, a MDB2 error on failure
* @access public
*/
public function listTableFields($table)
{
$table = $this->_conn->quote(strtoupper($table), 'text');
$query = 'SELECT RDB$FIELD_NAME FROM RDB$RELATION_FIELDS WHERE UPPER(RDB$RELATION_NAME) = ' . $table;
return $this->_conn->fetchColumn($query);
}
/**
* list all users
*
* @return array data array containing all database users
*/
public function listUsers()
{
return $this->_conn->fetchColumn('SELECT DISTINCT RDB$USER FROM RDB$USER_PRIVILEGES');
}
/**
* list the views in the database
*
* @return array data array containing all database views
*/
public function listViews($database = null)
{
return $this->_conn->fetchColumn('SELECT DISTINCT RDB$VIEW_NAME FROM RDB$VIEW_RELATIONS');
}
/**
* list the views in the database that reference a given table
*
* @param string $table table for which all references views should be found
* @return array data array containing all views for given table
*/
public function listTableViews($table)
{
$query = 'SELECT DISTINCT RDB$VIEW_NAME FROM RDB$VIEW_RELATIONS';
$table = $this->_conn->quote(strtoupper($table), 'text');
$query .= ' WHERE UPPER(RDB$RELATION_NAME) = ' . $table;
return $this->_conn->fetchColumn($query);
}
/**
* list all functions in the current database
*
* @return array data array containing all availible functions
*/
public function listFunctions()
{
$query = 'SELECT RDB$FUNCTION_NAME FROM RDB$FUNCTIONS WHERE RDB$SYSTEM_FLAG IS NULL';
return $this->_conn->fetchColumn($query);
}
/**
* This function will be called to get all triggers of the
* current database ($this->_conn->getDatabase())
*
* @param string $table The name of the table from the
* previous database to query against.
* @return array data array containing all triggers for given table
*/
public function listTableTriggers($table)
{
$query = 'SELECT RDB$TRIGGER_NAME FROM RDB$TRIGGERS WHERE RDB$SYSTEM_FLAG IS NULL OR RDB$SYSTEM_FLAG = 0';
if ( ! is_null($table)) {
$table = $this->_conn->quote(strtoupper($table), 'text');
$query .= ' WHERE UPPER(RDB$RELATION_NAME) = ' . $table;
}
return $this->_conn->fetchColumn($query);
}
/**
* create a new database
*
* @param string $name name of the database that should be created
* @return void
*/
public function createDatabase($name)
{
throw \Doctrine\Common\DoctrineException::updateMe(
'PHP Interbase API does not support direct queries. You have to ' .
'create the db manually by using isql command or a similar program');
}
/**
* drop an existing database
*
* @param string $name name of the database that should be dropped
* @return void
*/
public function dropDatabase($name)
{
throw \Doctrine\Common\DoctrineException::updateMe(
'PHP Interbase API does not support direct queries. You have ' .
'to drop the db manually by using isql command or a similar program');
}
/**
* add an autoincrement sequence + trigger
*
* @param string $name name of the PK field
* @param string $table name of the table
* @param string $start start value for the sequence
* @return void
*/
public function _makeAutoincrement($name, $table, $start = null)
{
if (is_null($start)) {
$this->_conn->beginTransaction();
$query = 'SELECT MAX(' . $this->_conn->quoteIdentifier($name, true) . ') FROM ' . $this->_conn->quoteIdentifier($table, true);
$start = $this->_conn->fetchOne($query, 'integer');
++$start;
$result = $this->createSequence($table, $start);
$this->_conn->commit();
} else {
$result = $this->createSequence($table, $start);
}
$sequence_name = $this->_conn->formatter->getSequenceName($table);
$trigger_name = $this->_conn->quoteIdentifier($table . '_AUTOINCREMENT_PK', true);
$table = $this->_conn->quoteIdentifier($table, true);
$name = $this->_conn->quoteIdentifier($name, true);
$triggerSql = 'CREATE TRIGGER ' . $trigger_name . ' FOR ' . $table
. ' ACTIVE BEFORE INSERT POSITION 0 AS'
. ' BEGIN'
. ' IF (NEW.' . $name . ' IS NULL OR NEW.' . $name . ' = 0) THEN'
. ' NEW.' . $name . ' = GEN_ID('.$sequence_name.', 1)'
. ' END';
$result = $this->_conn->exec($triggerSql);
// TODO ? $this->_silentCommit();
return $result;
}
/**
* drop an existing autoincrement sequence + trigger
*
* @param string $table name of the table
* @return void
*/
public function _dropAutoincrement($table)
{
$result = $this->dropSequence($table);
//remove autoincrement trigger associated with the table
$table = $this->_conn->quote(strtoupper($table));
$triggerName = $this->_conn->quote(strtoupper($table) . '_AUTOINCREMENT_PK');
return $this->_conn->exec("DELETE FROM RDB\$TRIGGERS WHERE UPPER(RDB\$RELATION_NAME)=" . $table . " AND UPPER(RDB\$TRIGGER_NAME)=" . $triggerName);
}
/**
* create a new table
*
* @param string $name Name of the database that should be created
* @param array $fields Associative array that contains the definition of each field of the new table
* The indexes of the array entries are the names of the fields of the table an
* the array entry values are associative arrays like those that are meant to be
* passed with the field definitions to get[Type]Declaration() functions.
*
* Example
* array(
*
* 'id' => array(
* 'type' => 'integer',
* 'unsigned' => 1,
* 'notnull' => 1,
* 'default' => 0,
* ),
* 'name' => array(
* 'type' => 'text',
* 'length' => 12,
* ),
* 'description' => array(
* 'type' => 'text',
* 'length' => 12,
* )
* );
* @param array $options An associative array of table options:
*
* @return void
*/
public function createTable($name, array $fields, array $options = array()) {
parent::createTable($name, $fields, $options);
// TODO ? $this->_silentCommit();
foreach ($fields as $field_name => $field) {
if ( ! empty($field['autoincrement'])) {
//create PK constraint
$pk_definition = array(
'fields' => array($field_name => array()),
'primary' => true,
);
//$pk_name = $name.'_PK';
$pk_name = null;
$result = $this->createConstraint($name, $pk_name, $pk_definition);
//create autoincrement sequence + trigger
return $this->_makeAutoincrement($field_name, $name, 1);
}
}
}
/**
* Check if planned changes are supported
*
* @param string $name name of the database that should be dropped
* @return void
*/
public function checkSupportedChanges(&$changes)
{
foreach ($changes as $change_name => $change) {
switch ($change_name) {
case 'notnull':
throw \Doctrine\Common\DoctrineException::updateMe('it is not supported changes to field not null constraint');
case 'default':
throw \Doctrine\Common\DoctrineException::updateMe('it is not supported changes to field default value');
case 'length':
case 'unsigned':
case 'type':
case 'declaration':
case 'definition':
break;
default:
throw \Doctrine\Common\DoctrineException::updateMe('it is not supported change of type' . $change_name);
}
}
return true;
}
/**
* drop an existing table
*
* @param string $name name of the table that should be dropped
* @return mixed MDB2_OK on success, a MDB2 error on failure
* @access public
*/
public function dropTable($name)
{
$result = $this->_dropAutoincrement($name);
$result = parent::dropTable($name);
//$this->_silentCommit();
return $result;
}
/**
* alter an existing table
*
* @param string $name name of the table that is intended to be changed.
* @param array $changes associative array that contains the details of each type
* of change that is intended to be performed. The types of
* changes that are currently supported are defined as follows:
*
* name
*
* New name for the table.
*
* add
*
* Associative array with the names of fields to be added as
* indexes of the array. The value of each entry of the array
* should be set to another associative array with the properties
* of the fields to be added. The properties of the fields should
* be the same as defined by the Metabase parser.
*
*
* remove
*
* Associative array with the names of fields to be removed as indexes
* of the array. Currently the values assigned to each entry are ignored.
* An empty array should be used for future compatibility.
*
* rename
*
* Associative array with the names of fields to be renamed as indexes
* of the array. The value of each entry of the array should be set to
* another associative array with the entry named name with the new
* field name and the entry named Declaration that is expected to contain
* the portion of the field declaration already in DBMS specific SQL code
* as it is used in the CREATE TABLE statement.
*
* change
*
* Associative array with the names of the fields to be changed as indexes
* of the array. Keep in mind that if it is intended to change either the
* name of a field and any other properties, the change array entries
* should have the new names of the fields as array indexes.
*
* The value of each entry of the array should be set to another associative
* array with the properties of the fields to that are meant to be changed as
* array entries. These entries should be assigned to the new values of the
* respective properties. The properties of the fields should be the same
* as defined by the Metabase parser.
*
* Example
* array(
* 'name' => 'userlist',
* 'add' => array(
* 'quota' => array(
* 'type' => 'integer',
* 'unsigned' => 1
* )
* ),
* 'remove' => array(
* 'file_limit' => array(),
* 'time_limit' => array()
* ),
* 'change' => array(
* 'name' => array(
* 'length' => '20',
* 'definition' => array(
* 'type' => 'text',
* 'length' => 20,
* ),
* )
* ),
* 'rename' => array(
* 'sex' => array(
* 'name' => 'gender',
* 'definition' => array(
* 'type' => 'text',
* 'length' => 1,
* 'default' => 'M',
* ),
* )
* )
* )
*
* @param boolean $check indicates whether the function should just check if the DBMS driver
* can perform the requested table alterations if the value is true or
* actually perform them otherwise.
* @return void
*/
public function alterTable($name, array $changes, $check = false)
{
foreach ($changes as $changeName => $change) {
switch ($changeName) {
case 'add':
case 'remove':
case 'rename':
break;
case 'change':
foreach ($changes['change'] as $field) {
$this->checkSupportedChanges($field);
}
break;
default:
throw \Doctrine\Common\DoctrineException::updateMe('change type ' . $changeName . ' not yet supported');
}
}
if ($check) {
return true;
}
$query = '';
if ( ! empty($changes['add']) && is_array($changes['add'])) {
foreach ($changes['add'] as $fieldName => $field) {
if ($query) {
$query.= ', ';
}
$query.= 'ADD ' . $this->getDeclaration($fieldName, $field);
}
}
if ( ! empty($changes['remove']) && is_array($changes['remove'])) {
foreach ($changes['remove'] as $field_name => $field) {
if ($query) {
$query.= ', ';
}
$field_name = $this->_conn->quoteIdentifier($field_name, true);
$query.= 'DROP ' . $field_name;
}
}
if ( ! empty($changes['rename']) && is_array($changes['rename'])) {
foreach ($changes['rename'] as $field_name => $field) {
if ($query) {
$query.= ', ';
}
$field_name = $this->_conn->quoteIdentifier($field_name, true);
$query.= 'ALTER ' . $field_name . ' TO ' . $this->_conn->quoteIdentifier($field['name'], true);
}
}
if ( ! empty($changes['change']) && is_array($changes['change'])) {
// missing support to change DEFAULT and NULLability
foreach ($changes['change'] as $fieldName => $field) {
$this->checkSupportedChanges($field);
if ($query) {
$query.= ', ';
}
$this->_conn->loadModule('Datatype', null, true);
$field_name = $this->_conn->quoteIdentifier($fieldName, true);
$query.= 'ALTER ' . $field_name.' TYPE ' . $this->getTypeDeclaration($field['definition']);
}
}
if ( ! strlen($query)) {
return false;
}
$name = $this->_conn->quoteIdentifier($name, true);
$result = $this->_conn->exec('ALTER TABLE ' . $name . ' ' . $query);
$this->_silentCommit();
return $result;
}
/**
* Get the stucture of a field into an array
*
* @param string $table name of the table on which the index is to be created
* @param string $name name of the index to be created
* @param array $definition associative array that defines properties of the index to be created.
* Currently, only one property named FIELDS is supported. This property
* is also an associative with the names of the index fields as array
* indexes. Each entry of this array is set to another type of associative
* array that specifies properties of the index that are specific to
* each field.
*
* Currently, only the sorting property is supported. It should be used
* to define the sorting direction of the index. It may be set to either
* ascending or descending.
*
* Not all DBMS support index sorting direction configuration. The DBMS
* drivers of those that do not support it ignore this property. Use the
* function support() to determine whether the DBMS driver can manage indexes.
* Example
* array(
* 'fields' => array(
* 'user_name' => array(
* 'sorting' => 'ascending'
* ),
* 'last_login' => array()
* )
* )
* @return void
*/
public function createIndexSql($table, $name, array $definition)
{
$query = 'CREATE';
$query_sort = '';
foreach ($definition['fields'] as $field) {
if ( ! strcmp($query_sort, '') && isset($field['sorting'])) {
switch ($field['sorting']) {
case 'ascending':
$query_sort = ' ASC';
break;
case 'descending':
$query_sort = ' DESC';
break;
}
}
}
$table = $this->_conn->quoteIdentifier($table, true);
$name = $this->_conn->quoteIdentifier($this->_conn->formatter->getIndexName($name), true);
$query .= $query_sort. ' INDEX ' . $name . ' ON ' . $table;
$fields = array();
foreach (array_keys($definition['fields']) as $field) {
$fields[] = $this->_conn->quoteIdentifier($field, true);
}
$query .= ' ('.implode(', ', $fields) . ')';
return $query;
}
/**
* create a constraint on a table
*
* @param string $table name of the table on which the constraint is to be created
* @param string $name name of the constraint to be created
* @param array $definition associative array that defines properties of the constraint to be created.
* Currently, only one property named FIELDS is supported. This property
* is also an associative with the names of the constraint fields as array
* constraints. Each entry of this array is set to another type of associative
* array that specifies properties of the constraint that are specific to
* each field.
*
* Example
* array(
* 'fields' => array(
* 'user_name' => array(),
* 'last_login' => array(),
* )
* )
* @return void
*/
public function createConstraint($table, $name, $definition)
{
$table = $this->_conn->quoteIdentifier($table, true);
if ( ! empty($name)) {
$name = $this->_conn->quoteIdentifier($this->_conn->formatter->getIndexName($name), true);
}
$query = "ALTER TABLE $table ADD";
if ( ! empty($definition['primary'])) {
if ( ! empty($name)) {
$query.= ' CONSTRAINT '.$name;
}
$query.= ' PRIMARY KEY';
} else {
$query.= ' CONSTRAINT '. $name;
if ( ! empty($definition['unique'])) {
$query.= ' UNIQUE';
}
}
$fields = array();
foreach (array_keys($definition['fields']) as $field) {
$fields[] = $this->_conn->quoteIdentifier($field, true);
}
$query .= ' ('. implode(', ', $fields) . ')';
$result = $this->_conn->exec($query);
// TODO ? $this->_silentCommit();
return $result;
}
/**
* A method to return the required SQL string that fits between CREATE ... TABLE
* to create the table as a temporary table.
*
* @return string The string required to be placed between "CREATE" and "TABLE"
* to generate a temporary table, if possible.
*/
public function getTemporaryTableQuery()
{
return 'GLOBAL TEMPORARY';
}
/**
* create sequence
*
* @param string $seqName name of the sequence to be created
* @param string $start start value of the sequence; default is 1
* @param array $options An associative array of table options:
* array(
* 'comment' => 'Foo',
* 'charset' => 'utf8',
* 'collate' => 'utf8_unicode_ci',
* );
* @return boolean
*/
public function createSequence($seqName, $start = 1, array $options = array())
{
$sequenceName = $this->_conn->formatter->getSequenceName($seqName);
$this->_conn->exec('CREATE GENERATOR ' . $sequenceName);
try {
$this->_conn->exec('SET GENERATOR ' . $sequenceName . ' TO ' . ($start-1));
return true;
} catch (Doctrine\DBAL\ConnectionException $e) {
try {
$this->dropSequence($seqName);
} catch(Doctrine\DBAL\ConnectionException $e) {
throw \Doctrine\Common\DoctrineException::updateMe('Could not drop inconsistent sequence table');
}
}
throw \Doctrine\Common\DoctrineException::updateMe('could not create sequence table');
}
/**
* drop existing sequence
*
* @param string $seqName name of the sequence to be dropped
* @return void
*/
public function dropSequenceSql($seqName)
{
$sequenceName = $this->_conn->formatter->getSequenceName($seqName);
$sequenceName = $this->_conn->quote($sequenceName);
$query = "DELETE FROM RDB\$GENERATORS WHERE UPPER(RDB\$GENERATOR_NAME)=" . $sequenceName;
return $query;
}
}