Schema.php 15 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\db\pgsql;

10
use yii\db\Expression;
11 12 13 14
use yii\db\TableSchema;
use yii\db\ColumnSchema;

/**
Qiang Xue committed
15
 * Schema is the class for retrieving metadata from a PostgreSQL database
16
 * (version 9.x and above).
17 18 19 20
 *
 * @author Gevik Babakhani <gevikb@gmail.com>
 * @since 2.0
 */
21 22
class Schema extends \yii\db\Schema
{
23 24 25 26 27 28 29
    /**
     * @var string the default schema used for the current session.
     */
    public $defaultSchema = 'public';
    /**
     * @var array mapping from physical column types (keys) to abstract
     * column types (values)
30
     * @see http://www.postgresql.org/docs/current/static/datatype.html#DATATYPE-TABLE
31 32
     */
    public $typeMap = [
33 34 35
        'bit' => self::TYPE_INTEGER,
        'bit varying' => self::TYPE_INTEGER,
        'varbit' => self::TYPE_INTEGER,
36

37 38
        'bool' => self::TYPE_BOOLEAN,
        'boolean' => self::TYPE_BOOLEAN,
39

40
        'box' => self::TYPE_STRING,
41 42 43 44 45 46 47
        'circle' => self::TYPE_STRING,
        'point' => self::TYPE_STRING,
        'line' => self::TYPE_STRING,
        'lseg' => self::TYPE_STRING,
        'polygon' => self::TYPE_STRING,
        'path' => self::TYPE_STRING,

48 49
        'character' => self::TYPE_STRING,
        'char' => self::TYPE_STRING,
50 51 52 53 54 55
        'character varying' => self::TYPE_STRING,
        'varchar' => self::TYPE_STRING,
        'text' => self::TYPE_TEXT,

        'bytea' => self::TYPE_BINARY,

56
        'cidr' => self::TYPE_STRING,
57 58 59
        'inet' => self::TYPE_STRING,
        'macaddr' => self::TYPE_STRING,

60
        'real' => self::TYPE_FLOAT,
61 62 63
        'float4' => self::TYPE_FLOAT,
        'double precision' => self::TYPE_FLOAT,
        'float8' => self::TYPE_FLOAT,
64
        'decimal' => self::TYPE_DECIMAL,
65 66 67 68
        'numeric' => self::TYPE_DECIMAL,

        'money' => self::TYPE_MONEY,

69
        'smallint' => self::TYPE_SMALLINT,
70
        'int2' => self::TYPE_SMALLINT,
71
        'int4' => self::TYPE_INTEGER,
72
        'int' => self::TYPE_INTEGER,
73 74
        'integer' => self::TYPE_INTEGER,
        'bigint' => self::TYPE_BIGINT,
75
        'int8' => self::TYPE_BIGINT,
76
        'oid' => self::TYPE_BIGINT, // should not be used. it's pg internal!
77 78 79 80 81 82 83 84 85 86 87

        'smallserial' => self::TYPE_SMALLINT,
        'serial2' => self::TYPE_SMALLINT,
        'serial4' => self::TYPE_INTEGER,
        'serial' => self::TYPE_INTEGER,
        'bigserial' => self::TYPE_BIGINT,
        'serial8' => self::TYPE_BIGINT,
        'pg_lsn' => self::TYPE_BIGINT,

        'date' => self::TYPE_DATE,
        'interval' => self::TYPE_STRING,
88
        'time without time zone' => self::TYPE_TIME,
89 90 91
        'time' => self::TYPE_TIME,
        'time with time zone' => self::TYPE_TIME,
        'timetz' => self::TYPE_TIME,
92
        'timestamp without time zone' => self::TYPE_TIMESTAMP,
93
        'timestamp' => self::TYPE_TIMESTAMP,
94
        'timestamp with time zone' => self::TYPE_TIMESTAMP,
95 96 97 98 99 100 101
        'timestamptz' => self::TYPE_TIMESTAMP,
        'abstime' => self::TYPE_TIMESTAMP,

        'tsquery' => self::TYPE_STRING,
        'tsvector' => self::TYPE_STRING,
        'txid_snapshot' => self::TYPE_STRING,

102
        'unknown' => self::TYPE_STRING,
103

104
        'uuid' => self::TYPE_STRING,
105 106
        'json' => self::TYPE_STRING,
        'jsonb' => self::TYPE_STRING,
107 108 109
        'xml' => self::TYPE_STRING
    ];

110

111 112 113 114 115 116 117 118 119 120 121 122
    /**
     * Creates a query builder for the PostgreSQL database.
     * @return QueryBuilder query builder instance
     */
    public function createQueryBuilder()
    {
        return new QueryBuilder($this->db);
    }

