Schema.php 12.1 KB
Newer Older
1
<?php
2

3 4 5 6 7 8 9 10 11 12 13 14
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\db\pgsql;

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
	 * The default schema used for the current session.
Qiang Xue committed
26
	 * @var string
27
	 */
28
	public $defaultSchema = 'public';
29 30

	/**
Qiang Xue committed
31
	 * @var array mapping from physical column types (keys) to abstract
32 33
	 * column types (values)
	 */
Alexander Makarov committed
34
	public $typeMap = [
Qiang Xue committed
35 36
		'abstime' => self::TYPE_TIMESTAMP,
		'bit' => self::TYPE_STRING,
37
		'bool' => self::TYPE_BOOLEAN,
Qiang Xue committed
38 39 40 41 42 43 44 45 46
		'boolean' => self::TYPE_BOOLEAN,
		'box' => self::TYPE_STRING,
		'character' => self::TYPE_STRING,
		'bytea' => self::TYPE_BINARY,
		'char' => self::TYPE_STRING,
		'cidr' => self::TYPE_STRING,
		'circle' => self::TYPE_STRING,
		'date' => self::TYPE_DATE,
		'real' => self::TYPE_FLOAT,
47
		'decimal' => self::TYPE_DECIMAL,
Qiang Xue committed
48 49 50
		'double precision' => self::TYPE_DECIMAL,
		'inet' => self::TYPE_STRING,
		'smallint' => self::TYPE_SMALLINT,
51
		'int4' => self::TYPE_INTEGER,
Qiang Xue committed
52
		'int8' => self::TYPE_BIGINT,
Qiang Xue committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
		'integer' => self::TYPE_INTEGER,
		'bigint' => self::TYPE_BIGINT,
		'interval' => self::TYPE_STRING,
		'json' => self::TYPE_STRING,
		'line' => self::TYPE_STRING,
		'macaddr' => self::TYPE_STRING,
		'money' => self::TYPE_MONEY,
		'name' => self::TYPE_STRING,
		'numeric' => self::TYPE_STRING,
		'oid' => self::TYPE_BIGINT, // should not be used. it's pg internal!
		'path' => self::TYPE_STRING,
		'point' => self::TYPE_STRING,
		'polygon' => self::TYPE_STRING,
		'text' => self::TYPE_TEXT,
		'time without time zone' => self::TYPE_TIME,
		'timestamp without time zone' => self::TYPE_TIMESTAMP,
		'timestamp with time zone' => self::TYPE_TIMESTAMP,
		'time with time zone' => self::TYPE_TIMESTAMP,
		'unknown' => self::TYPE_STRING,
		'uuid' => self::TYPE_STRING,
		'bit varying' => self::TYPE_STRING,
		'character varying' => self::TYPE_STRING,
		'xml' => self::TYPE_STRING
Alexander Makarov committed
76
	];
77

78
	/**
79
	 * Creates a query builder for the PostgreSQL database.
80 81
	 * @return QueryBuilder query builder instance
	 */
Qiang Xue committed
82 83
	public function createQueryBuilder()
	{
84 85 86
		return new QueryBuilder($this->db);
	}

87 88 89 90 91
	/**
	 * Resolves the table name and schema name (if any).
	 * @param TableSchema $table the table metadata object
	 * @param string $name the table name
	 */
Qiang Xue committed
92 93
	protected function resolveTableNames($table, $name)
	{
94
		$parts = explode('.', str_replace('"', '', $name));
95
		if (isset($parts[1])) {
96 97
			$table->schemaName = $parts[0];
			$table->name = $parts[1];
98
		} else {
99 100
			$table->name = $parts[0];
		}
101
		if ($table->schemaName === null) {
102
			$table->schemaName = $this->defaultSchema;
103
		}
104
	}
105

106 107 108 109 110 111
	/**
	 * Quotes a table name for use in a query.
	 * A simple table name has no schema prefix.
	 * @param string $name table name
	 * @return string the properly quoted table name
	 */
Qiang Xue committed
112 113
	public function quoteSimpleTableName($name)
	{
114 115 116
		return strpos($name, '"') !== false ? $name : '"' . $name . '"';
	}

