1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* @link http://www.yiiframework.com/ |
4
|
|
|
* @copyright Copyright (c) 2008 Yii Software LLC |
5
|
|
|
* @license http://www.yiiframework.com/license/ |
6
|
|
|
*/ |
7
|
|
|
|
8
|
|
|
namespace yii\db\oci; |
9
|
|
|
|
10
|
|
|
use yii\base\InvalidArgumentException; |
11
|
|
|
use yii\db\Connection; |
12
|
|
|
use yii\db\Constraint; |
13
|
|
|
use yii\db\Exception; |
14
|
|
|
use yii\db\Expression; |
15
|
|
|
use yii\db\Query; |
16
|
|
|
use yii\helpers\StringHelper; |
17
|
|
|
|
18
|
|
|
/** |
19
|
|
|
* QueryBuilder is the query builder for Oracle databases. |
20
|
|
|
* |
21
|
|
|
* @author Qiang Xue <[email protected]> |
22
|
|
|
* @since 2.0 |
23
|
|
|
*/ |
24
|
|
|
class QueryBuilder extends \yii\db\QueryBuilder |
25
|
|
|
{ |
26
|
|
|
/** |
27
|
|
|
* @var array mapping from abstract column types (keys) to physical column types (values). |
28
|
|
|
*/ |
29
|
|
|
public $typeMap = [ |
30
|
|
|
Schema::TYPE_PK => 'NUMBER(10) NOT NULL PRIMARY KEY', |
31
|
|
|
Schema::TYPE_UPK => 'NUMBER(10) UNSIGNED NOT NULL PRIMARY KEY', |
32
|
|
|
Schema::TYPE_BIGPK => 'NUMBER(20) NOT NULL PRIMARY KEY', |
33
|
|
|
Schema::TYPE_UBIGPK => 'NUMBER(20) UNSIGNED NOT NULL PRIMARY KEY', |
34
|
|
|
Schema::TYPE_CHAR => 'CHAR(1)', |
35
|
|
|
Schema::TYPE_STRING => 'VARCHAR2(255)', |
36
|
|
|
Schema::TYPE_TEXT => 'CLOB', |
37
|
|
|
Schema::TYPE_TINYINT => 'NUMBER(3)', |
38
|
|
|
Schema::TYPE_SMALLINT => 'NUMBER(5)', |
39
|
|
|
Schema::TYPE_INTEGER => 'NUMBER(10)', |
40
|
|
|
Schema::TYPE_BIGINT => 'NUMBER(20)', |
41
|
|
|
Schema::TYPE_FLOAT => 'NUMBER', |
42
|
|
|
Schema::TYPE_DOUBLE => 'NUMBER', |
43
|
|
|
Schema::TYPE_DECIMAL => 'NUMBER', |
44
|
|
|
Schema::TYPE_DATETIME => 'TIMESTAMP', |
45
|
|
|
Schema::TYPE_TIMESTAMP => 'TIMESTAMP', |
46
|
|
|
Schema::TYPE_TIME => 'TIMESTAMP', |
47
|
|
|
Schema::TYPE_DATE => 'DATE', |
48
|
|
|
Schema::TYPE_BINARY => 'BLOB', |
49
|
|
|
Schema::TYPE_BOOLEAN => 'NUMBER(1)', |
50
|
|
|
Schema::TYPE_MONEY => 'NUMBER(19,4)', |
51
|
|
|
]; |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* {@inheritdoc} |
55
|
|
|
*/ |
56
|
|
|
protected function defaultExpressionBuilders() |
57
|
|
|
{ |
58
|
|
|
return array_merge(parent::defaultExpressionBuilders(), [ |
59
|
|
|
'yii\db\conditions\InCondition' => 'yii\db\oci\conditions\InConditionBuilder', |
60
|
|
|
'yii\db\conditions\LikeCondition' => 'yii\db\oci\conditions\LikeConditionBuilder', |
61
|
|
|
]); |
62
|
|
|
} |
63
|
|
|
|
64
|
|
|
/** |
65
|
|
|
* {@inheritdoc} |
66
|
|
|
*/ |
67
|
|
|
public function buildOrderByAndLimit($sql, $orderBy, $limit, $offset) |
68
|
|
|
{ |
69
|
|
|
$orderBy = $this->buildOrderBy($orderBy); |
|
|
|
|
70
|
|
|
if ($orderBy !== '') { |
71
|
|
|
$sql .= $this->separator . $orderBy; |
72
|
|
|
} |
73
|
|
|
|
74
|
|
|
$filters = []; |
75
|
|
|
if ($this->hasOffset($offset)) { |
76
|
|
|
$filters[] = 'rowNumId > ' . $offset; |
77
|
|
|
} |
78
|
|
|
if ($this->hasLimit($limit)) { |
79
|
|
|
$filters[] = 'rownum <= ' . $limit; |
80
|
|
|
} |
81
|
|
|
if (empty($filters)) { |
82
|
|
|
return $sql; |
83
|
|
|
} |
84
|
|
|
|
85
|
|
|
$filter = implode(' AND ', $filters); |
86
|
|
|
return <<<EOD |
87
|
|
|
WITH USER_SQL AS ($sql), |
88
|
|
|
PAGINATION AS (SELECT USER_SQL.*, rownum as rowNumId FROM USER_SQL) |
89
|
|
|
SELECT * |
90
|
|
|
FROM PAGINATION |
91
|
|
|
WHERE $filter |
92
|
|
|
EOD; |
93
|
|
|
} |
94
|
|
|
|
95
|
|
|
/** |
96
|
|
|
* Builds a SQL statement for renaming a DB table. |
97
|
|
|
* |
98
|
|
|
* @param string $table the table to be renamed. The name will be properly quoted by the method. |
99
|
|
|
* @param string $newName the new table name. The name will be properly quoted by the method. |
100
|
|
|
* @return string the SQL statement for renaming a DB table. |
101
|
|
|
*/ |
102
|
|
|
public function renameTable($table, $newName) |
103
|
|
|
{ |
104
|
|
|
return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' RENAME TO ' . $this->db->quoteTableName($newName); |
105
|
|
|
} |
106
|
|
|
|
107
|
|
|
/** |
108
|
|
|
* Builds a SQL statement for changing the definition of a column. |
109
|
|
|
* |
110
|
|
|
* @param string $table the table whose column is to be changed. The table name will be properly quoted by the method. |
111
|
|
|
* @param string $column the name of the column to be changed. The name will be properly quoted by the method. |
112
|
|
|
* @param string $type the new column type. The [[getColumnType]] method will be invoked to convert abstract column type (if any) |
113
|
|
|
* into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL. |
114
|
|
|
* For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'. |
115
|
|
|
* @return string the SQL statement for changing the definition of a column. |
116
|
|
|
*/ |
117
|
|
|
public function alterColumn($table, $column, $type) |
118
|
|
|
{ |
119
|
|
|
$type = $this->getColumnType($type); |
120
|
|
|
|
121
|
|
|
return 'ALTER TABLE ' . $this->db->quoteTableName($table) . ' MODIFY ' . $this->db->quoteColumnName($column) . ' ' . $this->getColumnType($type); |
122
|
|
|
} |
123
|
|
|
|
124
|
|
|
/** |
125
|
|
|
* Builds a SQL statement for dropping an index. |
126
|
|
|
* |
127
|
|
|
* @param string $name the name of the index to be dropped. The name will be properly quoted by the method. |
128
|
|
|
* @param string $table the table whose index is to be dropped. The name will be properly quoted by the method. |
129
|
|
|
* @return string the SQL statement for dropping an index. |
130
|
|
|
*/ |
131
|
|
|
public function dropIndex($name, $table) |
132
|
|
|
{ |
133
|
|
|
return 'DROP INDEX ' . $this->db->quoteTableName($name); |
134
|
|
|
} |
135
|
|
|
|
136
|
|
|
/** |
137
|
|
|
* {@inheritdoc} |
138
|
|
|
*/ |
139
|
|
|
public function resetSequence($table, $value = null) |
140
|
|
|
{ |
141
|
|
|
$tableSchema = $this->db->getTableSchema($table); |
142
|
|
|
if ($tableSchema === null) { |
143
|
|
|
throw new InvalidArgumentException("Unknown table: $table"); |
144
|
|
|
} |
145
|
|
|
if ($tableSchema->sequenceName === null) { |
146
|
|
|
return ''; |
147
|
|
|
} |
148
|
|
|
|
149
|
|
|
if ($value !== null) { |
150
|
|
|
$value = (int) $value; |
151
|
|
|
} else { |
152
|
|
|
// use master connection to get the biggest PK value |
153
|
|
|
$value = $this->db->useMaster(function (Connection $db) use ($tableSchema) { |
154
|
|
|
return $db->createCommand("SELECT MAX(\"{$tableSchema->primaryKey}\") FROM \"{$tableSchema->name}\"")->queryScalar(); |
155
|
|
|
}) + 1; |
156
|
|
|
} |
157
|
|
|
|
158
|
|
|
return "DROP SEQUENCE \"{$tableSchema->name}_SEQ\";" |
159
|
|
|
. "CREATE SEQUENCE \"{$tableSchema->name}_SEQ\" START WITH {$value} INCREMENT BY 1 NOMAXVALUE NOCACHE"; |
160
|
|
|
} |
161
|
|
|
|
162
|
|
|
/** |
163
|
|
|
* {@inheritdoc} |
164
|
|
|
*/ |
165
|
|
|
public function addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null) |
166
|
|
|
{ |
167
|
|
|
$sql = 'ALTER TABLE ' . $this->db->quoteTableName($table) |
168
|
|
|
. ' ADD CONSTRAINT ' . $this->db->quoteColumnName($name) |
169
|
|
|
. ' FOREIGN KEY (' . $this->buildColumns($columns) . ')' |
170
|
|
|
. ' REFERENCES ' . $this->db->quoteTableName($refTable) |
171
|
|
|
. ' (' . $this->buildColumns($refColumns) . ')'; |
172
|
|
|
if ($delete !== null) { |
173
|
|
|
$sql .= ' ON DELETE ' . $delete; |
174
|
|
|
} |
175
|
|
|
if ($update !== null) { |
176
|
|
|
throw new Exception('Oracle does not support ON UPDATE clause.'); |
177
|
|
|
} |
178
|
|
|
|
179
|
|
|
return $sql; |
180
|
|
|
} |
181
|
|
|
|
182
|
|
|
/** |
183
|
|
|
* {@inheritdoc} |
184
|
|
|
*/ |
185
|
|
|
protected function prepareInsertValues($table, $columns, $params = []) |
186
|
|
|
{ |
187
|
|
|
list($names, $placeholders, $values, $params) = parent::prepareInsertValues($table, $columns, $params); |
188
|
|
|
if (!$columns instanceof Query && empty($names)) { |
189
|
|
|
$tableSchema = $this->db->getSchema()->getTableSchema($table); |
190
|
|
|
if ($tableSchema !== null) { |
191
|
|
|
$columns = !empty($tableSchema->primaryKey) ? $tableSchema->primaryKey : [reset($tableSchema->columns)->name]; |
192
|
|
|
foreach ($columns as $name) { |
193
|
|
|
$names[] = $this->db->quoteColumnName($name); |
194
|
|
|
$placeholders[] = 'DEFAULT'; |
195
|
|
|
} |
196
|
|
|
} |
197
|
|
|
} |
198
|
|
|
return [$names, $placeholders, $values, $params]; |
199
|
|
|
} |
200
|
|
|
|
201
|
|
|
/** |
202
|
|
|
* @inheritdoc |
203
|
|
|
* @see https://docs.oracle.com/cd/B28359_01/server.111/b28286/statements_9016.htm#SQLRF01606 |
204
|
|
|
*/ |
205
|
|
|
public function upsert($table, $insertColumns, $updateColumns, &$params) |
206
|
|
|
{ |
207
|
|
|
/** @var Constraint[] $constraints */ |
208
|
|
|
list($uniqueNames, $insertNames, $updateNames) = $this->prepareUpsertColumns($table, $insertColumns, $updateColumns, $constraints); |
209
|
|
|
if (empty($uniqueNames)) { |
210
|
|
|
return $this->insert($table, $insertColumns, $params); |
211
|
|
|
} |
212
|
|
|
|
213
|
|
|
$onCondition = ['or']; |
214
|
|
|
$quotedTableName = $this->db->quoteTableName($table); |
215
|
|
|
foreach ($constraints as $constraint) { |
216
|
|
|
$constraintCondition = ['and']; |
217
|
|
|
foreach ($constraint->columnNames as $name) { |
|
|
|
|
218
|
|
|
$quotedName = $this->db->quoteColumnName($name); |
219
|
|
|
$constraintCondition[] = "$quotedTableName.$quotedName=\"EXCLUDED\".$quotedName"; |
220
|
|
|
} |
221
|
|
|
$onCondition[] = $constraintCondition; |
222
|
|
|
} |
223
|
|
|
$on = $this->buildCondition($onCondition, $params); |
224
|
|
|
list(, $placeholders, $values, $params) = $this->prepareInsertValues($table, $insertColumns, $params); |
225
|
|
|
if (!empty($placeholders)) { |
226
|
|
|
$usingSelectValues = []; |
227
|
|
|
foreach ($insertNames as $index => $name) { |
228
|
|
|
$usingSelectValues[$name] = new Expression($placeholders[$index]); |
229
|
|
|
} |
230
|
|
|
$usingSubQuery = (new Query()) |
231
|
|
|
->select($usingSelectValues) |
232
|
|
|
->from('DUAL'); |
233
|
|
|
list($usingValues, $params) = $this->build($usingSubQuery, $params); |
234
|
|
|
} |
235
|
|
|
$mergeSql = 'MERGE INTO ' . $this->db->quoteTableName($table) . ' ' |
236
|
|
|
. 'USING (' . (isset($usingValues) ? $usingValues : ltrim($values, ' ')) . ') "EXCLUDED" ' |
237
|
|
|
. 'ON ' . $on; |
238
|
|
|
$insertValues = []; |
239
|
|
|
foreach ($insertNames as $name) { |
240
|
|
|
$quotedName = $this->db->quoteColumnName($name); |
241
|
|
|
if (strrpos($quotedName, '.') === false) { |
242
|
|
|
$quotedName = '"EXCLUDED".' . $quotedName; |
243
|
|
|
} |
244
|
|
|
$insertValues[] = $quotedName; |
245
|
|
|
} |
246
|
|
|
$insertSql = 'INSERT (' . implode(', ', $insertNames) . ')' |
247
|
|
|
. ' VALUES (' . implode(', ', $insertValues) . ')'; |
248
|
|
|
if ($updateColumns === false) { |
249
|
|
|
return "$mergeSql WHEN NOT MATCHED THEN $insertSql"; |
250
|
|
|
} |
251
|
|
|
|
252
|
|
|
if ($updateColumns === true) { |
253
|
|
|
$updateColumns = []; |
254
|
|
|
foreach ($updateNames as $name) { |
255
|
|
|
$quotedName = $this->db->quoteColumnName($name); |
256
|
|
|
if (strrpos($quotedName, '.') === false) { |
257
|
|
|
$quotedName = '"EXCLUDED".' . $quotedName; |
258
|
|
|
} |
259
|
|
|
$updateColumns[$name] = new Expression($quotedName); |
260
|
|
|
} |
261
|
|
|
} |
262
|
|
|
list($updates, $params) = $this->prepareUpdateSets($table, $updateColumns, $params); |
263
|
|
|
$updateSql = 'UPDATE SET ' . implode(', ', $updates); |
264
|
|
|
return "$mergeSql WHEN MATCHED THEN $updateSql WHEN NOT MATCHED THEN $insertSql"; |
265
|
|
|
} |
266
|
|
|
|
267
|
|
|
/** |
268
|
|
|
* Generates a batch INSERT SQL statement. |
269
|
|
|
* |
270
|
|
|
* For example, |
271
|
|
|
* |
272
|
|
|
* ```php |
273
|
|
|
* $sql = $queryBuilder->batchInsert('user', ['name', 'age'], [ |
274
|
|
|
* ['Tom', 30], |
275
|
|
|
* ['Jane', 20], |
276
|
|
|
* ['Linda', 25], |
277
|
|
|
* ]); |
278
|
|
|
* ``` |
279
|
|
|
* |
280
|
|
|
* Note that the values in each row must match the corresponding column names. |
281
|
|
|
* |
282
|
|
|
* @param string $table the table that new rows will be inserted into. |
283
|
|
|
* @param array $columns the column names |
284
|
|
|
* @param array|\Generator $rows the rows to be batch inserted into the table |
285
|
|
|
* @return string the batch INSERT SQL statement |
286
|
|
|
*/ |
287
|
|
|
public function batchInsert($table, $columns, $rows) |
288
|
|
|
{ |
289
|
|
|
if (empty($rows)) { |
290
|
|
|
return ''; |
291
|
|
|
} |
292
|
|
|
|
293
|
|
|
$schema = $this->db->getSchema(); |
294
|
|
|
if (($tableSchema = $schema->getTableSchema($table)) !== null) { |
295
|
|
|
$columnSchemas = $tableSchema->columns; |
296
|
|
|
} else { |
297
|
|
|
$columnSchemas = []; |
298
|
|
|
} |
299
|
|
|
|
300
|
|
|
$values = []; |
301
|
|
|
foreach ($rows as $row) { |
302
|
|
|
$vs = []; |
303
|
|
|
foreach ($row as $i => $value) { |
304
|
|
|
if (isset($columns[$i], $columnSchemas[$columns[$i]])) { |
305
|
|
|
$value = $columnSchemas[$columns[$i]]->dbTypecast($value); |
306
|
|
|
} |
307
|
|
|
if (is_string($value)) { |
308
|
|
|
$value = $schema->quoteValue($value); |
309
|
|
|
} elseif (is_float($value)) { |
310
|
|
|
// ensure type cast always has . as decimal separator in all locales |
311
|
|
|
$value = StringHelper::floatToString($value); |
312
|
|
|
} elseif ($value === false) { |
313
|
|
|
$value = 0; |
314
|
|
|
} elseif ($value === null) { |
315
|
|
|
$value = 'NULL'; |
316
|
|
|
} |
317
|
|
|
$vs[] = $value; |
318
|
|
|
} |
319
|
|
|
$values[] = '(' . implode(', ', $vs) . ')'; |
320
|
|
|
} |
321
|
|
|
if (empty($values)) { |
322
|
|
|
return ''; |
323
|
|
|
} |
324
|
|
|
|
325
|
|
|
foreach ($columns as $i => $name) { |
326
|
|
|
$columns[$i] = $schema->quoteColumnName($name); |
327
|
|
|
} |
328
|
|
|
|
329
|
|
|
$tableAndColumns = ' INTO ' . $schema->quoteTableName($table) |
330
|
|
|
. ' (' . implode(', ', $columns) . ') VALUES '; |
331
|
|
|
|
332
|
|
|
return 'INSERT ALL ' . $tableAndColumns . implode($tableAndColumns, $values) . ' SELECT 1 FROM SYS.DUAL'; |
333
|
|
|
} |
334
|
|
|
|
335
|
|
|
/** |
336
|
|
|
* {@inheritdoc} |
337
|
|
|
* @since 2.0.8 |
338
|
|
|
*/ |
339
|
|
|
public function selectExists($rawSql) |
340
|
|
|
{ |
341
|
|
|
return 'SELECT CASE WHEN EXISTS(' . $rawSql . ') THEN 1 ELSE 0 END FROM DUAL'; |
342
|
|
|
} |
343
|
|
|
|
344
|
|
|
/** |
345
|
|
|
* {@inheritdoc} |
346
|
|
|
* @since 2.0.8 |
347
|
|
|
*/ |
348
|
|
|
public function dropCommentFromColumn($table, $column) |
349
|
|
|
{ |
350
|
|
|
return 'COMMENT ON COLUMN ' . $this->db->quoteTableName($table) . '.' . $this->db->quoteColumnName($column) . " IS ''"; |
351
|
|
|
} |
352
|
|
|
|
353
|
|
|
/** |
354
|
|
|
* {@inheritdoc} |
355
|
|
|
* @since 2.0.8 |
356
|
|
|
*/ |
357
|
|
|
public function dropCommentFromTable($table) |
358
|
|
|
{ |
359
|
|
|
return 'COMMENT ON TABLE ' . $this->db->quoteTableName($table) . " IS ''"; |
360
|
|
|
} |
361
|
|
|
} |
362
|
|
|
|
This check looks for function calls that miss required arguments.