forked from ifsnop/mysqldump-php
-
Notifications
You must be signed in to change notification settings - Fork 7
/
Mysqldump.php
1096 lines (926 loc) · 33.4 KB
/
Mysqldump.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
/**
* PHP version of mysqldump cli that comes with MySQL.
*
* Tags: mysql mysqldump pdo php7 php8 database php sql mariadb mysql-backup.
*
* @category Library
* @package Druidfi\Mysqldump
* @author Marko Korhonen <marko.korhonen@druid.fi>
* @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
* @link https://github.com/druidfi/mysqldump-php
* @see https://github.com/ifsnop/mysqldump-php
*/
namespace Druidfi\Mysqldump;
use Druidfi\Mysqldump\Compress\CompressInterface;
use Druidfi\Mysqldump\Compress\CompressManagerFactory;
use Druidfi\Mysqldump\TypeAdapter\TypeAdapterInterface;
use Druidfi\Mysqldump\TypeAdapter\TypeAdapterMysql;
use Exception;
use PDO;
use PDOException;
class Mysqldump
{
// Database
private string $dsn;
private ?string $user;
private ?string $pass;
private string $host;
private string $dbName;
private PDO $conn;
private array $pdoOptions;
private CompressInterface $io;
private TypeAdapterInterface $db;
private static string $adapterClass = TypeAdapterMysql::class;
private DumpSettings $settings;
private array $tableColumnTypes = [];
private $transformTableRowCallable;
private $transformColumnValueCallable;
private $infoCallable;
// Internal data arrays.
private array $tables = [];
private array $views = [];
private array $triggers = [];
private array $procedures = [];
private array $functions = [];
private array $events = [];
/**
* Keyed on table name, with the value as the conditions.
* e.g. - 'users' => 'date_registered > NOW() - INTERVAL 6 MONTH'
*/
private array $tableWheres = [];
private array $tableLimits = [];
/**
* Constructor of Mysqldump.
*
* @param string $dsn PDO DSN connection string
* @param string|null $user SQL account username
* @param string|null $pass SQL account password
* @param array $settings SQL database settings
* @param array $pdoOptions PDO configured attributes
* @throws Exception
*/
public function __construct(
string $dsn = '',
?string $user = null,
?string $pass = null,
array $settings = [],
array $pdoOptions = []
)
{
$this->dsn = $this->parseDsn($dsn);
$this->user = $user;
$this->pass = $pass;
$this->settings = new DumpSettings($settings);
$this->pdoOptions = $pdoOptions;
}
/**
* Parse DSN string and extract dbname value
* Several examples of a DSN string
* mysql:host=localhost;dbname=testdb
* mysql:host=localhost;port=3307;dbname=testdb
* mysql:unix_socket=/tmp/mysql.sock;dbname=testdb
*
* @param string $dsn dsn string to parse
* @throws Exception
*/
private function parseDsn(string $dsn): string
{
if (empty($dsn) || !($pos = strpos($dsn, ':'))) {
throw new Exception('Empty DSN string');
}
$dbType = strtolower(substr($dsn, 0, $pos));
if (empty($dbType)) {
throw new Exception('Missing database type from DSN string');
}
$data = [];
foreach (explode(';', substr($dsn, $pos + 1)) as $kvp) {
if (strpos($kvp, '=') !== false) {
list($param, $value) = explode('=', $kvp);
$data[trim(strtolower($param))] = $value;
}
}
if (empty($data['host']) && empty($data['unix_socket'])) {
throw new Exception('Missing host from DSN string');
}
if (empty($data['dbname'])) {
throw new Exception('Missing database name from DSN string');
}
$this->host = (!empty($data['host'])) ? $data['host'] : $data['unix_socket'];
$this->dbName = $data['dbname'];
return $dsn;
}
/**
* Connect with PDO.
*
* @throws Exception
*/
private function connect()
{
try {
$options = array_replace_recursive([
PDO::ATTR_PERSISTENT => true,
PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
// Don't convert empty strings to SQL NULL values on data fetches.
PDO::ATTR_ORACLE_NULLS => PDO::NULL_NATURAL,
PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => false,
], $this->pdoOptions);
$this->conn = new PDO($this->dsn, $this->user, $this->pass, $options);
} catch (PDOException $e) {
$message = sprintf("Connection to %s failed with message: %s", $this->host, $e->getMessage());
throw new Exception($message);
}
$this->db = $this->getAdapter();
}
public function getAdapter(): TypeAdapterInterface
{
return new self::$adapterClass($this->conn, $this->settings);
}
private function write(string $data): int
{
return $this->io->write($data);
}
/**
* Primary function, triggers dumping.
*
* @param string|null $filename Name of file to write sql dump to
* @throws Exception
*/
public function start(?string $filename = '')
{
$destination = 'php://stdout';
// Output file can be redefined here
if (!empty($filename)) {
$destination = $filename;
}
// Connect to database
$this->connect();
// Create a new compressManager to manage compressed output
$this->io = CompressManagerFactory::create($this->settings->getCompressMethod());
// Create output file
$this->io->open($destination);
// Write some basic info to output file
if (!$this->settings->skipComments()) {
$this->write($this->getDumpFileHeader());
}
// Initiate a transaction at global level to create a consistent snapshot.
if ($this->settings->isEnabled('single-transaction')) {
$this->conn->exec($this->db->setupTransaction());
$this->conn->exec($this->db->startTransaction());
}
// Store server settings and use saner defaults to dump
$this->write($this->db->backupParameters());
if ($this->settings->isEnabled('databases')) {
$this->write($this->db->getDatabaseHeader($this->dbName));
if ($this->settings->isEnabled('add-drop-database')) {
$this->write($this->db->addDropDatabase($this->dbName));
}
}
// Get table, view, trigger, procedures, functions and events structures from database.
$this->getDatabaseStructureTables();
$this->getDatabaseStructureViews();
$this->getDatabaseStructureTriggers();
$this->getDatabaseStructureProcedures();
$this->getDatabaseStructureFunctions();
$this->getDatabaseStructureEvents();
if ($this->settings->isEnabled('databases')) {
$this->write($this->db->databases($this->dbName));
}
// If there still are some tables/views in include-tables array, that means that some tables or views weren't
// found. Give proper error and exit. This check will be removed once include-tables supports regexps.
if (0 < count($this->settings->getIncludedTables())) {
$name = implode(',', $this->settings->getIncludedTables());
$message = sprintf("Table '%s' not found in database", $name);
throw new Exception($message);
}
$this->exportTables();
$this->exportTriggers();
$this->exportFunctions();
$this->exportProcedures();
$this->exportViews();
$this->exportEvents();
// Restore saved parameters.
$this->write($this->db->restoreParameters());
// End transaction.
if ($this->settings->isEnabled('single-transaction')) {
$this->conn->exec($this->db->commitTransaction());
}
// Write some stats to output file.
if (!$this->settings->skipComments()) {
$this->write($this->getDumpFileFooter());
}
// Close output file.
$this->io->close();
}
/**
* Returns header for dump file.
*/
private function getDumpFileHeader(): string
{
// Some info about software, source and time
$header = sprintf(
"-- mysqldump-php https://github.com/druidfi/mysqldump-php" . PHP_EOL .
"--" . PHP_EOL .
"-- Host: %s\tDatabase: %s" . PHP_EOL .
"-- ------------------------------------------------------" . PHP_EOL,
$this->host,
$this->dbName
);
if (!empty($version = $this->db->getVersion())) {
$header .= "-- Server version \t" . $version . PHP_EOL;
}
if (!$this->settings->skipDumpDate()) {
$header .= "-- Date: " . date('r') . PHP_EOL . PHP_EOL;
}
return $header;
}
/**
* Returns footer for dump file.
*/
private function getDumpFileFooter(): string
{
$footer = '-- Dump completed';
if (!$this->settings->skipDumpDate()) {
$footer .= ' on: ' . date('r');
}
$footer .= PHP_EOL;
return $footer;
}
/**
* Reads table names from database. Fills $this->tables array so they will be dumped later.
*/
private function getDatabaseStructureTables()
{
$includedTables = $this->settings->getIncludedTables();
// Listing all tables from database
if (empty($includedTables)) {
// include all tables for now, blacklisting happens later
foreach ($this->conn->query($this->db->showTables($this->dbName)) as $row) {
$this->tables[] = current($row);
}
} else {
// include only the tables mentioned in include-tables
foreach ($this->conn->query($this->db->showTables($this->dbName)) as $row) {
if (in_array(current($row), $includedTables, true)) {
$this->tables[] = current($row);
$elem = array_search(current($row), $includedTables);
unset($includedTables[$elem]);
$this->settings->setIncludedTables($includedTables);
}
}
}
}
/**
* Reads view names from database. Fills $this->tables array so they will be dumped later.
*/
private function getDatabaseStructureViews()
{
$includedViews = $this->settings->getIncludedViews();
// Listing all views from database
if (empty($includedViews)) {
// include all views for now, blacklisting happens later
foreach ($this->conn->query($this->db->showViews($this->dbName)) as $row) {
$this->views[] = current($row);
}
} else {
// include only the tables mentioned in include-tables
foreach ($this->conn->query($this->db->showViews($this->dbName)) as $row) {
if (in_array(current($row), $includedViews, true)) {
$this->views[] = current($row);
$elem = array_search(current($row), $includedViews);
unset($includedViews[$elem]);
}
}
}
}
/**
* Reads trigger names from database. Fills $this->tables array so they will be dumped later.
*/
private function getDatabaseStructureTriggers()
{
// Listing all triggers from database
if (!$this->settings->skipTriggers()) {
foreach ($this->conn->query($this->db->showTriggers($this->dbName)) as $row) {
$this->triggers[] = $row['Trigger'];
}
}
}
/**
* Reads procedure names from database. Fills $this->tables array so they will be dumped later.
*/
private function getDatabaseStructureProcedures()
{
// Listing all procedures from database
if ($this->settings->isEnabled('routines')) {
foreach ($this->conn->query($this->db->showProcedures($this->dbName)) as $row) {
$this->procedures[] = $row['procedure_name'];
}
}
}
/**
* Reads functions names from database. Fills $this->tables array so they will be dumped later.
*/
private function getDatabaseStructureFunctions()
{
// Listing all functions from database
if ($this->settings->isEnabled('routines')) {
foreach ($this->conn->query($this->db->showFunctions($this->dbName)) as $row) {
$this->functions[] = $row['function_name'];
}
}
}
/**
* Reads event names from database. Fills $this->tables array so they will be dumped later.
*/
private function getDatabaseStructureEvents()
{
// Listing all events from database
if ($this->settings->isEnabled('events')) {
foreach ($this->conn->query($this->db->showEvents($this->dbName)) as $row) {
$this->events[] = $row['event_name'];
}
}
}
/**
* Compare if $table name matches with a definition inside $arr.
*/
private function matches(string $table, array $arr): bool
{
$match = false;
foreach ($arr as $pattern) {
if ('/' != $pattern[0]) {
continue;
}
if (1 == preg_match($pattern, $table)) {
$match = true;
}
}
return in_array($table, $arr) || $match;
}
/**
* Exports all the tables selected from database
*/
private function exportTables()
{
// Exporting tables one by one
foreach ($this->tables as $table) {
if ($this->matches($table, $this->settings->getExcludedTables())) {
continue;
}
$this->getTableStructure($table);
$no_data = $this->settings->isEnabled('no-data');
if (!$no_data) { // don't break compatibility with old trigger
$this->listValues($table);
} elseif ($no_data || $this->matches($table, $this->settings->getNoData())) {
continue;
} else {
$this->listValues($table);
}
}
}
/**
* Exports all the views found in database.
*/
private function exportViews()
{
if (false === $this->settings->isEnabled('no-create-info')) {
// Exporting views one by one
foreach ($this->views as $view) {
if ($this->matches($view, $this->settings->getExcludedTables())) {
continue;
}
$this->tableColumnTypes[$view] = $this->getTableColumnTypes($view);
$this->getViewStructureTable($view);
}
foreach ($this->views as $view) {
if ($this->matches($view, $this->settings->getExcludedTables())) {
continue;
}
$this->getViewStructureView($view);
}
}
}
/**
* Exports all the triggers found in database.
*/
private function exportTriggers()
{
foreach ($this->triggers as $trigger) {
$this->getTriggerStructure($trigger);
}
}
/**
* Exports all the procedures found in database.
*/
private function exportProcedures()
{
foreach ($this->procedures as $procedure) {
$this->getProcedureStructure($procedure);
}
}
/**
* Exports all the functions found in database.
*/
private function exportFunctions()
{
foreach ($this->functions as $function) {
$this->getFunctionStructure($function);
}
}
/**
* Exports all the events found in database.
* @throws Exception
*/
private function exportEvents()
{
foreach ($this->events as $event) {
$this->getEventStructure($event);
}
}
/**
* Table structure extractor.
*
* @param string $tableName Name of table to export
*/
private function getTableStructure(string $tableName)
{
if (!$this->settings->isEnabled('no-create-info')) {
$ret = '';
if (!$this->settings->skipComments()) {
$ret = sprintf(
"--" . PHP_EOL .
"-- Table structure for table `%s`" . PHP_EOL .
"--" . PHP_EOL . PHP_EOL,
$tableName
);
}
$stmt = $this->db->showCreateTable($tableName);
foreach ($this->conn->query($stmt) as $r) {
$this->write($ret);
if ($this->settings->isEnabled('add-drop-table')) {
$this->write($this->db->dropTable($tableName));
}
$this->write($this->db->createTable($r));
break;
}
}
$this->tableColumnTypes[$tableName] = $this->getTableColumnTypes($tableName);
}
/**
* Store column types to create data dumps and for Stand-In tables.
*
* @param string $tableName Name of table to export
* @return array type column types detailed
*/
private function getTableColumnTypes(string $tableName): array
{
$columnTypes = [];
$columns = $this->conn->query($this->db->showColumns($tableName));
$columns->setFetchMode(PDO::FETCH_ASSOC);
foreach ($columns as $col) {
$types = $this->db->parseColumnType($col);
$columnTypes[$col['Field']] = [
'is_numeric' => $types['is_numeric'],
'is_blob' => $types['is_blob'],
'type' => $types['type'],
'type_sql' => $col['Type'],
'is_virtual' => $types['is_virtual']
];
}
return $columnTypes;
}
/**
* View structure extractor, create table (avoids cyclic references).
*
* @param string $viewName Name of view to export
*/
private function getViewStructureTable(string $viewName)
{
if (!$this->settings->skipComments()) {
$ret = (
'--' . PHP_EOL .
sprintf('-- Stand-In structure for view `%s`', $viewName) . PHP_EOL .
'--' . PHP_EOL . PHP_EOL
);
$this->write($ret);
}
$stmt = $this->db->showCreateView($viewName);
// create views as tables, to resolve dependencies
foreach ($this->conn->query($stmt) as $r) {
if ($this->settings->isEnabled('add-drop-table')) {
$this->write($this->db->dropView($viewName));
}
$this->write($this->createStandInTable($viewName));
break;
}
}
/**
* Write a create table statement for the table Stand-In, show create
* table would return a create algorithm when used on a view.
*
* @param string $viewName Name of view to export
* @return string create statement
*/
private function createStandInTable(string $viewName): string
{
$ret = [];
foreach ($this->tableColumnTypes[$viewName] as $k => $v) {
$ret[] = sprintf('`%s` %s', $k, $v['type_sql']);
}
$ret = implode(PHP_EOL . ',', $ret);
return sprintf(
"CREATE TABLE IF NOT EXISTS `%s` (" . PHP_EOL . "%s" . PHP_EOL . ");" . PHP_EOL,
$viewName,
$ret
);
}
/**
* View structure extractor, create view.
*/
private function getViewStructureView(string $viewName)
{
if (!$this->settings->skipComments()) {
$ret = sprintf(
"--" . PHP_EOL .
"-- View structure for view `%s`" . PHP_EOL .
"--" . PHP_EOL . PHP_EOL,
$viewName
);
$this->write($ret);
}
$stmt = $this->db->showCreateView($viewName);
// Create views, to resolve dependencies replacing tables with views
foreach ($this->conn->query($stmt) as $r) {
// Because we must replace table with view, we should delete it
$this->write($this->db->dropView($viewName));
$this->write($this->db->createView($r));
break;
}
}
/**
* Trigger structure extractor.
*
* @param string $triggerName Name of trigger to export
*/
private function getTriggerStructure(string $triggerName)
{
$stmt = $this->db->showCreateTrigger($triggerName);
foreach ($this->conn->query($stmt) as $r) {
if ($this->settings->isEnabled('add-drop-trigger')) {
$this->write($this->db->addDropTrigger($triggerName));
}
$this->write($this->db->createTrigger($r));
return;
}
}
/**
* Procedure structure extractor.
*
* @param string $procedureName Name of procedure to export
*/
private function getProcedureStructure(string $procedureName)
{
if (!$this->settings->skipComments()) {
$ret = "--" . PHP_EOL .
"-- Dumping routines for database '" . $this->dbName . "'" . PHP_EOL .
"--" . PHP_EOL . PHP_EOL;
$this->write($ret);
}
$stmt = $this->db->showCreateProcedure($procedureName);
foreach ($this->conn->query($stmt) as $r) {
$this->write($this->db->createProcedure($r));
return;
}
}
/**
* Function structure extractor.
*
* @param string $functionName Name of function to export
*/
private function getFunctionStructure(string $functionName)
{
if (!$this->settings->skipComments()) {
$ret = "--" . PHP_EOL .
"-- Dumping routines for database '" . $this->dbName . "'" . PHP_EOL .
"--" . PHP_EOL . PHP_EOL;
$this->write($ret);
}
$stmt = $this->db->showCreateFunction($functionName);
foreach ($this->conn->query($stmt) as $r) {
$this->write($this->db->createFunction($r));
return;
}
}
/**
* Event structure extractor.
*
* @param string $eventName Name of event to export
* @throws Exception
*/
private function getEventStructure(string $eventName)
{
if (!$this->settings->skipComments()) {
$ret = "--" . PHP_EOL .
"-- Dumping events for database '" . $this->dbName . "'" . PHP_EOL .
"--" . PHP_EOL . PHP_EOL;
$this->write($ret);
}
$stmt = $this->db->showCreateEvent($eventName);
foreach ($this->conn->query($stmt) as $r) {
$this->write($this->db->createEvent($r));
return;
}
}
/**
* Prepare values for output.
*
* @param string $tableName Name of table which contains rows
* @param array $row Associative array of column names and values to be quoted
*/
private function prepareColumnValues(string $tableName, array $row): array
{
$ret = [];
$columnTypes = $this->tableColumnTypes[$tableName];
if ($this->transformTableRowCallable) {
$row = call_user_func($this->transformTableRowCallable, $tableName, $row);
}
foreach ($row as $colName => $colValue) {
if ($this->transformColumnValueCallable) {
$colValue = call_user_func($this->transformColumnValueCallable, $tableName, $colName, $colValue, $row);
}
$ret[] = $this->escape($colValue, $columnTypes[$colName]);
}
return $ret;
}
/**
* Escape values with quotes when needed.
*/
private function escape(?string $colValue, array $colType)
{
if (is_null($colValue)) {
return 'NULL';
} elseif ($this->settings->isEnabled('hex-blob') && $colType['is_blob']) {
if ($colType['type'] == 'bit' || !empty($colValue)) {
return sprintf('0x%s', $colValue);
} else {
return "''";
}
} elseif ($colType['is_numeric']) {
return $colValue;
}
return $this->conn->quote($colValue);
}
/**
* Table rows extractor.
*
* @param string $tableName Name of table to export
*/
private function listValues(string $tableName)
{
$this->prepareListValues($tableName);
$onlyOnce = true;
$lineSize = 0;
$colNames = [];
// getting the column statement has side effect, so we backup this setting for consitency
$completeInsertBackup = $this->settings->isEnabled('complete-insert');
// colStmt is used to form a query to obtain row values
$colStmt = $this->getColumnStmt($tableName);
// colNames is used to get the name of the columns when using complete-insert
if ($this->settings->isEnabled('complete-insert')) {
$colNames = $this->getColumnNames($tableName);
}
$stmt = "SELECT " . implode(",", $colStmt) . " FROM `$tableName`";
// Table specific conditions override the default 'where'
$condition = $this->getTableWhere($tableName);
if ($condition) {
$stmt .= sprintf(' WHERE %s', $condition);
}
if ($limit = $this->getTableLimit($tableName)) {
$stmt .= is_numeric($limit) ?
sprintf(' LIMIT %d', $limit) :
sprintf(' LIMIT %s', $limit);
}
$resultSet = $this->conn->query($stmt);
$resultSet->setFetchMode(PDO::FETCH_ASSOC);
$ignore = $this->settings->isEnabled('insert-ignore') ? ' IGNORE' : '';
$count = 0;
foreach ($resultSet as $row) {
$count++;
$values = $this->prepareColumnValues($tableName, $row);
$valueList = implode(',', $values);
if ($onlyOnce || !$this->settings->isEnabled('extended-insert')) {
if ($this->settings->isEnabled('complete-insert') && count($colNames)) {
$lineSize += $this->write(sprintf(
'INSERT%s INTO `%s` (%s) VALUES (%s)',
$ignore,
$tableName,
implode(', ', $colNames),
$valueList
));
} else {
$lineSize += $this->write(
sprintf('INSERT%s INTO `%s` VALUES (%s)', $ignore, $tableName, $valueList)
);
}
$onlyOnce = false;
} else {
$lineSize += $this->write(sprintf(',(%s)', $valueList));
}
if (($lineSize > $this->settings->getNetBufferLength())
|| !$this->settings->isEnabled('extended-insert')) {
$onlyOnce = true;
$lineSize = $this->write(';' . PHP_EOL);
}
}
$resultSet->closeCursor();
if (!$onlyOnce) {
$this->write(';' . PHP_EOL);
}
$this->endListValues($tableName, $count);
if ($this->infoCallable && is_callable($this->infoCallable)) {
call_user_func($this->infoCallable, 'table', ['name' => $tableName, 'rowCount' => $count]);
}
$this->settings->setCompleteInsert($completeInsertBackup);
}
/**
* Table rows extractor, append information prior to dump.
*
* @param string $tableName Name of table to export
*/
private function prepareListValues(string $tableName)
{
if (!$this->settings->skipComments()) {
$this->write(
"--" . PHP_EOL .
"-- Dumping data for table `$tableName`" . PHP_EOL .
"--" . PHP_EOL . PHP_EOL
);
}
if ($this->settings->isEnabled('lock-tables') && !$this->settings->isEnabled('single-transaction')) {
$this->db->lockTable($tableName);
}
if ($this->settings->isEnabled('add-locks')) {
$this->write($this->db->startAddLockTable($tableName));
}
if ($this->settings->isEnabled('disable-keys')) {
$this->write($this->db->startAddDisableKeys($tableName));
}
// Disable autocommit for faster reload
if ($this->settings->isEnabled('no-autocommit')) {
$this->write($this->db->startDisableAutocommit());
}
}
/**
* Table rows extractor, close locks and commits after dump.
*
* @param string $tableName Name of table to export.
* @param integer $count Number of rows inserted.
*/
private function endListValues(string $tableName, int $count = 0)
{
if ($this->settings->isEnabled('disable-keys')) {
$this->write($this->db->endAddDisableKeys($tableName));
}
if ($this->settings->isEnabled('add-locks')) {
$this->write($this->db->endAddLockTable($tableName));
}
if ($this->settings->isEnabled('lock-tables')
&& !$this->settings->isEnabled('single-transaction')) {
$this->db->unlockTable($tableName);
}
// Commit to enable autocommit
if ($this->settings->isEnabled('no-autocommit')) {
$this->write($this->db->endDisableAutocommit());
}
$this->write(PHP_EOL);
if (!$this->settings->skipComments()) {
$this->write(
"-- Dumped table `" . $tableName . "` with $count row(s)" . PHP_EOL .
'--' . PHP_EOL . PHP_EOL
);
}
}
/**
* Build SQL List of all columns on current table which will be used for selecting.
*
* @param string $tableName Name of table to get columns
*
* @return array SQL sentence with columns for select
*/
protected function getColumnStmt(string $tableName): array
{
$colStmt = [];
foreach ($this->tableColumnTypes[$tableName] as $colName => $colType) {
// TODO handle bug where PHP 8.1 returns double field wrong
if ($colType['is_virtual']) {
$this->settings->setCompleteInsert();
} elseif ($colType['type'] == 'double' && PHP_VERSION_ID > 80100) {
$colStmt[] = sprintf("CONCAT(`%s`) AS `%s`", $colName, $colName);
} elseif ($colType['type'] === 'bit' && $this->settings->isEnabled('hex-blob')) {
$colStmt[] = sprintf("LPAD(HEX(`%s`),2,'0') AS `%s`", $colName, $colName);
} elseif ($colType['is_blob'] && $this->settings->isEnabled('hex-blob')) {
$colStmt[] = sprintf("HEX(`%s`) AS `%s`", $colName, $colName);
} else {
$colStmt[] = sprintf("`%s`", $colName);
}
}
return $colStmt;
}
/**
* Build SQL List of all columns on current table which will be used for inserting.
*
* @param string $tableName Name of table to get columns
*
* @return array columns for sql sentence for insert
*/
private function getColumnNames(string $tableName): array
{
$colNames = [];
foreach ($this->tableColumnTypes[$tableName] as $colName => $colType) {
if ($colType['is_virtual']) {
$this->settings->setCompleteInsert();
} else {
$colNames[] = sprintf('`%s`', $colName);
}
}