-
Notifications
You must be signed in to change notification settings - Fork 14
/
schema.php
1365 lines (1269 loc) · 39.2 KB
/
schema.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
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* SQL Table Schema Builder extension for the PHP Fat-Free Framework
*
* The contents of this file are subject to the terms of the GNU General
* Public License Version 3.0. You may not use this file except in
* compliance with the license. Any of the license terms and conditions
* can be waived if you get permission from the copyright holder.
*
* crafted by __ __ __
* |__| |--.| |--.-----.-----.
* | | < | <| -__|-- __|
* |__|__|__||__|__|_____|_____|
*
* Copyright (c) 2012-2019 by ikkez
* Christian Knuth <ikkez0n3@gmail.com>
* https://github.com/ikkez/F3-Sugar/
*
* @package DB
* @version 2.2.5
* @date 10.02.2023
**/
namespace DB\SQL;
use Base;
use DB\SQL;
use PDO;
class Schema {
use DB_Utils;
public
$dataTypes=[
'BOOLEAN'=>[
'mysql'=>'tinyint(1)',
'sqlite2?|pgsql'=>'BOOLEAN',
'mssql|sybase|dblib|odbc|sqlsrv'=>'bit',
'ibm'=>'numeric(1,0)',
],
'INT1'=>[
'mysql'=>'tinyint(4)',
'sqlite2?'=>'integer(4)',
'mssql|sybase|dblib|odbc|sqlsrv'=>'tinyint',
'pgsql|ibm'=>'smallint',
],
'INT2'=>[
'mysql'=>'smallint(6)',
'sqlite2?'=>'integer(6)',
'pgsql|ibm|mssql|sybase|dblib|odbc|sqlsrv'=>'smallint',
],
'INT4'=>[
'sqlite2?'=>'integer(11)',
'pgsql|imb'=>'integer',
'mysql'=>'int(11)',
'mssql|dblib|sybase|odbc|sqlsrv'=>'int',
],
'INT8'=>[
'sqlite2?'=>'integer(20)',
'pgsql|mssql|sybase|dblib|odbc|sqlsrv|imb'=>'bigint',
'mysql'=>'bigint(20)',
],
'FLOAT'=>[
'mysql|sqlite2?'=>'FLOAT',
'pgsql'=>'double precision',
'mssql|sybase|dblib|odbc|sqlsrv'=>'float',
'imb'=>'decfloat'
],
'DOUBLE'=>[
'mysql|ibm'=>'decimal(18,6)',
'sqlite2?'=>'decimal(15,6)', // max 15-digit on sqlite
'pgsql'=>'numeric(18,6)',
'mssql|dblib|sybase|odbc|sqlsrv'=>'decimal(18,6)',
],
'VARCHAR128'=>[
'mysql|sqlite2?|ibm|mssql|sybase|dblib|odbc|sqlsrv'=>'varchar(128)',
'pgsql'=>'character varying(128)',
],
'VARCHAR256'=>[
'mysql|sqlite2?|ibm|mssql|sybase|dblib|odbc|sqlsrv'=>'varchar(255)',
'pgsql'=>'character varying(255)',
],
'VARCHAR512'=>[
'mysql|sqlite2?|ibm|mssql|sybase|dblib|odbc|sqlsrv'=>'varchar(512)',
'pgsql'=>'character varying(512)',
],
'TEXT'=>[
'mysql|sqlite2?|pgsql|mssql'=>'text',
'sybase|dblib|odbc|sqlsrv'=>'nvarchar(max)',
'ibm'=>'BLOB SUB_TYPE TEXT',
],
'LONGTEXT'=>[
'mysql'=>'LONGTEXT',
'sqlite2?|pgsql|mssql'=>'text',
'sybase|dblib|odbc|sqlsrv'=>'nvarchar(max)',
'ibm'=>'CLOB(2000000000)',
],
'DATE'=>[
'mysql|sqlite2?|pgsql|mssql|sybase|dblib|odbc|sqlsrv|ibm'=>'date',
],
'DATETIME'=>[
'pgsql'=>'timestamp without time zone',
'mysql|sqlite2?|mssql|sybase|dblib|odbc|sqlsrv'=>'datetime',
'ibm'=>'timestamp',
],
'TIMESTAMP'=>[
'mysql|ibm'=>'timestamp',
'pgsql|odbc'=>'timestamp without time zone',
'sqlite2?|mssql|sybase|dblib|sqlsrv'=>'DATETIME',
],
'BLOB'=>[
'mysql|odbc|sqlite2?|ibm'=>'blob',
'pgsql'=>'bytea',
'mssql|sybase|dblib'=>'image',
'sqlsrv'=>'varbinary(max)',
],
],
$defaultTypes=[
'CUR_STAMP'=>[
'mysql'=>'CURRENT_TIMESTAMP',
'mssql|sybase|dblib|odbc|sqlsrv'=>'getdate()',
'pgsql'=>'LOCALTIMESTAMP(0)',
'sqlite2?'=>"(datetime('now','localtime'))",
],
];
public
$name;
public static
$strict=FALSE;
const
// DataTypes and Aliases
DT_BOOL='BOOLEAN',
DT_BOOLEAN='BOOLEAN',
DT_INT1='INT1',
DT_TINYINT='INT1',
DT_INT2='INT2',
DT_SMALLINT='INT2',
DT_INT4='INT4',
DT_INT='INT4',
DT_INT8='INT8',
DT_BIGINT='INT8',
DT_FLOAT='FLOAT',
DT_DOUBLE='DOUBLE',
DT_DECIMAL='DOUBLE',
DT_VARCHAR128='VARCHAR128',
DT_VARCHAR256='VARCHAR256',
DT_VARCHAR512='VARCHAR512',
DT_TEXT='TEXT',
DT_LONGTEXT='LONGTEXT',
DT_DATE='DATE',
DT_DATETIME='DATETIME',
DT_TIMESTAMP='TIMESTAMP',
DT_BLOB='BLOB',
DT_BINARY='BLOB',
// column default values
DF_CURRENT_TIMESTAMP='CUR_STAMP';
public function __construct(SQL $db) {
$this->db=$db;
}
/**
* get a list of all databases
* @return array|bool
*/
public function getDatabases() {
$cmd=[
'mysql'=>'SHOW DATABASES',
'pgsql'=>'SELECT datname FROM pg_catalog.pg_database',
'mssql|sybase|dblib|sqlsrv|odbc'=>'EXEC SP_HELPDB',
];
$query=$this->findQuery($cmd);
if (!$query) return FALSE;
$result=$this->db->exec($query);
if (!is_array($result)) return FALSE;
foreach ($result as &$db)
if (is_array($db)) $db=array_shift($db);
return $result;
}
/**
* get all tables of current DB
* @return bool|array list of tables, or false
*/
public function getTables() {
$cmd=[
'mysql'=>[
"show tables"],
'sqlite2?'=>[
"SELECT name FROM sqlite_master WHERE type='table' AND name!='sqlite_sequence'"],
'pgsql|sybase|dblib'=>[
"select table_name from information_schema.tables where table_schema = 'public'"],
'mssql|sqlsrv|odbc'=>[
"select table_name from information_schema.tables"],
'ibm'=>["select TABLE_NAME from sysibm.tables"],
];
$query=$this->findQuery($cmd);
if (!$query[0]) return FALSE;
$tables=$this->db->exec($query[0]);
if ($tables && is_array($tables) && count($tables)>0)
foreach ($tables as &$table)
$table=array_shift($table);
return $tables;
}
/**
* returns a table object for creation
* @param $name
* @return bool|TableCreator
*/
public function createTable($name) {
return new TableCreator($name,$this);
}
/**
* returns a table object for altering operations
* @param $name
* @return bool|TableModifier
*/
public function alterTable($name) {
return new TableModifier($name,$this);
}
/**
* rename a table
* @param string $name
* @param string $new_name
* @param bool $exec
* @return bool
*/
public function renameTable($name,$new_name,$exec=TRUE) {
$name=$this->db->quotekey($name);
$new_name=$this->db->quotekey($new_name);
if (strpos($this->db->driver(),'odbc')!==FALSE) {
$queries=[];
$queries[]="SELECT * INTO $new_name FROM $name;";
$queries[]=$this->dropTable($name,FALSE);
return ($exec)?$this->db->exec($queries):implode("\n",$queries);
} else {
$cmd=[
'sqlite2?|pgsql'=>
"ALTER TABLE $name RENAME TO $new_name;",
'mysql|ibm'=>
"RENAME TABLE $name TO $new_name;",
'mssql|sqlsrv|sybase|dblib|odbc'=>
"sp_rename {$name}, $new_name"
];
$query=$this->findQuery($cmd);
if (!$exec) return $query;
return (preg_match('/mssql|sybase|dblib|sqlsrv/',$this->db->driver()))
?@$this->db->exec($query):$this->db->exec($query);
}
}
/**
* drop a table
* @param TableBuilder|string $name
* @param bool $exec
* @return bool
*/
public function dropTable($name,$exec=TRUE) {
if (is_object($name) && $name instanceof TableBuilder)
$name=$name->name;
$cmd=[
'mysql|ibm|sqlite2?|pgsql|sybase|dblib'=>
'DROP TABLE IF EXISTS '.$this->db->quotekey($name).';',
'mssql|sqlsrv|odbc'=>
"IF OBJECT_ID('[$name]', 'U') IS NOT NULL DROP TABLE [$name];"
];
$query=$this->findQuery($cmd);
return ($exec)?$this->db->exec($query):$query;
}
/**
* clear a table
* @param $name
* @param bool $exec
* @return array|bool|FALSE|int|string
*/
public function truncateTable($name,$exec=TRUE) {
if (is_object($name) && $name instanceof TableBuilder)
$name=$name->name;
$cmd=[
'mysql|ibm|pgsql|sybase|dblib|mssql|sqlsrv|odbc'=>
'TRUNCATE TABLE '.$this->db->quotekey($name).';',
'sqlite2?'=>[
'DELETE FROM '.$this->db->quotekey($name).';',
// 'UPDATE SQLITE_SEQUENCE SET seq = 0 WHERE name = '.$this->db->quotekey($name).';',
],
];
$query=$this->findQuery($cmd);
return ($exec)?$this->db->exec($query):$query;
}
/**
* check if a data type is compatible with a given column definition
* @param string $colType (i.e: BOOLEAN)
* @param string $colDef (i.e: tinyint(1))
* @return int
*/
public function isCompatible($colType,$colDef) {
$raw_type=$this->findQuery($this->dataTypes[strtoupper($colType)]);
preg_match_all('/(?P<type>\w+)($|\((?P<length>(\d+|(.*)))\))/',$raw_type,$match);
return (bool)preg_match_all('/'.preg_quote($match['type'][0]).'($|\('.
preg_quote($match['length'][0]).'\))/i',$colDef);
}
}
abstract class TableBuilder {
use DB_Utils;
protected $columns,$pkeys,$queries,$increments,$rebuild_cmd,$suppress;
public $name;
/** @var Schema */
public $schema;
const
TEXT_NoDefaultForTEXT="Column `%s` of type TEXT can't have a default value.",
TEXT_ColumnExists="Cannot add the column `%s`. It already exists.";
/**
* @param string $name
* @param Schema $schema
*/
public function __construct($name,Schema $schema) {
$this->name=$name;
$this->schema=$schema;
$this->columns=[];
$this->queries=[];
$this->pkeys=['id'];
$this->increments='id';
$this->db=$schema->db;
}
/**
* generate SQL query and execute it if $exec is true
* @param bool $exec
*/
abstract public function build($exec=TRUE);
/**
* add a new column to this table
* @param string|Column $key column name or object
* @param null|array $args optional config array
* @return Column
*/
public function addColumn($key,$args=NULL) {
if ($key instanceof Column) {
$args=$key->getColumnArray();
$key=$key->name;
}
if (array_key_exists($key,$this->columns))
trigger_error(sprintf(self::TEXT_ColumnExists,$key),E_USER_ERROR);
$column=new Column($key,$this);
if ($args)
foreach ($args as $arg=>$val)
if (property_exists($column, $arg))
$column->{$arg}=$val;
// skip default pkey field
if (count($this->pkeys)==1 && in_array($key,$this->pkeys))
return $column;
return $this->columns[$key]=&$column;
}
/**
* create index on one or more columns
* @param string|array $index_cols Column(s) to be indexed
* @param $search_cols
* @param bool $unique Unique index
* @param int $length index length for text fields in mysql
*/
protected function _addIndex($index_cols,$search_cols,$unique,$length) {
if (!is_array($index_cols))
$index_cols=[$index_cols];
$quotedCols=array_map([$this->db,'quotekey'],$index_cols);
if (strpos($this->db->driver(),'mysql')!==FALSE)
foreach ($quotedCols as $i=>&$col)
if (strtoupper($search_cols[$index_cols[$i]]['type'])=='TEXT')
$col.='('.$length.')';
$cols=implode(',',$quotedCols);
$name=$this->assembleIndexKey($index_cols,$this->name);
$name=$this->db->quotekey($name);
$table=$this->db->quotekey($this->name);
$index=$unique?'UNIQUE INDEX':'INDEX';
$cmd=[
'pgsql|sqlite2?|ibm|mssql|sybase|dblib|odbc|sqlsrv'=>
"CREATE $index $name ON $table ($cols);",
'mysql'=> //ALTER TABLE is used because of MySQL bug #48875
"ALTER TABLE $table ADD $index $name ($cols);",
];
$query=$this->findQuery($cmd);
$this->queries[]=$query;
}
/**
* create index name from one or more given column names, max. 64 char lengths
* @param string|array $index_cols
* @return string
*/
protected function assembleIndexKey($index_cols,$table_name) {
if (!is_array($index_cols))
$index_cols=[$index_cols];
$name=$table_name.'___'.implode('__',$index_cols);
if (strlen($name)>64)
$name=$table_name.'___'.Base::instance()->hash(implode('__',$index_cols));
if (strlen($name)>64)
$name='___'.
Base::instance()->hash($table_name.'___'.implode('__',$index_cols));
return $name;
}
/**
* set primary / composite key to table
* @param string|array $pkeys
* @return bool
*/
public function primary($pkeys) {
if (empty($pkeys))
return FALSE;
if (!is_array($pkeys))
$pkeys=[$pkeys];
// single pkey
$this->increments=$pkeys[0];
$this->pkeys=$pkeys;
// drop duplicate pkey definition
if (array_key_exists($this->increments,$this->columns))
unset($this->columns[$this->increments]);
// set flag on new fields
foreach ($pkeys as $name)
if (array_key_exists($name,$this->columns))
$this->columns[$name]->pkey=TRUE;
// composite key
if (count($pkeys)>1) {
$pkeys_quoted=array_map([$this->db,'quotekey'],$pkeys);
$pk_string=implode(', ',$pkeys_quoted);
if (strpos($this->db->driver(),'sqlite')!==FALSE) {
// rebuild table with new primary keys
$this->rebuild_cmd['pkeys']=$pkeys;
} else {
$table=$this->db->quotekey($this->name);
$table_key=$this->db->quotekey($this->name.'_pkey');
$cmd=[
'odbc'=>
"CREATE INDEX $table_key ON $table ( $pk_string );",
'mysql'=>
"ALTER TABLE $table DROP PRIMARY KEY, ADD PRIMARY KEY ( $pk_string );",
'mssql|sybase|dblib|sqlsrv'=>[
"ALTER TABLE $table DROP CONSTRAINT PK_".$this->name."_ID;",
"ALTER TABLE $table ADD CONSTRAINT $table_key PRIMARY KEY ( $pk_string );",
],
'pgsql'=>[
"ALTER TABLE $table DROP CONSTRAINT $table_key;",
"ALTER TABLE $table ADD CONSTRAINT $table_key PRIMARY KEY ( $pk_string );",
],
];
$query=$this->findQuery($cmd);
if (!is_array($query))
$query=[$query];
foreach ($query as $q)
$this->queries[]=$q;
}
}
return true;
}
public function getIndexName($index_cols){
return $this->assembleIndexKey($index_cols,$this->name);
}
}
class TableCreator extends TableBuilder {
const
TEXT_TableAlreadyExists="Table `%s` already exists. Cannot create it.";
protected $charset='utf8';
protected $collation='unicode';
public function setCharset($charset,$collation='unicode') {
$this->charset=$charset;
$this->collation=$collation;
}
/**
* generate SQL query for creating a basic table, containing an ID serial field
* and execute it if $exec is true, otherwise just return the generated query string
* @param bool $exec
* @return bool|TableModifier|string
*/
public function build($exec=TRUE) {
// check if already existing
if ($exec && in_array($this->name,$this->schema->getTables())) {
trigger_error(sprintf(self::TEXT_TableAlreadyExists,$this->name),
E_USER_ERROR);
return FALSE;
}
$cols='';
if (!empty($this->columns))
foreach ($this->columns as $cname=>$column) {
// no defaults for TEXT type
if ($column->default!==FALSE &&
is_int(strpos(strtoupper($column->type),'TEXT'))) {
trigger_error(sprintf(self::TEXT_NoDefaultForTEXT,$column->name),
E_USER_ERROR);
return FALSE;
}
$cols.=', '.$column->getColumnQuery();
}
$table=$this->db->quotekey($this->name);
$id=$this->db->quotekey($this->increments);
$cmd=[
'sqlite2?|sybase|dblib'=>
"CREATE TABLE $table ($id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT".
$cols.");",
'mysql'=>
"CREATE TABLE $table ($id INTEGER NOT NULL PRIMARY KEY AUTO_INCREMENT".
$cols.") DEFAULT CHARSET=$this->charset COLLATE ".$this->charset."_".
$this->collation."_ci;",
'pgsql'=>
"CREATE TABLE $table ($id SERIAL PRIMARY KEY".$cols.");",
'mssql|odbc|sqlsrv'=>
"CREATE TABLE $table ($id INT IDENTITY CONSTRAINT PK_".$this->name.
"_ID PRIMARY KEY".$cols.");",
'ibm'=>
"CREATE TABLE $table ($id INTEGER AS IDENTITY NOT NULL $cols, PRIMARY KEY($id));",
];
$query=$this->findQuery($cmd);
// composite key for sqlite
if (count($this->pkeys)>1 && strpos($this->db->driver(),'sqlite')!==FALSE) {
$pk_string=implode(', ',$this->pkeys);
$query="CREATE TABLE $table ($id INTEGER NULL".$cols.
", PRIMARY KEY ($pk_string) );";
$newTable=new TableModifier($this->name,$this->schema);
// auto-incrementation in composite primary keys
$pk_queries=$newTable->_sqlite_increment_trigger($this->increments);
$this->queries=array_merge($this->queries,$pk_queries);
}
array_unshift($this->queries,$query);
// indexes
foreach ($this->columns as $cname=>$column)
if ($column->index)
$this->addIndex($cname,$column->unique);
if (!$exec)
return $this->queries;
$this->db->exec($this->queries);
return isset($newTable)?$newTable:new TableModifier($this->name,$this->schema);
}
/**
* create index on one or more columns
* @param string|array $columns Column(s) to be indexed
* @param bool $unique Unique index
* @param int $length index length for text fields in mysql
*/
public function addIndex($columns,$unique=FALSE,$length=20) {
if (!is_array($columns))
$columns=[$columns];
$cols=$this->columns;
foreach ($cols as &$col)
$col=$col->getColumnArray();
parent::_addIndex($columns,$cols,$unique,$length);
}
}
class TableModifier extends TableBuilder {
protected
$colTypes,$rebuild_cmd,$charset,$collation;
const
// error messages
TEXT_TableNotExisting="Unable to alter table `%s`. It does not exist.",
TEXT_NotNullFieldNeedsDefault='You cannot add the not nullable column `%s` without specifying a default value',
TEXT_ENGINE_NOT_SUPPORTED='DB Engine `%s` is not supported for this action.';
public function setCharset($charset,$collation='unicode') {
$this->charset=$charset;
$this->collation=$collation;
}
/**
* generate SQL queries for altering the table and execute it if $exec is true,
* otherwise return the generated query string
* @param bool $exec
* @return array|FALSE
*/
public function build($exec=TRUE) {
// check if table exists
if (!in_array($this->name,$this->schema->getTables()))
trigger_error(sprintf(self::TEXT_TableNotExisting,$this->name),E_USER_ERROR);
if ($sqlite=strpos($this->db->driver(),'sqlite')!==FALSE) {
$sqlite_queries=[];
}
$rebuild=FALSE;
$additional_queries=$this->queries;
$this->queries=[];
// add new columns
$table=$this->db->quotekey($this->name);
foreach ($this->columns as $cname=>$column) {
/** @var Column $column */
// not nullable fields should have a default value, when altering a table
if ($column->default===FALSE && $column->nullable===FALSE) {
trigger_error(sprintf(self::TEXT_NotNullFieldNeedsDefault,$column->name),
E_USER_ERROR);
return FALSE;
}
// no defaults for TEXT type
if ($column->default!==FALSE &&
is_int(strpos(strtoupper($column->type),'TEXT'))) {
trigger_error(sprintf(self::TEXT_NoDefaultForTEXT,$column->name),
E_USER_ERROR);
return FALSE;
}
$col_query=$column->getColumnQuery();
if ($sqlite) {
// sqlite: dynamic column default only works when rebuilding the table
if ($column->default===Schema::DF_CURRENT_TIMESTAMP) {
$rebuild=TRUE;
break;
} else
$sqlite_queries[]="ALTER TABLE $table ADD $col_query;";
} else {
$cmd=[
'mysql|pgsql|mssql|sybase|dblib|odbc|sqlsrv'=>
"ALTER TABLE $table ADD $col_query;",
'ibm'=>
"ALTER TABLE $table ADD COLUMN $col_query;",
];
$this->queries[]=$this->findQuery($cmd);
}
}
if (strpos($this->db->driver(),'mysql')!==FALSE && !empty($this->charset) &&
!empty($this->collation)) {
$this->queries[]=
"ALTER TABLE $table CONVERT TO CHARACTER SET ".$this->charset." COLLATE ".
$this->charset."_".$this->collation."_ci;";
}
if ($sqlite)
if ($rebuild || !empty($this->rebuild_cmd)) $this->_sqlite_rebuild($exec);
else $this->queries+=$sqlite_queries;
$this->queries=array_merge($this->queries,$additional_queries);
// add new indexes
foreach ($this->columns as $cname=>$column)
if ($column->index)
$this->addIndex($cname,$column->unique);
if (empty($this->queries))
return FALSE;
if (is_array($this->queries) && count($this->queries)==1)
$this->queries=$this->queries[0];
if (!$exec) return $this->queries;
$result=($this->suppress)
?@$this->db->exec($this->queries):$this->db->exec($this->queries);
$this->queries=$this->columns=$this->rebuild_cmd=[];
return $result;
}
/**
* rebuild a sqlite table with additional schema changes
*/
protected function _sqlite_rebuild($exec=TRUE) {
$new_columns=$this->columns;
$existing_columns=$this->getCols(TRUE);
// find after sorts
$after=[];
foreach ($new_columns as $cname=>$column)
if (!empty($column->after))
$after[$column->after][]=$cname;
// find rename commands
$rename=
(!empty($this->rebuild_cmd) && array_key_exists('rename',$this->rebuild_cmd))
?$this->rebuild_cmd['rename']:[];
// get primary-key fields
foreach ($existing_columns as $key=>$col)
if ($col['pkey'])
$pkeys[array_key_exists($key,$rename)?$rename[$key]:$key]=$col;
foreach ($new_columns as $key=>$col)
if ($col->pkey)
$pkeys[$key]=$col;
// indexes
$indexes=$this->listIndex();
// drop fields
if (!empty($this->rebuild_cmd) && array_key_exists('drop',$this->rebuild_cmd))
foreach ($this->rebuild_cmd['drop'] as $name)
if (array_key_exists($name,$existing_columns)) {
if (array_key_exists($name,$pkeys)) {
unset($pkeys[$name]);
// drop composite key
if (count($pkeys)==1) {
$incrementTrigger=$this->db->quotekey($this->name.'_insert');
$this->queries[]='DROP TRIGGER IF EXISTS '.$incrementTrigger;
}
}
unset($existing_columns[$name]);
// drop index
foreach (array_keys($indexes) as $col) {
// new index names
if ($col==$this->name.'___'.$name)
unset($indexes[$this->name.'___'.$name]);
// check if column is part of an existing combined index
if (is_int(strpos($col,'__'))) {
if (is_int(strpos($col,'___'))) {
$col=explode('___',$col);
$ci=explode('__',$col[1]);
$col=implode('___',$col);
// drop combined index
if (in_array($name,$ci))
unset($indexes[$col]);
}
}
}
}
// create new table
$oname=$this->name;
$this->queries[]=$this->rename($oname.'_temp',FALSE);
$newTable=$this->schema->createTable($oname);
// add existing fields
foreach ($existing_columns as $name=>$col) {
$colName=array_key_exists($name,$rename)?$rename[$name]:$name;
// update column datatype
if (array_key_exists('update',$this->rebuild_cmd)
&& in_array($name,array_keys($this->rebuild_cmd['update']))) {
$cdat=$this->rebuild_cmd['update'][$name];
if ($cdat instanceof Column)
$col=$cdat->getColumnArray();
else
$col['type']=$cdat;
}
$newTable->addColumn($colName,$col)->passThrough();
// add new fields with after flag
if (array_key_exists($name,$after))
foreach (array_reverse($after[$name]) as $acol) {
$newTable->addColumn($new_columns[$acol]);
unset($new_columns[$acol]);
}
}
// add remaining new fields
foreach ($new_columns as $ncol)
$newTable->addColumn($ncol);
$newTable->primary(array_keys($pkeys));
// add existing indexes
foreach (array_reverse($indexes) as $name=>$conf) {
if (is_int(strpos($name,'___')))
list($tname,$name)=explode('___',$name);
if (is_int(strpos($name,'__')))
$name=explode('__',$name);
if ($exec) {
$t=$this->schema->alterTable($oname);
$t->dropIndex($name);
$t->build();
}
$newTable->addIndex($name,$conf['unique']);
}
// build new table
$newTableQueries=$newTable->build(FALSE);
$this->queries=array_merge($this->queries,$newTableQueries);
// copy data
if (!empty($existing_columns)) {
foreach (array_keys($existing_columns) as $name) {
$fields_from[]=$this->db->quotekey($name);
$toName=array_key_exists($name,$rename)?$rename[$name]:$name;
$fields_to[]=$this->db->quotekey($toName);
}
$this->queries[]=
'INSERT INTO '.$this->db->quotekey($newTable->name).' ('.
implode(', ',$fields_to).') '.
'SELECT '.implode(', ',$fields_from).' FROM '.
$this->db->quotekey($this->name).';';
}
$this->queries[]=$this->drop(FALSE);
$this->name=$oname;
}
/**
* create an insert trigger to work-a-round auto-incrementation in composite primary keys
* @param $pkey
* @return array
*/
public function _sqlite_increment_trigger($pkey) {
$table=$this->db->quotekey($this->name);
$pkey=$this->db->quotekey($pkey);
$triggerName=$this->db->quotekey($this->name.'_insert');
$queries[]="DROP TRIGGER IF EXISTS $triggerName;";
$queries[]='CREATE TRIGGER '.$triggerName.' AFTER INSERT ON '.$table.
' WHEN (NEW.'.$pkey.' IS NULL) BEGIN'.
' UPDATE '.$table.' SET '.$pkey.' = ('.
' select coalesce( max( '.$pkey.' ), 0 ) + 1 from '.$table.
') WHERE ROWID = NEW.ROWID;'.
' END;';
return $queries;
}
/**
* get columns of a table
* @param bool $types
* @return array
*/
public function getCols($types=FALSE) {
$schema=$this->db->schema($this->name,NULL,0);
if (!$types)
return array_keys($schema);
else
foreach ($schema as $name=>&$cols) {
$default=($cols['default']==='')?NULL:$cols['default'];
if (!is_null($default) && ((is_int(strpos($curdef=strtolower(
$this->findQuery($this->schema->defaultTypes['CUR_STAMP'])),
strtolower($default))) ||
is_int(strpos(strtolower($default),$curdef)))
|| $default=="('now'::text)::timestamp(0) without time zone")) {
$default='CUR_STAMP';
} elseif (!is_null($default)) {
// remove single-qoutes
if (strpos($this->db->driver(),'sqlite')!==FALSE)
$default=preg_replace('/^\s*([\'"])(.*)\1\s*$/','\2',$default);
elseif (preg_match('/mssql|sybase|dblib|odbc|sqlsrv/',
$this->db->driver()))
$default=preg_replace('/^\s*(\(\')(.*)(\'\))\s*$/','\2',$default);
// extract value from character_data in postgre
elseif (strpos($this->db->driver(),'pgsql')!==FALSE)
if (is_int(strpos($default,'nextval')))
$default=NULL; // drop autoincrement default
elseif (preg_match("/^\'*(.*)\'*::(\s*\w)+/",$default,$match))
$default=$match[1];
} else
$default=FALSE;
$cols['default']=$default;
}
return $schema;
}
/**
* check if a data type is compatible with an existing column type
* @param string $colType (i.e: BOOLEAN)
* @param string $column (i.e: active)
* @return bool
*/
public function isCompatible($colType,$column) {
$cols=$this->getCols(TRUE);
return $this->schema->isCompatible($colType,$cols[$column]['type']);
}
/**
* removes a column from a table
* @param string $name
*/
public function dropColumn($name) {
$colTypes=$this->getCols(TRUE);
// check if column exists
if (!in_array($name,array_keys($colTypes))) return TRUE;
if (strpos($this->db->driver(),'sqlite')!==FALSE) {
// SQlite does not support drop column directly
$this->rebuild_cmd['drop'][]=$name;
} else {
$quotedTable=$this->db->quotekey($this->name);
$quotedColumn=$this->db->quotekey($name);
$cmd=[
'mysql'=>
"ALTER TABLE $quotedTable DROP $quotedColumn;",
'pgsql|odbc|ibm|mssql|sybase|dblib|sqlsrv'=>
"ALTER TABLE $quotedTable DROP COLUMN $quotedColumn;",
];
if (preg_match('/mssql|sybase|dblib|sqlsrv/',$this->db->driver()))
$this->suppress=TRUE;
$this->queries[]=$this->findQuery($cmd);
}
}
/**
* rename a column
* @param $name
* @param $new_name
* @return void
*/
public function renameColumn($name,$new_name) {
$existing_columns=$this->getCols(TRUE);
// check if column is already existing
if (!in_array($name,array_keys($existing_columns)))
trigger_error('cannot rename column. it does not exist.',E_USER_ERROR);
if (in_array($new_name,array_keys($existing_columns)))
trigger_error('cannot rename column. new column already exist.',E_USER_ERROR);
if (strpos($this->db->driver(),'sqlite')!==FALSE)
// SQlite does not support drop or rename column directly
$this->rebuild_cmd['rename'][$name]=$new_name;
elseif (strpos($this->db->driver(),'obdc')!==FALSE) {
// no rename column for odbc, create temp column
$this->addColumn($new_name,$existing_columns[$name])->passThrough();
$this->queries[]="UPDATE $this->name SET $new_name = $name";
$this->dropColumn($name);
} else {
$existing_columns=$this->getCols(TRUE);
$quotedTable=$this->db->quotekey($this->name);
$quotedColumn=$this->db->quotekey($name);
$quotedColumnNew=$this->db->quotekey($new_name);
$cmd=[
'mysql'=>
"ALTER TABLE $quotedTable CHANGE $quotedColumn $quotedColumnNew ".
$existing_columns[$name]['type'].";",
'pgsql|ibm'=>
"ALTER TABLE $quotedTable RENAME COLUMN $quotedColumn TO $quotedColumnNew;",
'mssql|sybase|dblib|sqlsrv'=>
"sp_rename [$this->name.$name], '$new_name', 'Column'",
];
if (preg_match('/mssql|sybase|dblib|sqlsrv/',$this->db->driver()))
$this->suppress=TRUE;
$this->queries[]=$this->findQuery($cmd);
}
}
/**
* modifies column datatype
* @param string $name
* @param string|Column $datatype
* @param bool $force
*/
public function updateColumn($name,$datatype,$force=FALSE) {
if ($datatype instanceof Column) {
$col=$datatype;
$datatype=$col->type;
$force=$col->passThrough;
}
if (!$force)
$datatype=$this->findQuery($this->schema->dataTypes[strtoupper($datatype)]);
$table=$this->db->quotekey($this->name);
$column=$this->db->quotekey($name);
if (strpos($this->db->driver(),'sqlite')!==FALSE) {
$this->rebuild_cmd['update'][$name]=isset($col)?$col:$datatype;
} else {
$dat=isset($col)?$col->getColumnQuery():
$column.' '.$datatype;
$cmd=[
'mysql'=>
"ALTER TABLE $table MODIFY COLUMN $dat;",
'pgsql'=>
"ALTER TABLE $table ALTER COLUMN $column TYPE $datatype;",
'sqlsrv|mssql|sybase|dblib|ibm'=>
"ALTER TABLE $table ALTER COLUMN $column $datatype;",
];
if (isset($col)) {
$cmd['pgsql']=[$cmd['pgsql']];
$cmd['pgsql'][]="ALTER TABLE $table ALTER COLUMN $column SET DEFAULT ".
$col->getDefault().";";
if ($col->nullable)
$cmd['pgsql'][]=
"ALTER TABLE $table ALTER COLUMN $column DROP NOT NULL;";
else
$cmd['pgsql'][]=
"ALTER TABLE $table ALTER COLUMN $column SET NOT NULL;";
$df_key='DF_'.$this->name.'_'.$name;
$cmd['sqlsrv|mssql|sybase|dblib|ibm']=[
"ALTER TABLE $table ALTER COLUMN $column $datatype ".
$col->getNullable().";",
"DECLARE @ConstraintName nvarchar(200)
SELECT @ConstraintName = Name FROM SYS.DEFAULT_CONSTRAINTS WHERE PARENT_OBJECT_ID = OBJECT_ID('$this->name')
AND PARENT_COLUMN_ID = (SELECT column_id FROM sys.columns WHERE NAME = N'$name'
AND object_id = OBJECT_ID(N'$this->name'))
IF @ConstraintName IS NOT NULL
EXEC('ALTER TABLE $this->name DROP CONSTRAINT ' + @ConstraintName)
",
"ALTER TABLE $table ADD CONSTRAINT $df_key DEFAULT ".
$col->getDefault()." FOR $column;",
];
}
$this->queries[]=$this->findQuery($cmd);
}
}
/**
* create index on one or more columns
* @param string|array $columns Column(s) to be indexed
* @param bool $unique Unique index
* @param int $length index length for text fields in mysql
*/
public function addIndex($columns,$unique=FALSE,$length=20) {
if (!is_array($columns))
$columns=[$columns];
$existingCol=$this->columns;
foreach ($existingCol as &$col)
$col=$col->getColumnArray();
$allCols=array_merge($this->getCols(TRUE),$existingCol);
parent::_addIndex($columns,$allCols,$unique,$length);
}
/**
* drop a column index
* @param string|array $name
*/
public function dropIndex($name) {
if (is_array($name))