    /**
     * Resolves the table name and schema name (if any).
     * @param TableSchema $table the table metadata object
123
     * @param string $name the table name
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
     */
    protected function resolveTableNames($table, $name)
    {
        $parts = explode('.', str_replace('"', '', $name));

        if (isset($parts[1])) {
            $table->schemaName = $parts[0];
            $table->name = $parts[1];
        } else {
            $table->schemaName = $this->defaultSchema;
            $table->name = $name;
        }

        $table->fullName = $table->schemaName !== $this->defaultSchema ? $table->schemaName . '.' . $table->name : $table->name;
    }

    /**
     * Quotes a table name for use in a query.
     * A simple table name has no schema prefix.
143
     * @param string $name table name
144 145 146 147 148 149 150 151 152
     * @return string the properly quoted table name
     */
    public function quoteSimpleTableName($name)
    {
        return strpos($name, '"') !== false ? $name : '"' . $name . '"';
    }

    /**
     * Loads the metadata for the specified table.
153
     * @param string $name table name
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
     * @return TableSchema|null driver dependent table metadata. Null if the table does not exist.
     */
    public function loadTableSchema($name)
    {
        $table = new TableSchema();
        $this->resolveTableNames($table, $name);
        if ($this->findColumns($table)) {
            $this->findConstraints($table);

            return $table;
        } else {
            return null;
        }
    }

    /**
     * Returns all table names in the database.
171 172
     * @param string $schema the schema of the tables. Defaults to empty string, meaning the current or default schema.
     * @return array all table names in the database. The names have NO schema name prefix.
173 174 175 176 177 178 179
     */
    protected function findTableNames($schema = '')
    {
        if ($schema === '') {
            $schema = $this->defaultSchema;
        }
        $sql = <<<EOD
180 181 182
SELECT table_name, table_schema FROM information_schema.tables
WHERE table_schema=:schema AND table_type='BASE TABLE'
EOD;
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
        $command = $this->db->createCommand($sql);
        $command->bindParam(':schema', $schema);
        $rows = $command->queryAll();
        $names = [];
        foreach ($rows as $row) {
            $names[] = $row['table_name'];
        }

        return $names;
    }

    /**
     * Collects the foreign key column details for the given table.
     * @param TableSchema $table the table metadata
     */
    protected function findConstraints($table)
    {

        $tableName = $this->quoteValue($table->name);
        $tableSchema = $this->quoteValue($table->schemaName);

        //We need to extract the constraints de hard way since:
        //http://www.postgresql.org/message-id/26677.1086673982@sss.pgh.pa.us

        $sql = <<<SQL
208
select
209 210 211 212
    (select string_agg(attname,',') attname from pg_attribute where attrelid=ct.conrelid and attnum = any(ct.conkey)) as columns,
    fc.relname as foreign_table_name,
    fns.nspname as foreign_table_schema,
    (select string_agg(attname,',') attname from pg_attribute where attrelid=ct.confrelid and attnum = any(ct.confkey)) as foreign_columns
213
from
214 215 216 217 218 219
    pg_constraint ct
    inner join pg_class c on c.oid=ct.conrelid
    inner join pg_namespace ns on c.relnamespace=ns.oid
    left join pg_class fc on fc.oid=ct.confrelid
    left join pg_namespace fns on fc.relnamespace=fns.oid

220
where
221 222 223
    ct.contype='f'
    and c.relname={$tableName}
    and ns.nspname={$tableSchema}
224 225
SQL;

226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
        $constraints = $this->db->createCommand($sql)->queryAll();
        foreach ($constraints as $constraint) {
            $columns = explode(',', $constraint['columns']);
            $fcolumns = explode(',', $constraint['foreign_columns']);
            if ($constraint['foreign_table_schema'] !== $this->defaultSchema) {
                $foreignTable = $constraint['foreign_table_schema'] . '.' . $constraint['foreign_table_name'];
            } else {
                $foreignTable = $constraint['foreign_table_name'];
            }
            $citem = [$foreignTable];
            foreach ($columns as $idx => $column) {
                $citem[$column] = $fcolumns[$idx];
            }
            $table->foreignKeys[] = $citem;
        }
    }