117 118 119 120 121
	/**
	 * Loads the metadata for the specified table.
	 * @param string $name table name
	 * @return TableSchema|null driver dependent table metadata. Null if the table does not exist.
	 */
Qiang Xue committed
122 123
	public function loadTableSchema($name)
	{
124 125
		$table = new TableSchema();
		$this->resolveTableNames($table, $name);
126
		if ($this->findColumns($table)) {
127
			$this->findConstraints($table);
128
			return $table;
gevik committed
129 130
		} else {
			return null;
131
		}
132
	}
133

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
	/**
	 * Determines the PDO type for the given PHP data value.
	 * @param mixed $data the data whose PDO type is to be determined
	 * @return integer the PDO type
	 * @see http://www.php.net/manual/en/pdo.constants.php
	 */
	public function getPdoType($data)
	{
		// php type => PDO type
		static $typeMap = [
			// https://github.com/yiisoft/yii2/issues/1115
			// Cast boolean to integer values to work around problems with PDO casting false to string '' https://bugs.php.net/bug.php?id=33876
			'boolean' => \PDO::PARAM_INT,
			'integer' => \PDO::PARAM_INT,
			'string' => \PDO::PARAM_STR,
			'resource' => \PDO::PARAM_LOB,
			'NULL' => \PDO::PARAM_NULL,
		];
		$type = gettype($data);
		return isset($typeMap[$type]) ? $typeMap[$type] : \PDO::PARAM_STR;
	}

156 157 158
	/**
	 * Returns all table names in the database.
	 * @param string $schema the schema of the tables. Defaults to empty string, meaning the current or default schema.
159
	 * @return array all table names in the database. The names have NO schema name prefix.
160
	 */
161
	protected function findTableNames($schema = '')
162 163 164 165 166 167 168 169 170 171 172
	{
		if ($schema === '') {
			$schema = $this->defaultSchema;
		}
		$sql = <<<EOD
SELECT table_name, table_schema FROM information_schema.tables
WHERE table_schema=:schema AND table_type='BASE TABLE'
EOD;
		$command = $this->db->createCommand($sql);
		$command->bindParam(':schema', $schema);
		$rows = $command->queryAll();
Alexander Makarov committed
173
		$names = [];
174
		foreach ($rows as $row) {
175
			$names[] = $row['table_name'];
176 177 178 179
		}
		return $names;
	}

180 181 182 183
	/**
	 * Collects the foreign key column details for the given table.
	 * @param TableSchema $table the table metadata
	 */
