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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\DB;
use Magento\Framework\DB\Adapter\AdapterInterface;
use Magento\Framework\DB\DataConverter\DataConversionException;
use Magento\Framework\DB\DataConverter\DataConverterInterface;
use Magento\Framework\DB\Query\Generator;
use Magento\Framework\DB\Select\QueryModifierInterface;
/**
* Convert field data from one representation to another
*/
class FieldDataConverter
{
/**
* Batch size env variable name
*/
const BATCH_SIZE_VARIABLE_NAME = 'DATA_CONVERTER_BATCH_SIZE';
/**
* Default batch size
*/
const DEFAULT_BATCH_SIZE = 50000;
/**
* @var Generator
*/
private $queryGenerator;
/**
* @var DataConverterInterface
*/
private $dataConverter;
/**
* @var SelectFactory
*/
private $selectFactory;
/**
* @var string|null
*/
private $envBatchSize;
/**
* Constructor
*
* @param Generator $queryGenerator
* @param DataConverterInterface $dataConverter
* @param SelectFactory $selectFactory
* @param string|null $envBatchSize
*/
public function __construct(
Generator $queryGenerator,
DataConverterInterface $dataConverter,
SelectFactory $selectFactory,
$envBatchSize = null
) {
$this->queryGenerator = $queryGenerator;
$this->dataConverter = $dataConverter;
$this->selectFactory = $selectFactory;
$this->envBatchSize = $envBatchSize;
}
/**
* Convert table field data from one representation to another
*
* @param AdapterInterface $connection
* @param string $table
* @param string $identifier
* @param string $field
* @param QueryModifierInterface|null $queryModifier
* @throws FieldDataConversionException
* @return void
*/
public function convert(
AdapterInterface $connection,
$table,
$identifier,
$field,
QueryModifierInterface $queryModifier = null
) {
$select = $this->selectFactory->create($connection)
->from($table, [$identifier, $field])
->where($field . ' IS NOT NULL');
if ($queryModifier) {
$queryModifier->modify($select);
}
$iterator = $this->queryGenerator->generate($identifier, $select, $this->getBatchSize());
foreach ($iterator as $selectByRange) {
$rows = $connection->fetchPairs($selectByRange);
$uniqueFieldDataArray = array_unique($rows);
foreach ($uniqueFieldDataArray as $uniqueFieldData) {
$ids = array_keys($rows, $uniqueFieldData);
try {
$convertedValue = $this->dataConverter->convert($uniqueFieldData);
if ($uniqueFieldData === $convertedValue) {
// Skip for data rows that have been already converted
continue;
}
$bind = [$field => $convertedValue];
$where = [$identifier . ' IN (?)' => $ids];
$connection->update($table, $bind, $where);
} catch (DataConversionException $e) {
throw new \Magento\Framework\DB\FieldDataConversionException(
sprintf(
\Magento\Framework\DB\FieldDataConversionException::MESSAGE_PATTERN,
$field,
$table,
$identifier,
implode(', ', $ids),
get_class($this->dataConverter),
$e->getMessage()
)
);
}
}
}
}
/**
* Get batch size from environment variable or default
*
* @return int
*/
private function getBatchSize()
{
if (null !== $this->envBatchSize) {
$batchSize = (int) $this->envBatchSize;
if (bccomp($this->envBatchSize, PHP_INT_MAX, 0) === 1 || $batchSize < 1) {
throw new \InvalidArgumentException(
'Invalid value for environment variable ' . self::BATCH_SIZE_VARIABLE_NAME . '. '
. 'Should be integer, >= 1 and < value of PHP_INT_MAX'
);
}
return $batchSize;
}
return self::DEFAULT_BATCH_SIZE;
}
}