Passed
Pull Request — master (#83)
by Wilmer
02:55
created

Schema::findColumns()   F

Complexity

Conditions 24
Paths 192

Size

Total Lines 159
Code Lines 71

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 54
CRAP Score 24.0262

Importance

Changes 3
Bugs 0 Features 0
Metric Value
cc 24
eloc 71
c 3
b 0
f 0
nc 192
nop 1
dl 0
loc 159
ccs 54
cts 56
cp 0.9643
crap 24.0262
rs 3.4

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
declare(strict_types=1);
4
5
namespace Yiisoft\Db\Pgsql;
6
7
use JsonException;
8
use PDO;
9
use Throwable;
10
use Yiisoft\Arrays\ArrayHelper;
11
use Yiisoft\Db\Constraint\CheckConstraint;
12
use Yiisoft\Db\Constraint\Constraint;
13
use Yiisoft\Db\Constraint\ConstraintFinderInterface;
14
use Yiisoft\Db\Constraint\ConstraintFinderTrait;
15
use Yiisoft\Db\Constraint\DefaultValueConstraint;
16
use Yiisoft\Db\Constraint\ForeignKeyConstraint;
17
use Yiisoft\Db\Constraint\IndexConstraint;
18
use Yiisoft\Db\Exception\Exception;
19
use Yiisoft\Db\Exception\InvalidConfigException;
20
use Yiisoft\Db\Exception\NotSupportedException;
21
use Yiisoft\Db\Expression\Expression;
22
use Yiisoft\Db\Schema\ColumnSchemaBuilder;
23
use Yiisoft\Db\Schema\Schema as AbstractSchema;
24
use Yiisoft\Db\View\ViewFinderTrait;
25
26
use function array_change_key_case;
27
use function array_merge;
28
use function array_unique;
29
use function array_values;
30
use function bindec;
31
use function explode;
32
use function implode;
33
use function preg_match;
34
use function preg_replace;
35
use function str_replace;
36
use function substr;
37
38
/**
39
 * The class Schema is the class for retrieving metadata from a PostgreSQL database
40
 * (version 9.6 and above).
41
 *
42
 * @psalm-type ColumnArray = array{
43
 *   table_schema: string,
44
 *   table_name: string,
45
 *   column_name: string,
46
 *   data_type: string,
47
 *   type_type: string|null,
48
 *   character_maximum_length: int,
49
 *   column_comment: string|null,
50
 *   modifier: int,
51
 *   is_nullable: bool,
52
 *   column_default: mixed,
53
 *   is_autoinc: bool,
54
 *   sequence_name: string|null,
55
 *   enum_values: array<array-key, float|int|string>|string|null,
56
 *   numeric_precision: int|null,
57
 *   numeric_scale: int|null,
58
 *   size: string|null,
59
 *   is_pkey: bool|null,
60
 *   dimension: int
61
 * }
62
 *
63
 * @psalm-type ConstraintArray = array<
64
 *   array-key,
65
 *   array {
66
 *     name: string,
67
 *     column_name: string,
68
 *     type: string,
69
 *     foreign_table_schema: string|null,
70
 *     foreign_table_name: string|null,
71
 *     foreign_column_name: string|null,
72
 *     on_update: string,
73
 *     on_delete: string,
74
 *     check_expr: string
75
 *   }
76
 * >
77
 *
78
 * @psalm-type FindConstraintArray = array{
79
 *   constraint_name: string,
80
 *   column_name: string,
81
 *   foreign_table_name: string,
82
 *   foreign_table_schema: string,
83
 *   foreign_column_name: string,
84
 * }
85
 */
86
final class Schema extends AbstractSchema implements ConstraintFinderInterface
87
{
88
    use ConstraintFinderTrait;
89
    use ViewFinderTrait;
90
91
    public const TYPE_JSONB = 'jsonb';
92
93
    /**
94
     * @var array<array-key, string> mapping from physical column types (keys) to abstract column types (values).
95
     *
96
     * {@see http://www.postgresql.org/docs/current/static/datatype.html#DATATYPE-TABLE}
97
     */
98
    private array $typeMap = [
99
        'bit' => self::TYPE_INTEGER,
100
        'bit varying' => self::TYPE_INTEGER,
101
        'varbit' => self::TYPE_INTEGER,
102
        'bool' => self::TYPE_BOOLEAN,
103
        'boolean' => self::TYPE_BOOLEAN,
104
        'box' => self::TYPE_STRING,
105
        'circle' => self::TYPE_STRING,
106
        'point' => self::TYPE_STRING,
107
        'line' => self::TYPE_STRING,
108
        'lseg' => self::TYPE_STRING,
109
        'polygon' => self::TYPE_STRING,
110
        'path' => self::TYPE_STRING,
111
        'character' => self::TYPE_CHAR,
112
        'char' => self::TYPE_CHAR,
113
        'bpchar' => self::TYPE_CHAR,
114
        'character varying' => self::TYPE_STRING,
115
        'varchar' => self::TYPE_STRING,
116
        'text' => self::TYPE_TEXT,
117
        'bytea' => self::TYPE_BINARY,
118
        'cidr' => self::TYPE_STRING,
119
        'inet' => self::TYPE_STRING,
120
        'macaddr' => self::TYPE_STRING,
121
        'real' => self::TYPE_FLOAT,
122
        'float4' => self::TYPE_FLOAT,
123
        'double precision' => self::TYPE_DOUBLE,
124
        'float8' => self::TYPE_DOUBLE,
125
        'decimal' => self::TYPE_DECIMAL,
126
        'numeric' => self::TYPE_DECIMAL,
127
        'money' => self::TYPE_MONEY,
128
        'smallint' => self::TYPE_SMALLINT,
129
        'int2' => self::TYPE_SMALLINT,
130
        'int4' => self::TYPE_INTEGER,
131
        'int' => self::TYPE_INTEGER,
132
        'integer' => self::TYPE_INTEGER,
133
        'bigint' => self::TYPE_BIGINT,
134
        'int8' => self::TYPE_BIGINT,
135
        'oid' => self::TYPE_BIGINT, // should not be used. it's pg internal!
136
        'smallserial' => self::TYPE_SMALLINT,
137
        'serial2' => self::TYPE_SMALLINT,
138
        'serial4' => self::TYPE_INTEGER,
139
        'serial' => self::TYPE_INTEGER,
140
        'bigserial' => self::TYPE_BIGINT,
141
        'serial8' => self::TYPE_BIGINT,
142
        'pg_lsn' => self::TYPE_BIGINT,
143
        'date' => self::TYPE_DATE,
144
        'interval' => self::TYPE_STRING,
145
        'time without time zone' => self::TYPE_TIME,
146
        'time' => self::TYPE_TIME,
147
        'time with time zone' => self::TYPE_TIME,
148
        'timetz' => self::TYPE_TIME,
149
        'timestamp without time zone' => self::TYPE_TIMESTAMP,
150
        'timestamp' => self::TYPE_TIMESTAMP,
151
        'timestamp with time zone' => self::TYPE_TIMESTAMP,
152
        'timestamptz' => self::TYPE_TIMESTAMP,
153
        'abstime' => self::TYPE_TIMESTAMP,
154
        'tsquery' => self::TYPE_STRING,
155
        'tsvector' => self::TYPE_STRING,
156
        'txid_snapshot' => self::TYPE_STRING,
157
        'unknown' => self::TYPE_STRING,
158
        'uuid' => self::TYPE_STRING,
159
        'json' => self::TYPE_JSON,
160
        'jsonb' => self::TYPE_JSON,
161
        'xml' => self::TYPE_STRING,
162
    ];
163
164
    /**
165
     * @var string|null the default schema used for the current session.
166
     */
167
    protected ?string $defaultSchema = 'public';
168
169
    /**
170
     * @var string|string[] character used to quote schema, table, etc. names. An array of 2 characters can be used in
171
     * case starting and ending characters are different.
172
     */
173
    protected $tableQuoteCharacter = '"';
174
175
    /**
176
     * Resolves the table name and schema name (if any).
177
     *
178
     * @param string $name the table name.
179
     *
180
     * @return TableSchema with resolved table, schema, etc. names.
181
     *
182
     * {@see TableSchema}
183
     */
184 76
    protected function resolveTableName(string $name): TableSchema
185
    {
186 76
        $resolvedName = new TableSchema();
187
188 76
        $parts = explode('.', str_replace('"', '', $name));
189
190 76
        if (isset($parts[1])) {
191 5
            $resolvedName->schemaName($parts[0]);
192 5
            $resolvedName->name($parts[1]);
193
        } else {
194 71
            $resolvedName->schemaName($this->defaultSchema);
195 71
            $resolvedName->name($name);
196
        }
197
198 76
        $resolvedName->fullName(
199
            (
200 76
                $resolvedName->getSchemaName() !== $this->defaultSchema ?
201
                    (string) $resolvedName->getSchemaName() . '.' :
202 76
                    ''
203 76
            ) . $resolvedName->getName()
204
        );
205
206 76
        return $resolvedName;
207
    }
208
209
    /**
210
     * Returns all schema names in the database, including the default one but not system schemas.
211
     *
212
     * This method should be overridden by child classes in order to support this feature because the default
213
     * implementation simply throws an exception.
214
     *
215
     * @throws Exception|InvalidConfigException|Throwable
216
     *
217
     * @return array all schema names in the database, except system schemas.
218
     */
219 2
    protected function findSchemaNames(): array
220
    {
221 2
        $sql = <<<'SQL'
222
            SELECT "ns"."nspname"
223
            FROM "pg_namespace" AS "ns"
224
            WHERE "ns"."nspname" != 'information_schema' AND "ns"."nspname" NOT LIKE 'pg_%'
225
            ORDER BY "ns"."nspname" ASC
226
            SQL;
227
228 2
        return $this->getDb()->createCommand($sql)->queryColumn();
229
    }
230
231
    /**
232
     * Returns all table names in the database.
233
     *
234
     * This method should be overridden by child classes in order to support this feature because the default
235
     * implementation simply throws an exception.
236
     *
237
     * @param string $schema the schema of the tables. Defaults to empty string, meaning the current or default schema.
238
     *
239
     * @throws Exception|InvalidConfigException|Throwable
240
     *
241
     * @return array all table names in the database. The names have NO schema name prefix.
242
     */
243 5
    protected function findTableNames(string $schema = ''): array
244
    {
245 5
        if ($schema === '') {
246 5
            $schema = $this->defaultSchema;
247
        }
248
249 5
        $sql = <<<'SQL'
250
            SELECT c.relname AS table_name
251
            FROM pg_class c
252
            INNER JOIN pg_namespace ns ON ns.oid = c.relnamespace
253
            WHERE ns.nspname = :schemaName AND c.relkind IN ('r','v','m','f', 'p')
254
            ORDER BY c.relname
255
            SQL;
256
257 5
        return $this->getDb()->createCommand($sql, [':schemaName' => $schema])->queryColumn();
258
    }
259
260
    /**
261
     * Loads the metadata for the specified table.
262
     *
263
     * @param string $name table name.
264
     *
265
     * @throws Exception|InvalidConfigException
266
     *
267
     * @return TableSchema|null DBMS-dependent table metadata, `null` if the table does not exist.
268
     */
269 104
    protected function loadTableSchema(string $name): ?TableSchema
270
    {
271 104
        $table = new TableSchema();
272
273 104
        $this->resolveTableNames($table, $name);
274
275 104
        if ($this->findColumns($table)) {
276 98
            $this->findConstraints($table);
277 98
            return $table;
278
        }
279
280 17
        return null;
281
    }
282
283
    /**
284
     * Loads a primary key for the given table.
285
     *
286
     * @param string $tableName table name.
287
     *
288
     * @throws Exception|InvalidConfigException
289
     *
290
     * @return Constraint|null primary key for the given table, `null` if the table has no primary key.
291
     */
292 31
    protected function loadTablePrimaryKey(string $tableName): ?Constraint
293
    {
294 31
        $tablePrimaryKey = $this->loadTableConstraints($tableName, 'primaryKey');
295
296 31
        return $tablePrimaryKey instanceof Constraint ? $tablePrimaryKey : null;
297
    }
298
299
    /**
300
     * Loads all foreign keys for the given table.
301
     *
302
     * @param string $tableName table name.
303
     *
304
     * @throws Exception|InvalidConfigException
305
     *
306
     * @return array|ForeignKeyConstraint[] foreign keys for the given table.
307
     */
308 4
    protected function loadTableForeignKeys(string $tableName): array
309
    {
310 4
        $tableForeignKeys = $this->loadTableConstraints($tableName, 'foreignKeys');
311
312 4
        return is_array($tableForeignKeys) ? $tableForeignKeys : [];
313
    }
314
315
    /**
316
     * Loads all indexes for the given table.
317
     *
318
     * @param string $tableName table name.
319
     *
320
     * @throws Exception|InvalidConfigException|Throwable
321
     *
322
     * @return IndexConstraint[] indexes for the given table.
323
     */
324 28
    protected function loadTableIndexes(string $tableName): array
325
    {
326 28
        $sql = <<<'SQL'
327
            SELECT
328
                "ic"."relname" AS "name",
329
                "ia"."attname" AS "column_name",
330
                "i"."indisunique" AS "index_is_unique",
331
                "i"."indisprimary" AS "index_is_primary"
332
            FROM "pg_class" AS "tc"
333
            INNER JOIN "pg_namespace" AS "tcns"
334
                ON "tcns"."oid" = "tc"."relnamespace"
335
            INNER JOIN "pg_index" AS "i"
336
                ON "i"."indrelid" = "tc"."oid"
337
            INNER JOIN "pg_class" AS "ic"
338
                ON "ic"."oid" = "i"."indexrelid"
339
            INNER JOIN "pg_attribute" AS "ia"
340
                ON "ia"."attrelid" = "i"."indexrelid"
341
            WHERE "tcns"."nspname" = :schemaName AND "tc"."relname" = :tableName
342
            ORDER BY "ia"."attnum" ASC
343
            SQL;
344
345 28
        $resolvedName = $this->resolveTableName($tableName);
346
347 28
        $indexes = $this->getDb()->createCommand($sql, [
348 28
            ':schemaName' => $resolvedName->getSchemaName(),
349 28
            ':tableName' => $resolvedName->getName(),
350 28
        ])->queryAll();
351
352
        /** @var array<array-key, array<array-key, mixed>> @indexes */
353 28
        $indexes = $this->normalizePdoRowKeyCase($indexes, true);
354 28
        $indexes = ArrayHelper::index($indexes, null, 'name');
355 28
        $result = [];
356
357
        /**
358
         * @var object|string|null $name
359
         * @var array<
360
         *   array-key,
361
         *   array{
362
         *     name: string,
363
         *     column_name: string,
364
         *     index_is_unique: bool,
365
         *     index_is_primary: bool
366
         *   }
367
         * > $index
368
         */
369 28
        foreach ($indexes as $name => $index) {
370 25
            $ic = (new IndexConstraint())
371 25
                ->name($name)
372 25
                ->columnNames(ArrayHelper::getColumn($index, 'column_name'))
373 25
                ->primary($index[0]['index_is_primary'])
374 25
                ->unique($index[0]['index_is_unique']);
375
376 25
            $result[] = $ic;
377
        }
378
379 28
        return $result;
380
    }
381
382
    /**
383
     * Loads all unique constraints for the given table.
384
     *
385
     * @param string $tableName table name.
386
     *
387
     * @throws Exception|InvalidConfigException
388
     *
389
     * @return array|Constraint[] unique constraints for the given table.
390
     */
391 13
    protected function loadTableUniques(string $tableName): array
392
    {
393 13
        $tableUniques = $this->loadTableConstraints($tableName, 'uniques');
394
395 13
        return is_array($tableUniques) ? $tableUniques : [];
396
    }
397
398
    /**
399
     * Loads all check constraints for the given table.
400
     *
401
     * @param string $tableName table name.
402
     *
403
     * @throws Exception|InvalidConfigException
404
     *
405
     * @return array|CheckConstraint[] check constraints for the given table.
406
     */
407 13
    protected function loadTableChecks(string $tableName): array
408
    {
409 13
        $tableChecks = $this->loadTableConstraints($tableName, 'checks');
410
411 13
        return is_array($tableChecks) ? $tableChecks : [];
412
    }
413
414
    /**
415
     * Loads all default value constraints for the given table.
416
     *
417
     * @param string $tableName table name.
418
     *
419
     * @throws NotSupportedException
420
     *
421
     * @return DefaultValueConstraint[] default value constraints for the given table.
422
     */
423 12
    protected function loadTableDefaultValues(string $tableName): array
424
    {
425 12
        throw new NotSupportedException('PostgreSQL does not support default value constraints.');
426
    }
427
428
    /**
429
     * Creates a query builder for the PostgreSQL database.
430
     *
431
     * @return QueryBuilder query builder instance
432
     */
433 74
    public function createQueryBuilder(): QueryBuilder
434
    {
435 74
        return new QueryBuilder($this->getDb());
436
    }
437
438
    /**
439
     * Resolves the table name and schema name (if any).
440
     *
441
     * @param TableSchema $table the table metadata object.
442
     * @param string $name the table name
443
     */
444 104
    protected function resolveTableNames(TableSchema $table, string $name): void
445
    {
446 104
        $parts = explode('.', str_replace('"', '', $name));
447
448 104
        if (isset($parts[1])) {
449
            $table->schemaName($parts[0]);
450
            $table->name($parts[1]);
451
        } else {
452 104
            $table->schemaName($this->defaultSchema);
453 104
            $table->name($parts[0]);
454
        }
455
456 104
        if ($table->getSchemaName() !== $this->defaultSchema) {
457
            $name = (string) $table->getSchemaName() . '.' . $table->getName();
458
        } else {
459 104
            $name = $table->getName();
460
        }
461
462 104
        $table->fullName($name);
463 104
    }
464
465 1
    protected function findViewNames(string $schema = ''): array
466
    {
467 1
        if ($schema === '') {
468
            $schema = $this->defaultSchema;
469
        }
470
471 1
        $sql = <<<'SQL'
472
            SELECT c.relname AS table_name
473
            FROM pg_class c
474
            INNER JOIN pg_namespace ns ON ns.oid = c.relnamespace
475
            WHERE ns.nspname = :schemaName AND (c.relkind = 'v' OR c.relkind = 'm')
476
            ORDER BY c.relname
477
            SQL;
478
479 1
        return $this->getDb()->createCommand($sql, [':schemaName' => $schema])->queryColumn();
480
    }
481
482
    /**
483
     * Collects the foreign key column details for the given table.
484
     *
485
     * @param TableSchema $table the table metadata
486
     *
487
     * @throws Exception|InvalidConfigException|Throwable
488
     */
489 98
    protected function findConstraints(TableSchema $table): void
490
    {
491 98
        $tableName = $table->getName();
492 98
        $tableSchema = $table->getSchemaName();
493
494 98
        $tableName = $this->quoteValue($tableName);
495
496 98
        if ($tableSchema !== null) {
497 98
            $tableSchema = $this->quoteValue($tableSchema);
498
        }
499
500
        /**
501
         * We need to extract the constraints de hard way since:
502
         * {@see http://www.postgresql.org/message-id/[email protected]}
503
         */
504
505 98
        $sql = <<<SQL
506 98
            SELECT
507
                ct.conname as constraint_name,
508
                a.attname as column_name,
509
                fc.relname as foreign_table_name,
510
                fns.nspname as foreign_table_schema,
511
                fa.attname as foreign_column_name
512
            FROM
513
                (SELECT ct.conname, ct.conrelid, ct.confrelid, ct.conkey, ct.contype, ct.confkey,
514
                        generate_subscripts(ct.conkey, 1) AS s
515
                   FROM pg_constraint ct
516
                ) AS ct
517
                inner join pg_class c on c.oid=ct.conrelid
518
                inner join pg_namespace ns on c.relnamespace=ns.oid
519
                inner join pg_attribute a on a.attrelid=ct.conrelid and a.attnum = ct.conkey[ct.s]
520
                left join pg_class fc on fc.oid=ct.confrelid
521
                left join pg_namespace fns on fc.relnamespace=fns.oid
522
                left join pg_attribute fa on fa.attrelid=ct.confrelid and fa.attnum = ct.confkey[ct.s]
523
            WHERE
524
                ct.contype='f'
525 98
                and c.relname={$tableName}
526 98
                and ns.nspname={$tableSchema}
527
            ORDER BY
528
                fns.nspname, fc.relname, a.attnum
529
            SQL;
530
531
        /** @var array{array{tableName: string, columns: array}} $constraints */
532 98
        $constraints = [];
533 98
        $slavePdo = $this->getDb()->getSlavePdo();
534
535
        /** @var FindConstraintArray $constraint */
536 98
        foreach ($this->getDb()->createCommand($sql)->queryAll() as $constraint) {
537 9
            if ($slavePdo !== null && $slavePdo->getAttribute(PDO::ATTR_CASE) === PDO::CASE_UPPER) {
538
                $constraint = array_change_key_case($constraint, CASE_LOWER);
539
            }
540
541 9
            if ($constraint['foreign_table_schema'] !== $this->defaultSchema) {
542
                $foreignTable = $constraint['foreign_table_schema'] . '.' . $constraint['foreign_table_name'];
543
            } else {
544 9
                $foreignTable = $constraint['foreign_table_name'];
545
            }
546
547 9
            $name = $constraint['constraint_name'];
548
549 9
            if (!isset($constraints[$name])) {
550
                $constraints[$name] = [
551 9
                    'tableName' => $foreignTable,
552
                    'columns' => [],
553
                ];
554
            }
555
556 9
            $constraints[$name]['columns'][$constraint['column_name']] = $constraint['foreign_column_name'];
557
        }
558
559
        /**
560
         * @var int|string $foreingKeyName.
561
         * @var array{tableName: string, columns: array} $constraint
562
         */
563 98
        foreach ($constraints as $foreingKeyName => $constraint) {
564 9
            $table->foreignKey(
565 9
                (string) $foreingKeyName,
566 9
                array_merge([$constraint['tableName']], $constraint['columns'])
567
            );
568
        }
569 98
    }
570
571
    /**
572
     * Gets information about given table unique indexes.
573
     *
574
     * @param TableSchema $table the table metadata.
575
     *
576
     * @throws Exception|InvalidConfigException|Throwable
577
     *
578
     * @return array with index and column names.
579
     */
580 1
    protected function getUniqueIndexInformation(TableSchema $table): array
581
    {
582 1
        $sql = <<<'SQL'
583
            SELECT
584
                i.relname as indexname,
585
                pg_get_indexdef(idx.indexrelid, k + 1, TRUE) AS columnname
586
            FROM (
587
              SELECT *, generate_subscripts(indkey, 1) AS k
588
              FROM pg_index
589
            ) idx
590
            INNER JOIN pg_class i ON i.oid = idx.indexrelid
591
            INNER JOIN pg_class c ON c.oid = idx.indrelid
592
            INNER JOIN pg_namespace ns ON c.relnamespace = ns.oid
593
            WHERE idx.indisprimary = FALSE AND idx.indisunique = TRUE
594
            AND c.relname = :tableName AND ns.nspname = :schemaName
595
            ORDER BY i.relname, k
596
            SQL;
597
598 1
        return $this->getDb()->createCommand($sql, [
599 1
            ':schemaName' => $table->getSchemaName(),
600 1
            ':tableName' => $table->getName(),
601 1
        ])->queryAll();
602
    }
603
604
    /**
605
     * Returns all unique indexes for the given table.
606
     *
607
     * Each array element is of the following structure:
608
     *
609
     * ```php
610
     * [
611
     *     'IndexName1' => ['col1' [, ...]],
612
     *     'IndexName2' => ['col2' [, ...]],
613
     * ]
614
     * ```
615
     *
616
     * @param TableSchema $table the table metadata
617
     *
618
     * @throws Exception|InvalidConfigException|Throwable
619
     *
620
     * @return array all unique indexes for the given table.
621
     */
622 1
    public function findUniqueIndexes(TableSchema $table): array
623
    {
624 1
        $uniqueIndexes = [];
625 1
        $slavePdo = $this->getDb()->getSlavePdo();
626
627
        /** @var array{indexname: string, columnname: string} $row */
628 1
        foreach ($this->getUniqueIndexInformation($table) as $row) {
629 1
            if ($slavePdo !== null && $slavePdo->getAttribute(PDO::ATTR_CASE) === PDO::CASE_UPPER) {
630 1
                $row = array_change_key_case($row, CASE_LOWER);
631
            }
632
633 1
            $column = $row['columnname'];
634
635 1
            if (!empty($column) && $column[0] === '"') {
636
                /**
637
                 * postgres will quote names that are not lowercase-only.
638
                 *
639
                 * {@see https://github.com/yiisoft/yii2/issues/10613}
640
                 */
641 1
                $column = substr($column, 1, -1);
642
            }
643
644 1
            $uniqueIndexes[$row['indexname']][] = $column;
645
        }
646
647 1
        return $uniqueIndexes;
648
    }
649
650
    /**
651
     * Collects the metadata of table columns.
652
     *
653
     * @param TableSchema $table the table metadata.
654
     *
655
     * @throws Exception|InvalidConfigException|JsonException|Throwable
656
     *
657
     * @return bool whether the table exists in the database.
658
     */
659 104
    protected function findColumns(TableSchema $table): bool
660
    {
661 104
        $tableName = $table->getName();
662 104
        $schemaName = $table->getSchemaName();
663 104
        $orIdentity = '';
664
665 104
        $tableName = $this->getDb()->quoteValue($tableName);
666
667 104
        if ($schemaName !== null) {
668 104
            $schemaName = $this->getDb()->quoteValue($schemaName);
669
        }
670
671 104
        if (version_compare($this->getDb()->getServerVersion(), '12.0', '>=')) {
672 104
            $orIdentity = 'OR a.attidentity != \'\'';
673
        }
674
675 104
        $sql = <<<SQL
676 104
            SELECT
677
                d.nspname AS table_schema,
678
                c.relname AS table_name,
679
                a.attname AS column_name,
680
                COALESCE(td.typname, tb.typname, t.typname) AS data_type,
681
                COALESCE(td.typtype, tb.typtype, t.typtype) AS type_type,
682
                a.attlen AS character_maximum_length,
683
                pg_catalog.col_description(c.oid, a.attnum) AS column_comment,
684
                a.atttypmod AS modifier,
685
                a.attnotnull = false AS is_nullable,
686
                CAST(pg_get_expr(ad.adbin, ad.adrelid) AS varchar) AS column_default,
687 104
                coalesce(pg_get_expr(ad.adbin, ad.adrelid) ~ 'nextval',false) {$orIdentity} AS is_autoinc,
688
                pg_get_serial_sequence(quote_ident(d.nspname) || '.' || quote_ident(c.relname), a.attname)
689
                    AS sequence_name,
690
                CASE WHEN COALESCE(td.typtype, tb.typtype, t.typtype) = 'e'::char
691
                    THEN array_to_string(
692
                        (
693
                            SELECT array_agg(enumlabel)
694
                            FROM pg_enum
695
                            WHERE enumtypid = COALESCE(td.oid, tb.oid, a.atttypid)
696
                            )::varchar[],
697
                        ',')
698
                    ELSE NULL
699
                END AS enum_values,
700
                CASE atttypid
701
                     WHEN 21 /*int2*/ THEN 16
702
                     WHEN 23 /*int4*/ THEN 32
703
                     WHEN 20 /*int8*/ THEN 64
704
                     WHEN 1700 /*numeric*/ THEN
705
                          CASE WHEN atttypmod = -1
706
                           THEN null
707
                           ELSE ((atttypmod - 4) >> 16) & 65535
708
                           END
709
                     WHEN 700 /*float4*/ THEN 24 /*FLT_MANT_DIG*/
710
                     WHEN 701 /*float8*/ THEN 53 /*DBL_MANT_DIG*/
711
                     ELSE null
712
                  END   AS numeric_precision,
713
                  CASE
714
                    WHEN atttypid IN (21, 23, 20) THEN 0
715
                    WHEN atttypid IN (1700) THEN
716
                    CASE
717
                        WHEN atttypmod = -1 THEN null
718
                        ELSE (atttypmod - 4) & 65535
719
                    END
720
                       ELSE null
721
                  END AS numeric_scale,
722
                CAST(
723
                         information_schema._pg_char_max_length(
724
                             information_schema._pg_truetypid(a, t),
725
                             information_schema._pg_truetypmod(a, t)
726
                             ) AS numeric
727
                ) AS size,
728
                a.attnum = any (ct.conkey) as is_pkey,
729
                COALESCE(NULLIF(a.attndims, 0), NULLIF(t.typndims, 0), (t.typcategory='A')::int) AS dimension
730
            FROM
731
                pg_class c
732
                LEFT JOIN pg_attribute a ON a.attrelid = c.oid
733
                LEFT JOIN pg_attrdef ad ON a.attrelid = ad.adrelid AND a.attnum = ad.adnum
734
                LEFT JOIN pg_type t ON a.atttypid = t.oid
735
                LEFT JOIN pg_type tb ON (a.attndims > 0 OR t.typcategory='A') AND t.typelem > 0 AND t.typelem = tb.oid
736
                                            OR t.typbasetype > 0 AND t.typbasetype = tb.oid
737
                LEFT JOIN pg_type td ON t.typndims > 0 AND t.typbasetype > 0 AND tb.typelem = td.oid
738
                LEFT JOIN pg_namespace d ON d.oid = c.relnamespace
739
                LEFT JOIN pg_constraint ct ON ct.conrelid = c.oid AND ct.contype = 'p'
740
            WHERE
741
                a.attnum > 0 AND t.typname != '' AND NOT a.attisdropped
742 104
                AND c.relname = {$tableName}
743 104
                AND d.nspname = {$schemaName}
744
            ORDER BY
745
                a.attnum;
746
            SQL;
747
748
        /** @var array columns */
749 104
        $columns = $this->getDb()->createCommand($sql)->queryAll();
750 104
        $slavePdo = $this->getDb()->getSlavePdo();
751
752 104
        if (empty($columns)) {
753 17
            return false;
754
        }
755
756
        /** @var array<array-key, mixed> $column */
757 98
        foreach ($columns as $column) {
758 98
            if ($slavePdo !== null && $slavePdo->getAttribute(PDO::ATTR_CASE) === PDO::CASE_UPPER) {
759 1
                $column = array_change_key_case($column, CASE_LOWER);
760
            }
761
762
            /** @psalm-var ColumnArray $column */
763 98
            $loadColumnSchema = $this->loadColumnSchema($column);
764 98
            $table->columns($loadColumnSchema->getName(), $loadColumnSchema);
765
766
            /** @var mixed $defaultValue */
767 98
            $defaultValue = $loadColumnSchema->getDefaultValue();
768
769 98
            if ($loadColumnSchema->isPrimaryKey()) {
770 66
                $table->primaryKey($loadColumnSchema->getName());
771
772 66
                if ($table->getSequenceName() === null) {
773 66
                    $table->sequenceName($loadColumnSchema->getSequenceName());
774
                }
775
776 66
                $loadColumnSchema->defaultValue(null);
777 95
            } elseif ($defaultValue) {
778
                if (
779 56
                    is_string($defaultValue) &&
780 56
                    in_array(
781 56
                        $loadColumnSchema->getType(),
782 56
                        [self::TYPE_TIMESTAMP, self::TYPE_DATE, self::TYPE_TIME],
783 56
                        true
784
                    ) &&
785 30
                    in_array(
786 30
                        strtoupper($defaultValue),
787 30
                        ['NOW()', 'CURRENT_TIMESTAMP', 'CURRENT_DATE', 'CURRENT_TIME'],
788 56
                        true
789
                    )
790
                ) {
791 28
                    $loadColumnSchema->defaultValue(new Expression($defaultValue));
792 56
                } elseif ($loadColumnSchema->getType() === 'boolean') {
793 52
                    $loadColumnSchema->defaultValue(($defaultValue  === 'true'));
794 33
                } elseif (is_string($defaultValue) && preg_match("/^B'(.*?)'::/", $defaultValue, $matches)) {
795
                    $loadColumnSchema->defaultValue(bindec($matches[1]));
796 33
                } elseif (is_string($defaultValue) && preg_match("/^'(\d+)'::\"bit\"$/", $defaultValue, $matches)) {
797 28
                    $loadColumnSchema->defaultValue(bindec($matches[1]));
798 33
                } elseif (is_string($defaultValue) && preg_match("/^'(.*?)'::/", $defaultValue, $matches)) {
799 30
                    $loadColumnSchema->defaultValue($loadColumnSchema->phpTypecast($matches[1]));
800
                } elseif (
801 31
                    is_string($defaultValue) &&
802 31
                    preg_match('/^(\()?(.*?)(?(1)\))(?:::.+)?$/', $defaultValue, $matches)
803
                ) {
804 31
                    if ($matches[2] === 'NULL') {
805 5
                        $loadColumnSchema->defaultValue(null);
806
                    } else {
807 31
                        $loadColumnSchema->defaultValue($loadColumnSchema->phpTypecast($matches[2]));
808
                    }
809
                } else {
810
                    $loadColumnSchema->defaultValue($loadColumnSchema->phpTypecast($defaultValue));
811
                }
812
            }
813
        }
814
815 98
        return true;
816
    }
817
818
    /**
819
     * Loads the column information into a {@see ColumnSchema} object.
820
     *
821
     * @param array{
822
     *   table_schema: string,
823
     *   table_name: string,
824
     *   column_name: string,
825
     *   data_type: string,
826
     *   type_type: string|null,
827
     *   character_maximum_length: int,
828
     *   column_comment: string|null,
829
     *   modifier: int,
830
     *   is_nullable: bool,
831
     *   column_default: mixed,
832
     *   is_autoinc: bool,
833
     *   sequence_name: string|null,
834
     *   enum_values: array<array-key, float|int|string>|string|null,
835
     *   numeric_precision: int|null,
836
     *   numeric_scale: int|null,
837
     *   size: string|null,
838
     *   is_pkey: bool|null,
839
     *   dimension: int
840
     * } $info column information.
841
     *
842
     * @return ColumnSchema the column schema object.
843
     */
844 98
    protected function loadColumnSchema(array $info): ColumnSchema
845
    {
846 98
        $column = $this->createColumnSchema();
847 98
        $column->allowNull($info['is_nullable']);
848 98
        $column->autoIncrement($info['is_autoinc']);
849 98
        $column->comment($info['column_comment']);
850 98
        $column->dbType($info['data_type']);
851 98
        $column->defaultValue($info['column_default']);
852 98
        $column->enumValues(($info['enum_values'] !== null)
853 98
            ? explode(',', str_replace(["''"], ["'"], $info['enum_values'])) : null);
854 98
        $column->unsigned(false); // has no meaning in PG
855 98
        $column->primaryKey((bool) $info['is_pkey']);
856 98
        $column->name($info['column_name']);
857 98
        $column->precision($info['numeric_precision']);
858 98
        $column->scale($info['numeric_scale']);
859 98
        $column->size($info['size'] === null ? null : (int) $info['size']);
860 98
        $column->dimension($info['dimension']);
861
862
        /**
863
         * pg_get_serial_sequence() doesn't track DEFAULT value change. GENERATED BY IDENTITY columns always have null
864
         * default value.
865
         *
866
         * @var mixed $defaultValue
867
         */
868 98
        $defaultValue = $column->getDefaultValue();
869 98
        $sequenceName = $info['sequence_name'] ?? null;
870
871
        if (
872 98
            isset($defaultValue) &&
873 98
            is_string($defaultValue) &&
874 98
            preg_match("/nextval\\('\"?\\w+\"?\.?\"?\\w+\"?'(::regclass)?\\)/", $defaultValue) === 1
875
        ) {
876 60
            $column->sequenceName(preg_replace(
877 60
                ['/nextval/', '/::/', '/regclass/', '/\'\)/', '/\(\'/'],
878 60
                '',
879 60
                $defaultValue
880
            ));
881 96
        } elseif ($sequenceName !== null) {
882 5
            $column->sequenceName($this->resolveTableName($sequenceName)->getFullName());
883
        }
884
885 98
        if (isset($this->typeMap[$column->getDbType()])) {
886 98
            $column->type($this->typeMap[$column->getDbType()]);
887
        } else {
888
            $column->type(self::TYPE_STRING);
889
        }
890
891 98
        $column->phpType($this->getColumnPhpType($column));
892
893 98
        return $column;
894
    }
895
896
    /**
897
     * Executes the INSERT command, returning primary key values.
898
     *
899
     * @param string $table the table that new rows will be inserted into.
900
     * @param array $columns the column data (name => value) to be inserted into the table.
901
     *
902
     * @throws Exception|InvalidConfigException|Throwable
903
     *
904
     * @return array|false primary key values or false if the command fails.
905
     */
906 1
    public function insert(string $table, array $columns)
907
    {
908 1
        $params = [];
909 1
        $returnColumns = [];
910 1
        $sql = $this->getDb()->getQueryBuilder()->insert($table, $columns, $params);
911 1
        $tableSchema = $this->getTableSchema($table);
912
913 1
        if ($tableSchema !== null) {
914 1
            $returnColumns = $tableSchema->getPrimaryKey();
915
        }
916
917 1
        if (!empty($returnColumns)) {
918 1
            $returning = [];
919
            /** @var string $name */
920 1
            foreach ($returnColumns as $name) {
921 1
                $returning[] = $this->quoteColumnName($name);
0 ignored issues
show
Bug introduced by
A parse error occurred: Syntax error, unexpected ']', expecting T_STRING or T_VARIABLE or T_NUM_STRING on line 921 at column 27
Loading history...
922
            }
923 1
            $sql .= ' RETURNING ' . implode(', ', $returning);
924
        }
925
926 1
        $command = $this->getDb()->createCommand($sql, $params);
927 1
        $command->prepare(false);
928 1
        $result = $command->queryOne();
929
930 1
        $pdoStatement = $command->getPdoStatement();
931
932 1
        return $pdoStatement !== null && !$pdoStatement->rowCount() ? false : $result;
933
    }
934
935
    /**
936
     * Loads multiple types of constraints and returns the specified ones.
937
     *
938
     * @param string $tableName table name.
939
     * @param string $returnType return type:
940
     * - primaryKey
941
     * - foreignKeys
942
     * - uniques
943
     * - checks
944
     *
945
     * @throws Exception|InvalidConfigException|Throwable
946
     *
947
     * @return (CheckConstraint|Constraint|ForeignKeyConstraint)[]|Constraint|null constraints.
948
     *
949
     * @psalm-return Constraint|list<CheckConstraint|Constraint|ForeignKeyConstraint>|null
950
     */
951 61
    private function loadTableConstraints(string $tableName, string $returnType)
952
    {
953
        /** @var string $sql */
954 61
        $sql = <<<'SQL'
955
            SELECT
956
                "c"."conname" AS "name",
957
                "a"."attname" AS "column_name",
958
                "c"."contype" AS "type",
959
                "ftcns"."nspname" AS "foreign_table_schema",
960
                "ftc"."relname" AS "foreign_table_name",
961
                "fa"."attname" AS "foreign_column_name",
962
                "c"."confupdtype" AS "on_update",
963
                "c"."confdeltype" AS "on_delete",
964
                pg_get_constraintdef("c"."oid") AS "check_expr"
965
            FROM "pg_class" AS "tc"
966
            INNER JOIN "pg_namespace" AS "tcns"
967
                ON "tcns"."oid" = "tc"."relnamespace"
968
            INNER JOIN "pg_constraint" AS "c"
969
                ON "c"."conrelid" = "tc"."oid"
970
            INNER JOIN "pg_attribute" AS "a"
971
                ON "a"."attrelid" = "c"."conrelid" AND "a"."attnum" = ANY ("c"."conkey")
972
            LEFT JOIN "pg_class" AS "ftc"
973
                ON "ftc"."oid" = "c"."confrelid"
974
            LEFT JOIN "pg_namespace" AS "ftcns"
975
                ON "ftcns"."oid" = "ftc"."relnamespace"
976
            LEFT JOIN "pg_attribute" "fa"
977
                ON "fa"."attrelid" = "c"."confrelid" AND "fa"."attnum" = ANY ("c"."confkey")
978
            WHERE "tcns"."nspname" = :schemaName AND "tc"."relname" = :tableName
979
            ORDER BY "a"."attnum" ASC, "fa"."attnum" ASC
980
            SQL;
981
982
        /** @var array<array-key, string> $actionTypes */
983 61
        $actionTypes = [
984
            'a' => 'NO ACTION',
985
            'r' => 'RESTRICT',
986
            'c' => 'CASCADE',
987
            'n' => 'SET NULL',
988
            'd' => 'SET DEFAULT',
989
        ];
990
991 61
        $resolvedName = $this->resolveTableName($tableName);
992
993 61
        $constraints = $this->getDb()->createCommand($sql, [
994 61
            ':schemaName' => $resolvedName->getSchemaName(),
995 61
            ':tableName' => $resolvedName->getName(),
996 61
        ])->queryAll();
997
998
        /** @var array<array-key, array> $constraints */
999 61
        $constraints = $this->normalizePdoRowKeyCase($constraints, true);
1000 61
        $constraints = ArrayHelper::index($constraints, null, ['type', 'name']);
1001
1002 61
        $result = [
1003
            'primaryKey' => null,
1004
            'foreignKeys' => [],
1005
            'uniques' => [],
1006
            'checks' => [],
1007
        ];
1008
1009
        /**
1010
         * @var string $type
1011
         * @var array $names
1012
         */
1013 61
        foreach ($constraints as $type => $names) {
1014
            /**
1015
             * @psalm-var object|string|null $name
1016
             * @psalm-var ConstraintArray $constraint
1017
             */
1018 61
            foreach ($names as $name => $constraint) {
1019 61
                switch ($type) {
1020 61
                    case 'p':
1021 46
                        $ct = (new Constraint())
1022 46
                            ->name($name)
1023 46
                            ->columnNames(ArrayHelper::getColumn($constraint, 'column_name'));
1024
1025 46
                        $result['primaryKey'] = $ct;
1026 46
                        break;
1027 59
                    case 'f':
1028 13
                        $onDelete = $actionTypes[$constraint[0]['on_delete']] ?? null;
1029 13
                        $onUpdate = $actionTypes[$constraint[0]['on_update']] ?? null;
1030
1031 13
                        $fk = (new ForeignKeyConstraint())
1032 13
                            ->name($name)
1033 13
                            ->columnNames(array_values(
1034 13
                                array_unique(ArrayHelper::getColumn($constraint, 'column_name'))
1035
                            ))
1036 13
                            ->foreignSchemaName($constraint[0]['foreign_table_schema'])
1037 13
                            ->foreignTableName($constraint[0]['foreign_table_name'])
1038 13
                            ->foreignColumnNames(array_values(
1039 13
                                array_unique(ArrayHelper::getColumn($constraint, 'foreign_column_name'))
1040
                            ))
1041 13
                            ->onDelete($onDelete)
1042 13
                            ->onUpdate($onUpdate);
1043
1044 13
                        $result['foreignKeys'][] = $fk;
1045 13
                        break;
1046 47
                    case 'u':
1047 46
                        $ct = (new Constraint())
1048 46
                            ->name($name)
1049 46
                            ->columnNames(ArrayHelper::getColumn($constraint, 'column_name'));
1050
1051 46
                        $result['uniques'][] = $ct;
1052 46
                        break;
1053 10
                    case 'c':
1054 10
                        $ck = (new CheckConstraint())
1055 10
                            ->name($name)
1056 10
                            ->columnNames(ArrayHelper::getColumn($constraint, 'column_name'))
1057 10
                            ->expression($constraint[0]['check_expr']);
1058
1059 10
                        $result['checks'][] = $ck;
1060 10
                        break;
1061
                }
1062
            }
1063
        }
1064
1065 61
        foreach ($result as $type => $data) {
1066 61
            $this->setTableMetadata($tableName, $type, $data);
1067
        }
1068
1069 61
        return $result[$returnType];
1070
    }
1071
1072
    /**
1073
     * Creates a column schema for the database.
1074
     *
1075
     * This method may be overridden by child classes to create a DBMS-specific column schema.
1076
     *
1077
     * @return ColumnSchema column schema instance.
1078
     */
1079 98
    private function createColumnSchema(): ColumnSchema
1080
    {
1081 98
        return new ColumnSchema();
1082
    }
1083
1084
    /**
1085
     * Create a column schema builder instance giving the type and value precision.
1086
     *
1087
     * This method may be overridden by child classes to create a DBMS-specific column schema builder.
1088
     *
1089
     * @param string $type type of the column. See {@see ColumnSchemaBuilder::$type}.
1090
     * @param array|int|string|null $length length or precision of the column. See {@see ColumnSchemaBuilder::$length}.
1091
     *
1092
     * @return ColumnSchemaBuilder column schema builder instance
1093
     */
1094 4
    public function createColumnSchemaBuilder(string $type, $length = null): ColumnSchemaBuilder
1095
    {
1096 4
        return new ColumnSchemaBuilder($type, $length);
1097
    }
1098
}
1099