Qiang Xue committed
184 185
	protected function findConstraints($table)
	{
186

187 188 189 190 191 192 193
		$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
194
select
195 196 197 198 199
	(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
from
200
	pg_constraint ct
201 202 203 204 205 206 207 208 209 210 211
	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
	
where
	ct.contype='f'
	and c.relname={$tableName}
	and ns.nspname={$tableSchema}
SQL;

212
		$constraints = $this->db->createCommand($sql)->queryAll();
213
		foreach ($constraints as $constraint) {
214 215
			$columns = explode(',', $constraint['columns']);
			$fcolumns = explode(',', $constraint['foreign_columns']);
216
			if ($constraint['foreign_table_schema'] !== $this->defaultSchema) {
Qiang Xue committed
217
				$foreignTable = $constraint['foreign_table_schema'] . '.' . $constraint['foreign_table_name'];
218
			} else {
Qiang Xue committed
219
				$foreignTable = $constraint['foreign_table_name'];
220
			}
Alexander Makarov committed
221
			$citem = [$foreignTable];
222
			foreach ($columns as $idx => $column) {
223
				$citem[$column] = $fcolumns[$idx];
224 225
			}
			$table->foreignKeys[] = $citem;
226 227 228
		}
	}

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
	/**
	 * Gets information about given table unique indexes.
	 * @param TableSchema $table the table metadata
	 * @return array with index names, columns and if it is an expression tree
	 */
	protected function getUniqueIndexInformation($table)
	{
		$tableName = $this->quoteValue($table->name);
		$tableSchema = $this->quoteValue($table->schemaName);

		$sql = <<<SQL
SELECT
	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
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;

		return $this->db->createCommand($sql)->queryAll();
	}

	/**
	 * Returns all unique indexes for the given table.
	 * Each array element is of the following structure:
	 *
	 * ~~~
	 * [
	 *	 'IndexName1' => ['col1' [, ...]],
	 *	 'IndexName2' => ['col2' [, ...]],
	 * ]
	 * ~~~
	 *
	 * @param TableSchema $table the table metadata
	 * @return array all unique indexes for the given table.
	 */
276
	public function findUniqueIndexes($table)
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
	{
		$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;
	}

297 298 299 300 301
	/**
	 * Collects the metadata of table columns.
	 * @param TableSchema $table the table metadata
	 * @return boolean whether the table exists in the database
	 */
Qiang Xue committed
302 303
	protected function findColumns($table)
	{
304 305 306
		$tableName = $this->db->quoteValue($table->name);
		$schemaName = $this->db->quoteValue($table->schemaName);
		$sql = <<<SQL
307
SELECT
308 309 310 311 312 313 314 315 316 317 318
	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,
319 320 321 322 323 324 325 326 327 328 329 330 331
	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,
332
	  CASE
333
	    WHEN atttypid IN (21, 23, 20) THEN 0
334 335 336
	    WHEN atttypid IN (1700) THEN
		CASE
		    WHEN atttypmod = -1 THEN null
337 338 339 340 341 342 343 344
		    ELSE (atttypmod - 4) & 65535
		END
	       ELSE null
	  END AS numeric_scale,
	CAST(
             information_schema._pg_char_max_length(information_schema._pg_truetypid(a, t), information_schema._pg_truetypmod(a, t))
             AS numeric
	) AS size,
345
	a.attnum = any (ct.conkey) as is_pkey
346 347 348 349 350
FROM
	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
351 352
	LEFT JOIN pg_namespace d ON d.oid = c.relnamespace
	LEFT join pg_constraint ct on ct.conrelid=c.oid and ct.contype='p'
353
WHERE
Qiang Xue committed
354
	a.attnum > 0 and t.typname != ''
355 356 357 358 359 360
	and c.relname = {$tableName}
	and d.nspname = {$schemaName}
ORDER BY
	a.attnum;
SQL;

gevik committed
361
		$columns = $this->db->createCommand($sql)->queryAll();
gsd committed
362 363 364
		if (empty($columns)) {
			return false;
		}
365 366
		foreach ($columns as $column) {
			$column = $this->loadColumnSchema($column);
367
			$table->columns[$column->name] = $column;
368
			if ($column->isPrimaryKey === true) {
369
				$table->primaryKey[] = $column->name;
370
				if ($table->sequenceName === null && preg_match("/nextval\\('\"?\\w+\"?\.?\"?\\w+\"?'(::regclass)?\\)/", $column->defaultValue) === 1) {
Alexander Makarov committed
371
					$table->sequenceName = preg_replace(['/nextval/', '/::/', '/regclass/', '/\'\)/', '/\(\'/'], '', $column->defaultValue);
372 373
				}
			}
374
		}
375
		return true;
376 377 378 379 380 381 382
	}

	/**
	 * Loads the column information into a [[ColumnSchema]] object.
	 * @param array $info column information
	 * @return ColumnSchema the column schema object
	 */
Qiang Xue committed
383 384
	protected function loadColumnSchema($info)
	{
385 386 387 388 389 390
		$column = new ColumnSchema();
		$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'];
Alexander Makarov committed
391
		$column->enumValues = explode(',', str_replace(["''"], ["'"], $info['enum_values']));
392
		$column->unsigned = false; // has no meaning in PG
393
		$column->isPrimaryKey = $info['is_pkey'];
394
		$column->name = $info['column_name'];
395 396 397 398
		$column->precision = $info['numeric_precision'];
		$column->scale = $info['numeric_scale'];
		$column->size = $info['size'];

399
		if (isset($this->typeMap[$column->dbType])) {
400
			$column->type = $this->typeMap[$column->dbType];
401
		} else {
402 403 404
			$column->type = self::TYPE_STRING;
		}
		$column->phpType = $this->getColumnPhpType($column);
405 406
		return $column;
	}
gevik committed
407
}