|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Cycle\Database\Query; |
|
6
|
|
|
|
|
7
|
|
|
use Cycle\Database\Driver\CompilerInterface; |
|
8
|
|
|
use Cycle\Database\Injection\Parameter; |
|
9
|
|
|
|
|
10
|
|
|
class UpsertQuery extends ActiveQuery |
|
11
|
|
|
{ |
|
12
|
|
|
protected string $table; |
|
13
|
|
|
protected array $columns = []; |
|
14
|
|
|
protected array $values = []; |
|
15
|
|
|
protected array $conflicts = []; |
|
16
|
|
|
|
|
17
|
|
|
public function __construct(?string $table = null) |
|
18
|
|
|
{ |
|
19
|
|
|
$this->table = $table ?? ''; |
|
20
|
|
|
} |
|
21
|
|
|
|
|
22
|
|
|
/** |
|
23
|
|
|
* Set upsert target table. |
|
24
|
|
|
* |
|
25
|
|
|
* @psalm-param non-empty-string $into |
|
26
|
|
|
*/ |
|
27
|
|
|
public function into(string $into): self |
|
28
|
|
|
{ |
|
29
|
|
|
$this->table = $into; |
|
30
|
|
|
|
|
31
|
|
|
return $this; |
|
32
|
|
|
} |
|
33
|
|
|
|
|
34
|
|
|
/** |
|
35
|
|
|
* Set upsert column names. Names can be provided as array, set of parameters or comma |
|
36
|
|
|
* separated string. |
|
37
|
|
|
* |
|
38
|
|
|
* Examples: |
|
39
|
|
|
* $upsert->columns(["name", "email"]); |
|
40
|
|
|
* $upsert->columns("name", "email"); |
|
41
|
|
|
* $upsert->columns("name, email"); |
|
42
|
|
|
*/ |
|
43
|
|
|
public function columns(array|string ...$columns): self |
|
44
|
|
|
{ |
|
45
|
|
|
$this->columns = $this->fetchIdentifiers($columns); |
|
46
|
|
|
|
|
47
|
|
|
return $this; |
|
48
|
|
|
} |
|
49
|
|
|
|
|
50
|
|
|
/** |
|
51
|
|
|
* Set upsert rowset values or multiple rowsets. Values can be provided in multiple forms |
|
52
|
|
|
* (method parameters, array of values, array of rowsets). Columns names will be automatically |
|
53
|
|
|
* fetched (if not already specified) from first provided rowset based on rowset keys. |
|
54
|
|
|
* |
|
55
|
|
|
* Examples: |
|
56
|
|
|
* $upsert->columns("name", "balance")->values("Wolfy-J", 10); |
|
57
|
|
|
* $upsert->values([ |
|
58
|
|
|
* "name" => "Wolfy-J", |
|
59
|
|
|
* "balance" => 10 |
|
60
|
|
|
* ]); |
|
61
|
|
|
* $upsert->values([ |
|
62
|
|
|
* [ |
|
63
|
|
|
* "name" => "Wolfy-J", |
|
64
|
|
|
* "balance" => 10 |
|
65
|
|
|
* ], |
|
66
|
|
|
* [ |
|
67
|
|
|
* "name" => "Ben", |
|
68
|
|
|
* "balance" => 20 |
|
69
|
|
|
* ] |
|
70
|
|
|
* ]); |
|
71
|
|
|
*/ |
|
72
|
|
|
public function values(mixed $rowsets): self |
|
73
|
|
|
{ |
|
74
|
|
|
if (!\is_array($rowsets)) { |
|
75
|
|
|
return $this->values(\func_get_args()); |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
|
|
if ($rowsets === []) { |
|
79
|
|
|
return $this; |
|
80
|
|
|
} |
|
81
|
|
|
|
|
82
|
|
|
//Checking if provided set is array of multiple |
|
83
|
|
|
\reset($rowsets); |
|
84
|
|
|
|
|
85
|
|
|
if (!\is_array($rowsets[\key($rowsets)])) { |
|
86
|
|
|
if ($this->columns === []) { |
|
87
|
|
|
$this->columns = \array_keys($rowsets); |
|
88
|
|
|
} |
|
89
|
|
|
|
|
90
|
|
|
$this->values[] = new Parameter(\array_values($rowsets)); |
|
91
|
|
|
} else { |
|
92
|
|
|
if ($this->columns === []) { |
|
93
|
|
|
$this->columns = \array_keys($rowsets[\key($rowsets)]); |
|
94
|
|
|
} |
|
95
|
|
|
|
|
96
|
|
|
foreach ($rowsets as $values) { |
|
97
|
|
|
$this->values[] = new Parameter(\array_values($values)); |
|
98
|
|
|
} |
|
99
|
|
|
} |
|
100
|
|
|
|
|
101
|
|
|
return $this; |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
|
|
/** |
|
105
|
|
|
* Set upsert conflicting index column names. Names can be provided as array, set of parameters or comma |
|
106
|
|
|
* separated string. |
|
107
|
|
|
* |
|
108
|
|
|
* Examples: |
|
109
|
|
|
* $upsert->conflicts(["identifier", "email"]); |
|
110
|
|
|
* $upsert->conflicts("identifier", "email"); |
|
111
|
|
|
* $upsert->conflicts("identifier, email"); |
|
112
|
|
|
*/ |
|
113
|
|
|
public function conflicts(array|string ...$conflicts): self |
|
114
|
|
|
{ |
|
115
|
|
|
$this->conflicts = $this->fetchIdentifiers($conflicts); |
|
116
|
|
|
|
|
117
|
|
|
return $this; |
|
118
|
|
|
} |
|
119
|
|
|
|
|
120
|
|
|
/** |
|
121
|
|
|
* Run the query and return last insert id. |
|
122
|
|
|
* Returns an assoc array of values if multiple columns were specified as returning columns. |
|
123
|
|
|
* |
|
124
|
|
|
* @return array<non-empty-string, mixed>|int|non-empty-string|null |
|
|
|
|
|
|
125
|
|
|
*/ |
|
126
|
|
|
public function run(): mixed |
|
127
|
|
|
{ |
|
128
|
|
|
$params = new QueryParameters(); |
|
129
|
|
|
$queryString = $this->sqlStatement($params); |
|
130
|
|
|
|
|
131
|
|
|
$this->driver->execute( |
|
|
|
|
|
|
132
|
|
|
$queryString, |
|
133
|
|
|
$params->getParameters(), |
|
134
|
|
|
); |
|
135
|
|
|
|
|
136
|
|
|
$lastID = $this->driver->lastInsertID(); |
|
137
|
|
|
if (\is_numeric($lastID)) { |
|
138
|
|
|
return (int) $lastID; |
|
139
|
|
|
} |
|
140
|
|
|
|
|
141
|
|
|
return $lastID; |
|
142
|
|
|
} |
|
143
|
|
|
|
|
144
|
|
|
public function getType(): int |
|
145
|
|
|
{ |
|
146
|
|
|
return CompilerInterface::UPSERT_QUERY; |
|
147
|
|
|
} |
|
148
|
|
|
|
|
149
|
|
|
public function getTokens(): array |
|
150
|
|
|
{ |
|
151
|
|
|
return [ |
|
152
|
|
|
'table' => $this->table, |
|
153
|
|
|
'columns' => $this->columns, |
|
154
|
|
|
'values' => $this->values, |
|
155
|
|
|
'conflicts' => $this->conflicts, |
|
156
|
|
|
]; |
|
157
|
|
|
} |
|
158
|
|
|
} |
|
159
|
|
|
|