    /**
     * Gets information about given table unique indexes.
245 246
     * @param TableSchema $table the table metadata
     * @return array with index names, columns and if it is an expression tree
247 248 249 250 251 252 253
     */
    protected function getUniqueIndexInformation($table)
    {
        $tableName = $this->quoteValue($table->name);
        $tableSchema = $this->quoteValue($table->schemaName);

        $sql = <<<SQL
254
SELECT
255 256 257 258 259 260 261
    i.relname as indexname,
    ARRAY(
        SELECT pg_get_indexdef(idx.indexrelid, k + 1, True)
        FROM generate_subscripts(idx.indkey, 1) AS k
        ORDER BY k
    ) AS indexcolumns,
    idx.indexprs IS NOT NULL AS indexprs
262 263 264 265 266 267 268 269 270 271 272
FROM pg_index idx
INNER JOIN pg_class i ON i.oid = idx.indexrelid
INNER JOIN pg_class c ON c.oid = idx.indrelid
INNER JOIN pg_namespace ns ON c.relnamespace = ns.oid
WHERE idx.indisprimary != True
AND idx.indisunique = True
AND c.relname = {$tableName}
AND ns.nspname = {$tableSchema}
;
SQL;

273 274 275 276 277 278 279 280 281
        return $this->db->createCommand($sql)->queryAll();
    }

    /**
     * Returns all unique indexes for the given table.
     * Each array element is of the following structure:
     *
     * ~~~
     * [
282 283
     *  'IndexName1' => ['col1' [, ...]],
     *  'IndexName2' => ['col2' [, ...]],
284 285 286
     * ]
     * ~~~
     *
287 288
     * @param TableSchema $table the table metadata
     * @return array all unique indexes for the given table.
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
     */
    public function findUniqueIndexes($table)
    {
        $indexes = $this->getUniqueIndexInformation($table);
        $uniqueIndexes = [];

        foreach ($indexes as $index) {
            $indexName = $index['indexname'];

            if ($index['indexprs']) {
                // Index is an expression like "lower(colname::text)"
                $indexColumns = preg_replace("/.*\(([^\:]+).*/mi", "$1", $index['indexcolumns']);
            } else {
                $indexColumns = array_map('trim', explode(',', str_replace(['{', '}', '"', '\\'], '', $index['indexcolumns'])));
            }

            $uniqueIndexes[$indexName] = $indexColumns;

        }

        return $uniqueIndexes;
    }

