Postgres.php 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919
  1. <?php
  2. /**
  3. * PostgreSQL layer for DBO.
  4. *
  5. * PHP 5
  6. *
  7. * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  8. * Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
  9. *
  10. * Licensed under The MIT License
  11. * Redistributions of files must retain the above copyright notice.
  12. *
  13. * @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
  14. * @link http://cakephp.org CakePHP(tm) Project
  15. * @package Cake.Model.Datasource.Database
  16. * @since CakePHP(tm) v 0.9.1.114
  17. * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  18. */
  19. App::uses('DboSource', 'Model/Datasource');
  20. /**
  21. * PostgreSQL layer for DBO.
  22. *
  23. * @package Cake.Model.Datasource.Database
  24. */
  25. class Postgres extends DboSource {
  26. /**
  27. * Driver description
  28. *
  29. * @var string
  30. */
  31. public $description = "PostgreSQL DBO Driver";
  32. /**
  33. * Base driver configuration settings. Merged with user settings.
  34. *
  35. * @var array
  36. */
  37. protected $_baseConfig = array(
  38. 'persistent' => true,
  39. 'host' => 'localhost',
  40. 'login' => 'root',
  41. 'password' => '',
  42. 'database' => 'cake',
  43. 'schema' => 'public',
  44. 'port' => 5432,
  45. 'encoding' => ''
  46. );
  47. /**
  48. * Columns
  49. *
  50. * @var array
  51. */
  52. public $columns = array(
  53. 'primary_key' => array('name' => 'serial NOT NULL'),
  54. 'string' => array('name' => 'varchar', 'limit' => '255'),
  55. 'text' => array('name' => 'text'),
  56. 'integer' => array('name' => 'integer', 'formatter' => 'intval'),
  57. 'biginteger' => array('name' => 'bigint', 'limit' => '20'),
  58. 'float' => array('name' => 'float', 'formatter' => 'floatval'),
  59. 'datetime' => array('name' => 'timestamp', 'format' => 'Y-m-d H:i:s', 'formatter' => 'date'),
  60. 'timestamp' => array('name' => 'timestamp', 'format' => 'Y-m-d H:i:s', 'formatter' => 'date'),
  61. 'time' => array('name' => 'time', 'format' => 'H:i:s', 'formatter' => 'date'),
  62. 'date' => array('name' => 'date', 'format' => 'Y-m-d', 'formatter' => 'date'),
  63. 'binary' => array('name' => 'bytea'),
  64. 'boolean' => array('name' => 'boolean'),
  65. 'number' => array('name' => 'numeric'),
  66. 'inet' => array('name' => 'inet')
  67. );
  68. /**
  69. * Starting Quote
  70. *
  71. * @var string
  72. */
  73. public $startQuote = '"';
  74. /**
  75. * Ending Quote
  76. *
  77. * @var string
  78. */
  79. public $endQuote = '"';
  80. /**
  81. * Contains mappings of custom auto-increment sequences, if a table uses a sequence name
  82. * other than what is dictated by convention.
  83. *
  84. * @var array
  85. */
  86. protected $_sequenceMap = array();
  87. /**
  88. * Connects to the database using options in the given configuration array.
  89. *
  90. * @return boolean True if successfully connected.
  91. * @throws MissingConnectionException
  92. */
  93. public function connect() {
  94. $config = $this->config;
  95. $this->connected = false;
  96. try {
  97. $flags = array(
  98. PDO::ATTR_PERSISTENT => $config['persistent'],
  99. PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION
  100. );
  101. $this->_connection = new PDO(
  102. "pgsql:host={$config['host']};port={$config['port']};dbname={$config['database']}",
  103. $config['login'],
  104. $config['password'],
  105. $flags
  106. );
  107. $this->connected = true;
  108. if (!empty($config['encoding'])) {
  109. $this->setEncoding($config['encoding']);
  110. }
  111. if (!empty($config['schema'])) {
  112. $this->_execute('SET search_path TO ' . $config['schema']);
  113. }
  114. } catch (PDOException $e) {
  115. throw new MissingConnectionException(array('class' => $e->getMessage()));
  116. }
  117. return $this->connected;
  118. }
  119. /**
  120. * Check if PostgreSQL is enabled/loaded
  121. *
  122. * @return boolean
  123. */
  124. public function enabled() {
  125. return in_array('pgsql', PDO::getAvailableDrivers());
  126. }
  127. /**
  128. * Returns an array of tables in the database. If there are no tables, an error is raised and the application exits.
  129. *
  130. * @param mixed $data
  131. * @return array Array of table names in the database
  132. */
  133. public function listSources($data = null) {
  134. $cache = parent::listSources();
  135. if ($cache != null) {
  136. return $cache;
  137. }
  138. $schema = $this->config['schema'];
  139. $sql = "SELECT table_name as name FROM INFORMATION_SCHEMA.tables WHERE table_schema = ?";
  140. $result = $this->_execute($sql, array($schema));
  141. if (!$result) {
  142. return array();
  143. } else {
  144. $tables = array();
  145. foreach ($result as $item) {
  146. $tables[] = $item->name;
  147. }
  148. $result->closeCursor();
  149. parent::listSources($tables);
  150. return $tables;
  151. }
  152. }
  153. /**
  154. * Returns an array of the fields in given table name.
  155. *
  156. * @param Model|string $model Name of database table to inspect
  157. * @return array Fields in table. Keys are name and type
  158. */
  159. public function describe($model) {
  160. $table = $this->fullTableName($model, false, false);
  161. $fields = parent::describe($table);
  162. $this->_sequenceMap[$table] = array();
  163. $cols = null;
  164. if ($fields === null) {
  165. $cols = $this->_execute(
  166. "SELECT DISTINCT table_schema AS schema, column_name AS name, data_type AS type, is_nullable AS null,
  167. column_default AS default, ordinal_position AS position, character_maximum_length AS char_length,
  168. character_octet_length AS oct_length FROM information_schema.columns
  169. WHERE table_name = ? AND table_schema = ? ORDER BY position",
  170. array($table, $this->config['schema'])
  171. );
  172. // @codingStandardsIgnoreStart
  173. // Postgres columns don't match the coding standards.
  174. foreach ($cols as $c) {
  175. $type = $c->type;
  176. if (!empty($c->oct_length) && $c->char_length === null) {
  177. if ($c->type == 'character varying') {
  178. $length = null;
  179. $type = 'text';
  180. } elseif ($c->type == 'uuid') {
  181. $length = 36;
  182. } else {
  183. $length = intval($c->oct_length);
  184. }
  185. } elseif (!empty($c->char_length)) {
  186. $length = intval($c->char_length);
  187. } else {
  188. $length = $this->length($c->type);
  189. }
  190. if (empty($length)) {
  191. $length = null;
  192. }
  193. $fields[$c->name] = array(
  194. 'type' => $this->column($type),
  195. 'null' => ($c->null == 'NO' ? false : true),
  196. 'default' => preg_replace(
  197. "/^'(.*)'$/",
  198. "$1",
  199. preg_replace('/::.*/', '', $c->default)
  200. ),
  201. 'length' => $length
  202. );
  203. if ($model instanceof Model) {
  204. if ($c->name == $model->primaryKey) {
  205. $fields[$c->name]['key'] = 'primary';
  206. if ($fields[$c->name]['type'] !== 'string') {
  207. $fields[$c->name]['length'] = 11;
  208. }
  209. }
  210. }
  211. if (
  212. $fields[$c->name]['default'] == 'NULL' ||
  213. preg_match('/nextval\([\'"]?([\w.]+)/', $c->default, $seq)
  214. ) {
  215. $fields[$c->name]['default'] = null;
  216. if (!empty($seq) && isset($seq[1])) {
  217. if (strpos($seq[1], '.') === false) {
  218. $sequenceName = $c->schema . '.' . $seq[1];
  219. } else {
  220. $sequenceName = $seq[1];
  221. }
  222. $this->_sequenceMap[$table][$c->name] = $sequenceName;
  223. }
  224. }
  225. if ($fields[$c->name]['type'] == 'boolean' && !empty($fields[$c->name]['default'])) {
  226. $fields[$c->name]['default'] = constant($fields[$c->name]['default']);
  227. }
  228. }
  229. $this->_cacheDescription($table, $fields);
  230. }
  231. // @codingStandardsIgnoreEnd
  232. if (isset($model->sequence)) {
  233. $this->_sequenceMap[$table][$model->primaryKey] = $model->sequence;
  234. }
  235. if ($cols) {
  236. $cols->closeCursor();
  237. }
  238. return $fields;
  239. }
  240. /**
  241. * Returns the ID generated from the previous INSERT operation.
  242. *
  243. * @param string $source Name of the database table
  244. * @param string $field Name of the ID database field. Defaults to "id"
  245. * @return integer
  246. */
  247. public function lastInsertId($source = null, $field = 'id') {
  248. $seq = $this->getSequence($source, $field);
  249. return $this->_connection->lastInsertId($seq);
  250. }
  251. /**
  252. * Gets the associated sequence for the given table/field
  253. *
  254. * @param string|Model $table Either a full table name (with prefix) as a string, or a model object
  255. * @param string $field Name of the ID database field. Defaults to "id"
  256. * @return string The associated sequence name from the sequence map, defaults to "{$table}_{$field}_seq"
  257. */
  258. public function getSequence($table, $field = 'id') {
  259. if (is_object($table)) {
  260. $table = $this->fullTableName($table, false, false);
  261. }
  262. if (isset($this->_sequenceMap[$table]) && isset($this->_sequenceMap[$table][$field])) {
  263. return $this->_sequenceMap[$table][$field];
  264. } else {
  265. return "{$table}_{$field}_seq";
  266. }
  267. }
  268. /**
  269. * Deletes all the records in a table and drops all associated auto-increment sequences
  270. *
  271. * @param string|Model $table A string or model class representing the table to be truncated
  272. * @param boolean $reset true for resetting the sequence, false to leave it as is.
  273. * and if 1, sequences are not modified
  274. * @return boolean SQL TRUNCATE TABLE statement, false if not applicable.
  275. */
  276. public function truncate($table, $reset = false) {
  277. $table = $this->fullTableName($table, false, false);
  278. if (!isset($this->_sequenceMap[$table])) {
  279. $cache = $this->cacheSources;
  280. $this->cacheSources = false;
  281. $this->describe($table);
  282. $this->cacheSources = $cache;
  283. }
  284. if ($this->execute('DELETE FROM ' . $this->fullTableName($table))) {
  285. $schema = $this->config['schema'];
  286. if (isset($this->_sequenceMap[$table]) && $reset != true) {
  287. foreach ($this->_sequenceMap[$table] as $field => $sequence) {
  288. list($schema, $sequence) = explode('.', $sequence);
  289. $this->_execute("ALTER SEQUENCE \"{$schema}\".\"{$sequence}\" RESTART WITH 1");
  290. }
  291. }
  292. return true;
  293. }
  294. return false;
  295. }
  296. /**
  297. * Prepares field names to be quoted by parent
  298. *
  299. * @param string $data
  300. * @return string SQL field
  301. */
  302. public function name($data) {
  303. if (is_string($data)) {
  304. $data = str_replace('"__"', '__', $data);
  305. }
  306. return parent::name($data);
  307. }
  308. /**
  309. * Generates the fields list of an SQL query.
  310. *
  311. * @param Model $model
  312. * @param string $alias Alias table name
  313. * @param mixed $fields
  314. * @param boolean $quote
  315. * @return array
  316. */
  317. public function fields(Model $model, $alias = null, $fields = array(), $quote = true) {
  318. if (empty($alias)) {
  319. $alias = $model->alias;
  320. }
  321. $fields = parent::fields($model, $alias, $fields, false);
  322. if (!$quote) {
  323. return $fields;
  324. }
  325. $count = count($fields);
  326. if ($count >= 1 && !preg_match('/^\s*COUNT\(\*/', $fields[0])) {
  327. $result = array();
  328. for ($i = 0; $i < $count; $i++) {
  329. if (!preg_match('/^.+\\(.*\\)/', $fields[$i]) && !preg_match('/\s+AS\s+/', $fields[$i])) {
  330. if (substr($fields[$i], -1) == '*') {
  331. if (strpos($fields[$i], '.') !== false && $fields[$i] != $alias . '.*') {
  332. $build = explode('.', $fields[$i]);
  333. $AssociatedModel = $model->{$build[0]};
  334. } else {
  335. $AssociatedModel = $model;
  336. }
  337. $_fields = $this->fields($AssociatedModel, $AssociatedModel->alias, array_keys($AssociatedModel->schema()));
  338. $result = array_merge($result, $_fields);
  339. continue;
  340. }
  341. $prepend = '';
  342. if (strpos($fields[$i], 'DISTINCT') !== false) {
  343. $prepend = 'DISTINCT ';
  344. $fields[$i] = trim(str_replace('DISTINCT', '', $fields[$i]));
  345. }
  346. if (strrpos($fields[$i], '.') === false) {
  347. $fields[$i] = $prepend . $this->name($alias) . '.' . $this->name($fields[$i]) . ' AS ' . $this->name($alias . '__' . $fields[$i]);
  348. } else {
  349. $build = explode('.', $fields[$i]);
  350. $fields[$i] = $prepend . $this->name($build[0]) . '.' . $this->name($build[1]) . ' AS ' . $this->name($build[0] . '__' . $build[1]);
  351. }
  352. } else {
  353. $fields[$i] = preg_replace_callback('/\(([\s\.\w]+)\)/', array(&$this, '_quoteFunctionField'), $fields[$i]);
  354. }
  355. $result[] = $fields[$i];
  356. }
  357. return $result;
  358. }
  359. return $fields;
  360. }
  361. /**
  362. * Auxiliary function to quote matched `(Model.fields)` from a preg_replace_callback call
  363. * Quotes the fields in a function call.
  364. *
  365. * @param string $match matched string
  366. * @return string quoted string
  367. */
  368. protected function _quoteFunctionField($match) {
  369. $prepend = '';
  370. if (strpos($match[1], 'DISTINCT') !== false) {
  371. $prepend = 'DISTINCT ';
  372. $match[1] = trim(str_replace('DISTINCT', '', $match[1]));
  373. }
  374. $constant = preg_match('/^\d+|NULL|FALSE|TRUE$/i', $match[1]);
  375. if (!$constant && strpos($match[1], '.') === false) {
  376. $match[1] = $this->name($match[1]);
  377. } elseif (!$constant) {
  378. $parts = explode('.', $match[1]);
  379. if (!Hash::numeric($parts)) {
  380. $match[1] = $this->name($match[1]);
  381. }
  382. }
  383. return '(' . $prepend . $match[1] . ')';
  384. }
  385. /**
  386. * Returns an array of the indexes in given datasource name.
  387. *
  388. * @param string $model Name of model to inspect
  389. * @return array Fields in table. Keys are column and unique
  390. */
  391. public function index($model) {
  392. $index = array();
  393. $table = $this->fullTableName($model, false, false);
  394. if ($table) {
  395. $indexes = $this->query("SELECT c2.relname, i.indisprimary, i.indisunique, i.indisclustered, i.indisvalid, pg_catalog.pg_get_indexdef(i.indexrelid, 0, true) as statement, c2.reltablespace
  396. FROM pg_catalog.pg_class c, pg_catalog.pg_class c2, pg_catalog.pg_index i
  397. WHERE c.oid = (
  398. SELECT c.oid
  399. FROM pg_catalog.pg_class c LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
  400. WHERE c.relname ~ '^(" . $table . ")$'
  401. AND pg_catalog.pg_table_is_visible(c.oid)
  402. AND n.nspname ~ '^(" . $this->config['schema'] . ")$'
  403. )
  404. AND c.oid = i.indrelid AND i.indexrelid = c2.oid
  405. ORDER BY i.indisprimary DESC, i.indisunique DESC, c2.relname", false);
  406. foreach ($indexes as $i => $info) {
  407. $key = array_pop($info);
  408. if ($key['indisprimary']) {
  409. $key['relname'] = 'PRIMARY';
  410. }
  411. preg_match('/\(([^\)]+)\)/', $key['statement'], $indexColumns);
  412. $parsedColumn = $indexColumns[1];
  413. if (strpos($indexColumns[1], ',') !== false) {
  414. $parsedColumn = explode(', ', $indexColumns[1]);
  415. }
  416. $index[$key['relname']]['unique'] = $key['indisunique'];
  417. $index[$key['relname']]['column'] = $parsedColumn;
  418. }
  419. }
  420. return $index;
  421. }
  422. /**
  423. * Alter the Schema of a table.
  424. *
  425. * @param array $compare Results of CakeSchema::compare()
  426. * @param string $table name of the table
  427. * @return array
  428. */
  429. public function alterSchema($compare, $table = null) {
  430. if (!is_array($compare)) {
  431. return false;
  432. }
  433. $out = '';
  434. $colList = array();
  435. foreach ($compare as $curTable => $types) {
  436. $indexes = $colList = array();
  437. if (!$table || $table == $curTable) {
  438. $out .= 'ALTER TABLE ' . $this->fullTableName($curTable) . " \n";
  439. foreach ($types as $type => $column) {
  440. if (isset($column['indexes'])) {
  441. $indexes[$type] = $column['indexes'];
  442. unset($column['indexes']);
  443. }
  444. switch ($type) {
  445. case 'add':
  446. foreach ($column as $field => $col) {
  447. $col['name'] = $field;
  448. $colList[] = 'ADD COLUMN ' . $this->buildColumn($col);
  449. }
  450. break;
  451. case 'drop':
  452. foreach ($column as $field => $col) {
  453. $col['name'] = $field;
  454. $colList[] = 'DROP COLUMN ' . $this->name($field);
  455. }
  456. break;
  457. case 'change':
  458. foreach ($column as $field => $col) {
  459. if (!isset($col['name'])) {
  460. $col['name'] = $field;
  461. }
  462. $fieldName = $this->name($field);
  463. $default = isset($col['default']) ? $col['default'] : null;
  464. $nullable = isset($col['null']) ? $col['null'] : null;
  465. unset($col['default'], $col['null']);
  466. $colList[] = 'ALTER COLUMN ' . $fieldName . ' TYPE ' . str_replace(array($fieldName, 'NOT NULL'), '', $this->buildColumn($col));
  467. if (isset($nullable)) {
  468. $nullable = ($nullable) ? 'DROP NOT NULL' : 'SET NOT NULL';
  469. $colList[] = 'ALTER COLUMN ' . $fieldName . ' ' . $nullable;
  470. }
  471. if (isset($default)) {
  472. $colList[] = 'ALTER COLUMN ' . $fieldName . ' SET DEFAULT ' . $this->value($default, $col['type']);
  473. } else {
  474. $colList[] = 'ALTER COLUMN ' . $fieldName . ' DROP DEFAULT';
  475. }
  476. }
  477. break;
  478. }
  479. }
  480. if (isset($indexes['drop']['PRIMARY'])) {
  481. $colList[] = 'DROP CONSTRAINT ' . $curTable . '_pkey';
  482. }
  483. if (isset($indexes['add']['PRIMARY'])) {
  484. $cols = $indexes['add']['PRIMARY']['column'];
  485. if (is_array($cols)) {
  486. $cols = implode(', ', $cols);
  487. }
  488. $colList[] = 'ADD PRIMARY KEY (' . $cols . ')';
  489. }
  490. if (!empty($colList)) {
  491. $out .= "\t" . implode(",\n\t", $colList) . ";\n\n";
  492. } else {
  493. $out = '';
  494. }
  495. $out .= implode(";\n\t", $this->_alterIndexes($curTable, $indexes));
  496. }
  497. }
  498. return $out;
  499. }
  500. /**
  501. * Generate PostgreSQL index alteration statements for a table.
  502. *
  503. * @param string $table Table to alter indexes for
  504. * @param array $indexes Indexes to add and drop
  505. * @return array Index alteration statements
  506. */
  507. protected function _alterIndexes($table, $indexes) {
  508. $alter = array();
  509. if (isset($indexes['drop'])) {
  510. foreach ($indexes['drop'] as $name => $value) {
  511. $out = 'DROP ';
  512. if ($name == 'PRIMARY') {
  513. continue;
  514. } else {
  515. $out .= 'INDEX ' . $name;
  516. }
  517. $alter[] = $out;
  518. }
  519. }
  520. if (isset($indexes['add'])) {
  521. foreach ($indexes['add'] as $name => $value) {
  522. $out = 'CREATE ';
  523. if ($name == 'PRIMARY') {
  524. continue;
  525. } else {
  526. if (!empty($value['unique'])) {
  527. $out .= 'UNIQUE ';
  528. }
  529. $out .= 'INDEX ';
  530. }
  531. if (is_array($value['column'])) {
  532. $out .= $name . ' ON ' . $table . ' (' . implode(', ', array_map(array(&$this, 'name'), $value['column'])) . ')';
  533. } else {
  534. $out .= $name . ' ON ' . $table . ' (' . $this->name($value['column']) . ')';
  535. }
  536. $alter[] = $out;
  537. }
  538. }
  539. return $alter;
  540. }
  541. /**
  542. * Returns a limit statement in the correct format for the particular database.
  543. *
  544. * @param integer $limit Limit of results returned
  545. * @param integer $offset Offset from which to start results
  546. * @return string SQL limit/offset statement
  547. */
  548. public function limit($limit, $offset = null) {
  549. if ($limit) {
  550. $rt = '';
  551. if (!strpos(strtolower($limit), 'limit') || strpos(strtolower($limit), 'limit') === 0) {
  552. $rt = ' LIMIT';
  553. }
  554. $rt .= ' ' . $limit;
  555. if ($offset) {
  556. $rt .= ' OFFSET ' . $offset;
  557. }
  558. return $rt;
  559. }
  560. return null;
  561. }
  562. /**
  563. * Converts database-layer column types to basic types
  564. *
  565. * @param string $real Real database-layer column type (i.e. "varchar(255)")
  566. * @return string Abstract column type (i.e. "string")
  567. */
  568. public function column($real) {
  569. if (is_array($real)) {
  570. $col = $real['name'];
  571. if (isset($real['limit'])) {
  572. $col .= '(' . $real['limit'] . ')';
  573. }
  574. return $col;
  575. }
  576. $col = str_replace(')', '', $real);
  577. $limit = null;
  578. if (strpos($col, '(') !== false) {
  579. list($col, $limit) = explode('(', $col);
  580. }
  581. $floats = array(
  582. 'float', 'float4', 'float8', 'double', 'double precision', 'decimal', 'real', 'numeric'
  583. );
  584. switch (true) {
  585. case (in_array($col, array('date', 'time', 'inet', 'boolean'))):
  586. return $col;
  587. case (strpos($col, 'timestamp') !== false):
  588. return 'datetime';
  589. case (strpos($col, 'time') === 0):
  590. return 'time';
  591. case ($col == 'bigint'):
  592. return 'biginteger';
  593. case (strpos($col, 'int') !== false && $col != 'interval'):
  594. return 'integer';
  595. case (strpos($col, 'char') !== false || $col == 'uuid'):
  596. return 'string';
  597. case (strpos($col, 'text') !== false):
  598. return 'text';
  599. case (strpos($col, 'bytea') !== false):
  600. return 'binary';
  601. case (in_array($col, $floats)):
  602. return 'float';
  603. default:
  604. return 'text';
  605. }
  606. }
  607. /**
  608. * Gets the length of a database-native column description, or null if no length
  609. *
  610. * @param string $real Real database-layer column type (i.e. "varchar(255)")
  611. * @return integer An integer representing the length of the column
  612. */
  613. public function length($real) {
  614. $col = str_replace(array(')', 'unsigned'), '', $real);
  615. $limit = null;
  616. if (strpos($col, '(') !== false) {
  617. list($col, $limit) = explode('(', $col);
  618. }
  619. if ($col == 'uuid') {
  620. return 36;
  621. }
  622. if ($limit != null) {
  623. return intval($limit);
  624. }
  625. return null;
  626. }
  627. /**
  628. * resultSet method
  629. *
  630. * @param array $results
  631. * @return void
  632. */
  633. public function resultSet(&$results) {
  634. $this->map = array();
  635. $numFields = $results->columnCount();
  636. $index = 0;
  637. $j = 0;
  638. while ($j < $numFields) {
  639. $column = $results->getColumnMeta($j);
  640. if (strpos($column['name'], '__')) {
  641. list($table, $name) = explode('__', $column['name']);
  642. $this->map[$index++] = array($table, $name, $column['native_type']);
  643. } else {
  644. $this->map[$index++] = array(0, $column['name'], $column['native_type']);
  645. }
  646. $j++;
  647. }
  648. }
  649. /**
  650. * Fetches the next row from the current result set
  651. *
  652. * @return array
  653. */
  654. public function fetchResult() {
  655. if ($row = $this->_result->fetch(PDO::FETCH_NUM)) {
  656. $resultRow = array();
  657. foreach ($this->map as $index => $meta) {
  658. list($table, $column, $type) = $meta;
  659. switch ($type) {
  660. case 'bool':
  661. $resultRow[$table][$column] = is_null($row[$index]) ? null : $this->boolean($row[$index]);
  662. break;
  663. case 'binary':
  664. case 'bytea':
  665. $resultRow[$table][$column] = is_null($row[$index]) ? null : stream_get_contents($row[$index]);
  666. break;
  667. default:
  668. $resultRow[$table][$column] = $row[$index];
  669. break;
  670. }
  671. }
  672. return $resultRow;
  673. } else {
  674. $this->_result->closeCursor();
  675. return false;
  676. }
  677. }
  678. /**
  679. * Translates between PHP boolean values and PostgreSQL boolean values
  680. *
  681. * @param mixed $data Value to be translated
  682. * @param boolean $quote true to quote a boolean to be used in a query, false to return the boolean value
  683. * @return boolean Converted boolean value
  684. */
  685. public function boolean($data, $quote = false) {
  686. switch (true) {
  687. case ($data === true || $data === false):
  688. $result = $data;
  689. break;
  690. case ($data === 't' || $data === 'f'):
  691. $result = ($data === 't');
  692. break;
  693. case ($data === 'true' || $data === 'false'):
  694. $result = ($data === 'true');
  695. break;
  696. case ($data === 'TRUE' || $data === 'FALSE'):
  697. $result = ($data === 'TRUE');
  698. break;
  699. default:
  700. $result = (bool)$data;
  701. break;
  702. }
  703. if ($quote) {
  704. return ($result) ? 'TRUE' : 'FALSE';
  705. }
  706. return (bool)$result;
  707. }
  708. /**
  709. * Sets the database encoding
  710. *
  711. * @param mixed $enc Database encoding
  712. * @return boolean True on success, false on failure
  713. */
  714. public function setEncoding($enc) {
  715. return $this->_execute('SET NAMES ' . $this->value($enc)) !== false;
  716. }
  717. /**
  718. * Gets the database encoding
  719. *
  720. * @return string The database encoding
  721. */
  722. public function getEncoding() {
  723. $result = $this->_execute('SHOW client_encoding')->fetch();
  724. if ($result === false) {
  725. return false;
  726. }
  727. return (isset($result['client_encoding'])) ? $result['client_encoding'] : false;
  728. }
  729. /**
  730. * Generate a Postgres-native column schema string
  731. *
  732. * @param array $column An array structured like the following:
  733. * array('name'=>'value', 'type'=>'value'[, options]),
  734. * where options can be 'default', 'length', or 'key'.
  735. * @return string
  736. */
  737. public function buildColumn($column) {
  738. $col = $this->columns[$column['type']];
  739. if (!isset($col['length']) && !isset($col['limit'])) {
  740. unset($column['length']);
  741. }
  742. $out = parent::buildColumn($column);
  743. $out = preg_replace(
  744. '/integer\([0-9]+\)/',
  745. 'integer',
  746. $out
  747. );
  748. $out = preg_replace(
  749. '/bigint\([0-9]+\)/',
  750. 'bigint',
  751. $out
  752. );
  753. $out = str_replace('integer serial', 'serial', $out);
  754. if (strpos($out, 'timestamp DEFAULT')) {
  755. if (isset($column['null']) && $column['null']) {
  756. $out = str_replace('DEFAULT NULL', '', $out);
  757. } else {
  758. $out = str_replace('DEFAULT NOT NULL', '', $out);
  759. }
  760. }
  761. if (strpos($out, 'DEFAULT DEFAULT')) {
  762. if (isset($column['null']) && $column['null']) {
  763. $out = str_replace('DEFAULT DEFAULT', 'DEFAULT NULL', $out);
  764. } elseif (in_array($column['type'], array('integer', 'float'))) {
  765. $out = str_replace('DEFAULT DEFAULT', 'DEFAULT 0', $out);
  766. } elseif ($column['type'] == 'boolean') {
  767. $out = str_replace('DEFAULT DEFAULT', 'DEFAULT FALSE', $out);
  768. }
  769. }
  770. return $out;
  771. }
  772. /**
  773. * Format indexes for create table
  774. *
  775. * @param array $indexes
  776. * @param string $table
  777. * @return string
  778. */
  779. public function buildIndex($indexes, $table = null) {
  780. $join = array();
  781. if (!is_array($indexes)) {
  782. return array();
  783. }
  784. foreach ($indexes as $name => $value) {
  785. if ($name == 'PRIMARY') {
  786. $out = 'PRIMARY KEY (' . $this->name($value['column']) . ')';
  787. } else {
  788. $out = 'CREATE ';
  789. if (!empty($value['unique'])) {
  790. $out .= 'UNIQUE ';
  791. }
  792. if (is_array($value['column'])) {
  793. $value['column'] = implode(', ', array_map(array(&$this, 'name'), $value['column']));
  794. } else {
  795. $value['column'] = $this->name($value['column']);
  796. }
  797. $out .= "INDEX {$name} ON {$table}({$value['column']});";
  798. }
  799. $join[] = $out;
  800. }
  801. return $join;
  802. }
  803. /**
  804. * Overrides DboSource::renderStatement to handle schema generation with Postgres-style indexes
  805. *
  806. * @param string $type
  807. * @param array $data
  808. * @return string
  809. */
  810. public function renderStatement($type, $data) {
  811. switch (strtolower($type)) {
  812. case 'schema':
  813. extract($data);
  814. foreach ($indexes as $i => $index) {
  815. if (preg_match('/PRIMARY KEY/', $index)) {
  816. unset($indexes[$i]);
  817. $columns[] = $index;
  818. break;
  819. }
  820. }
  821. $join = array('columns' => ",\n\t", 'indexes' => "\n");
  822. foreach (array('columns', 'indexes') as $var) {
  823. if (is_array(${$var})) {
  824. ${$var} = implode($join[$var], array_filter(${$var}));
  825. }
  826. }
  827. return "CREATE TABLE {$table} (\n\t{$columns}\n);\n{$indexes}";
  828. default:
  829. return parent::renderStatement($type, $data);
  830. }
  831. }
  832. /**
  833. * Gets the schema name
  834. *
  835. * @return string The schema name
  836. */
  837. public function getSchemaName() {
  838. return $this->config['schema'];
  839. }
  840. /**
  841. * Check if the server support nested transactions
  842. *
  843. * @return boolean
  844. */
  845. public function nestedTransactionSupported() {
  846. return $this->useNestedTransactions && version_compare($this->getVersion(), '8.0', '>=');
  847. }
  848. }