Schema.php 8.89 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 34
	 * column types (values)
	 */
	public $typeMap = array(
Qiang Xue committed
35 36 37 38 39 40 41 42 43 44 45
		'abstime' => self::TYPE_TIMESTAMP,
		'bit' => self::TYPE_STRING,
		'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,
46
		'decimal' => self::TYPE_DECIMAL,
Qiang Xue committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
		'double precision' => self::TYPE_DECIMAL,
		'inet' => self::TYPE_STRING,
		'smallint' => self::TYPE_SMALLINT,
		'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
73 74
	);

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

84 85 86 87 88
	/**
	 * 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
89 90
	protected function resolveTableNames($table, $name)
	{
91
		$parts = explode('.', str_replace('"', '', $name));
92
		if (isset($parts[1])) {
93 94
			$table->schemaName = $parts[0];
			$table->name = $parts[1];
95
		} else {
96 97
			$table->name = $parts[0];
		}
98
		if ($table->schemaName === null) {
99
			$table->schemaName = $this->defaultSchema;
100
		}
101
	}
102

103 104 105 106 107 108
	/**
	 * 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
109 110
	public function quoteSimpleTableName($name)
	{
111 112 113
		return strpos($name, '"') !== false ? $name : '"' . $name . '"';
	}

114 115 116 117 118
	/**
	 * 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
119 120
	public function loadTableSchema($name)
	{
121 122
		$table = new TableSchema();
		$this->resolveTableNames($table, $name);
123
		if ($this->findColumns($table)) {
124
			$this->findConstraints($table);
125
			return $table;
gevik committed
126 127
		} else {
			return null;
128
		}
129
	}
130

131 132 133 134
	/**
	 * Collects the foreign key column details for the given table.
	 * @param TableSchema $table the table metadata
	 */
Qiang Xue committed
135 136
	protected function findConstraints($table)
	{
137

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
		$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
select 
	(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
	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
	
where
	ct.contype='f'
	and c.relname={$tableName}
	and ns.nspname={$tableSchema}
SQL;

163
		$constraints = $this->db->createCommand($sql)->queryAll();
164
		foreach ($constraints as $constraint) {
165 166
			$columns = explode(',', $constraint['columns']);
			$fcolumns = explode(',', $constraint['foreign_columns']);
167
			if ($constraint['foreign_table_schema'] !== $this->defaultSchema) {
Qiang Xue committed
168
				$foreignTable = $constraint['foreign_table_schema'] . '.' . $constraint['foreign_table_name'];
169
			} else {
Qiang Xue committed
170
				$foreignTable = $constraint['foreign_table_name'];
171
			}
Qiang Xue committed
172
			$citem = array($foreignTable);
173 174 175 176
			foreach ($columns as $idx => $column) {
				$citem[] = array($fcolumns[$idx] => $column);
			}
			$table->foreignKeys[] = $citem;
177 178 179
		}
	}

180 181 182 183 184
	/**
	 * Collects the metadata of table columns.
	 * @param TableSchema $table the table metadata
	 * @return boolean whether the table exists in the database
	 */
Qiang Xue committed
185 186
	protected function findColumns($table)
	{
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
		$tableName = $this->db->quoteValue($table->name);
		$schemaName = $this->db->quoteValue($table->schemaName);
		$sql = <<<SQL
SELECT 
	current_database() as table_catalog,
	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,
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
        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(
             information_schema._pg_char_max_length(information_schema._pg_truetypid(a, t), information_schema._pg_truetypmod(a, t))
             AS numeric
	) AS size,
	a.attnum = any (ct.conkey) as is_pkey			
230 231 232 233 234
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
235 236
	LEFT JOIN pg_namespace d ON d.oid = c.relnamespace
	LEFT join pg_constraint ct on ct.conrelid=c.oid and ct.contype='p'
237 238 239 240 241 242 243 244
WHERE
	a.attnum > 0
	and c.relname = {$tableName}
	and d.nspname = {$schemaName}
ORDER BY
	a.attnum;
SQL;

gevik committed
245
		$columns = $this->db->createCommand($sql)->queryAll();
gsd committed
246 247 248
		if (empty($columns)) {
			return false;
		}
249 250
		foreach ($columns as $column) {
			$column = $this->loadColumnSchema($column);
251
			$table->columns[$column->name] = $column;
252
			if ($column->isPrimaryKey === true) {
253
				$table->primaryKey[] = $column->name;
254
				if ($table->sequenceName === null && preg_match("/nextval\('\w+'(::regclass)?\)/", $column->defaultValue) === 1) {
255 256 257
					$table->sequenceName = preg_replace(array('/nextval/', '/::/', '/regclass/', '/\'\)/', '/\(\'/'), '', $column->defaultValue);
				}
			}
258
		}
259
		return true;
260 261 262 263 264 265 266
	}

	/**
	 * Loads the column information into a [[ColumnSchema]] object.
	 * @param array $info column information
	 * @return ColumnSchema the column schema object
	 */
Qiang Xue committed
267 268
	protected function loadColumnSchema($info)
	{
269 270 271 272 273 274 275
		$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'];
		$column->enumValues = explode(',', str_replace(array("''"), array("'"), $info['enum_values']));
276 277
		$column->unsigned = false; // has no meanining in PG
		$column->isPrimaryKey = $info['is_pkey'];
278
		$column->name = $info['column_name'];
279 280 281 282
		$column->precision = $info['numeric_precision'];
		$column->scale = $info['numeric_scale'];
		$column->size = $info['size'];

283
		if (isset($this->typeMap[$column->dbType])) {
284
			$column->type = $this->typeMap[$column->dbType];
285
		} else {
286 287 288
			$column->type = self::TYPE_STRING;
		}
		$column->phpType = $this->getColumnPhpType($column);
289 290
		return $column;
	}
gevik committed
291
}