    /**
     * Collects the metadata of table columns.
314 315
     * @param TableSchema $table the table metadata
     * @return boolean whether the table exists in the database
316 317 318 319 320 321
     */
    protected function findColumns($table)
    {
        $tableName = $this->db->quoteValue($table->name);
        $schemaName = $this->db->quoteValue($table->schemaName);
        $sql = <<<SQL
322
SELECT
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
    d.nspname AS table_schema,
    c.relname AS table_name,
    a.attname AS column_name,
    t.typname AS data_type,
    a.attlen AS character_maximum_length,
    pg_catalog.col_description(c.oid, a.attnum) AS column_comment,
    a.atttypmod AS modifier,
    a.attnotnull = false AS is_nullable,
    CAST(pg_get_expr(ad.adbin, ad.adrelid) AS varchar) AS column_default,
    coalesce(pg_get_expr(ad.adbin, ad.adrelid) ~ 'nextval',false) AS is_autoinc,
    array_to_string((select array_agg(enumlabel) from pg_enum where enumtypid=a.atttypid)::varchar[],',') as enum_values,
    CASE atttypid
         WHEN 21 /*int2*/ THEN 16
         WHEN 23 /*int4*/ THEN 32
         WHEN 20 /*int8*/ THEN 64
         WHEN 1700 /*numeric*/ THEN
              CASE WHEN atttypmod = -1
               THEN null
               ELSE ((atttypmod - 4) >> 16) & 65535
               END
         WHEN 700 /*float4*/ THEN 24 /*FLT_MANT_DIG*/
         WHEN 701 /*float8*/ THEN 53 /*DBL_MANT_DIG*/
         ELSE null
      END   AS numeric_precision,
      CASE
        WHEN atttypid IN (21, 23, 20) THEN 0
        WHEN atttypid IN (1700) THEN
        CASE
            WHEN atttypmod = -1 THEN null
            ELSE (atttypmod - 4) & 65535
        END
           ELSE null
      END AS numeric_scale,
    CAST(
357 358
             information_schema._pg_char_max_length(information_schema._pg_truetypid(a, t), information_schema._pg_truetypmod(a, t))
             AS numeric
359 360
    ) AS size,
    a.attnum = any (ct.conkey) as is_pkey
361
FROM
362 363 364 365 366 367
    pg_class c
    LEFT JOIN pg_attribute a ON a.attrelid = c.oid
    LEFT JOIN pg_attrdef ad ON a.attrelid = ad.adrelid AND a.attnum = ad.adnum
    LEFT JOIN pg_type t ON a.atttypid = t.oid
    LEFT JOIN pg_namespace d ON d.oid = c.relnamespace
    LEFT join pg_constraint ct on ct.conrelid=c.oid and ct.contype='p'
368
WHERE
369 370 371
    a.attnum > 0 and t.typname != ''
    and c.relname = {$tableName}
    and d.nspname = {$schemaName}
372
ORDER BY
373
    a.attnum;
374 375
SQL;

376 377 378 379 380 381 382
        $columns = $this->db->createCommand($sql)->queryAll();
        if (empty($columns)) {
            return false;
        }
        foreach ($columns as $column) {
            $column = $this->loadColumnSchema($column);
            $table->columns[$column->name] = $column;
383
            if ($column->isPrimaryKey) {
384 385
                $table->primaryKey[] = $column->name;
                if ($table->sequenceName === null && preg_match("/nextval\\('\"?\\w+\"?\.?\"?\\w+\"?'(::regclass)?\\)/", $column->defaultValue) === 1) {
386
                    $table->sequenceName = preg_replace(['/nextval/', '/::/', '/regclass/', '/\'\)/', '/\(\'/'], '', $column->defaultValue);
387
                }
Qiang Xue committed
388
                $column->defaultValue = null;
389
            } elseif ($column->defaultValue) {
390 391
                if ($column->type === 'timestamp' && $column->defaultValue === 'now()') {
                    $column->defaultValue = new Expression($column->defaultValue);
392 393
                } elseif ($column->type === 'boolean') {
                        $column->defaultValue = ($column->defaultValue === 'true');
394
                } elseif (stripos($column->dbType, 'bit') === 0 || stripos($column->dbType, 'varbit') === 0) {
395
                    $column->defaultValue = bindec(trim($column->defaultValue, 'B\''));
396
                } elseif (preg_match("/^'(.*?)'::/", $column->defaultValue, $matches)) {
397
                    $column->defaultValue = $matches[1];
398
                } elseif (preg_match("/^(.*?)::/", $column->defaultValue, $matches)) {
399
                    $column->defaultValue = $column->phpTypecast($matches[1]);
400
                } else {
401
                    $column->defaultValue = $column->phpTypecast($column->defaultValue);
402 403
                }
            }
404 405 406 407 408 409 410
        }

        return true;
    }

    /**
     * Loads the column information into a [[ColumnSchema]] object.
411
     * @param array $info column information
412 413 414 415
     * @return ColumnSchema the column schema object
     */
    protected function loadColumnSchema($info)
    {
416
        $column = $this->createColumnSchema();
417 418 419 420 421
        $column->allowNull = $info['is_nullable'];
        $column->autoIncrement = $info['is_autoinc'];
        $column->comment = $info['column_comment'];
        $column->dbType = $info['data_type'];
        $column->defaultValue = $info['column_default'];
makroxyz committed
422
        $column->enumValues = ($info['enum_values'] !== null) ? explode(',', str_replace(["''"], ["'"], $info['enum_values'])) : null;
423 424 425 426 427
        $column->unsigned = false; // has no meaning in PG
        $column->isPrimaryKey = $info['is_pkey'];
        $column->name = $info['column_name'];
        $column->precision = $info['numeric_precision'];
        $column->scale = $info['numeric_scale'];
Alexander Mohorev committed
428
        $column->size = $info['size'] === null ? null : (int) $info['size'];
429 430 431 432 433 434 435 436 437
        if (isset($this->typeMap[$column->dbType])) {
            $column->type = $this->typeMap[$column->dbType];
        } else {
            $column->type = self::TYPE_STRING;
        }
        $column->phpType = $this->getColumnPhpType($column);

        return $column;
    }
gevik committed
438
}