Postgres.php 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890
  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-2011, 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-2011, 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. * Long description for class
  24. *
  25. * @package Cake.Model.Datasource.Database
  26. */
  27. class Postgres extends DboSource {
  28. /**
  29. * Driver description
  30. *
  31. * @var string
  32. */
  33. public $description = "PostgreSQL DBO Driver";
  34. /**
  35. * Index of basic SQL commands
  36. *
  37. * @var array
  38. */
  39. protected $_commands = array(
  40. 'begin' => 'BEGIN',
  41. 'commit' => 'COMMIT',
  42. 'rollback' => 'ROLLBACK'
  43. );
  44. /**
  45. * Base driver configuration settings. Merged with user settings.
  46. *
  47. * @var array
  48. */
  49. protected $_baseConfig = array(
  50. 'persistent' => true,
  51. 'host' => 'localhost',
  52. 'login' => 'root',
  53. 'password' => '',
  54. 'database' => 'cake',
  55. 'schema' => 'public',
  56. 'port' => 5432,
  57. 'encoding' => ''
  58. );
  59. /**
  60. * Columns
  61. *
  62. * @var array
  63. */
  64. public $columns = array(
  65. 'primary_key' => array('name' => 'serial NOT NULL'),
  66. 'string' => array('name' => 'varchar', 'limit' => '255'),
  67. 'text' => array('name' => 'text'),
  68. 'integer' => array('name' => 'integer', 'formatter' => 'intval'),
  69. 'float' => array('name' => 'float', 'formatter' => 'floatval'),
  70. 'datetime' => array('name' => 'timestamp', 'format' => 'Y-m-d H:i:s', 'formatter' => 'date'),
  71. 'timestamp' => array('name' => 'timestamp', 'format' => 'Y-m-d H:i:s', 'formatter' => 'date'),
  72. 'time' => array('name' => 'time', 'format' => 'H:i:s', 'formatter' => 'date'),
  73. 'date' => array('name' => 'date', 'format' => 'Y-m-d', 'formatter' => 'date'),
  74. 'binary' => array('name' => 'bytea'),
  75. 'boolean' => array('name' => 'boolean'),
  76. 'number' => array('name' => 'numeric'),
  77. 'inet' => array('name' => 'inet')
  78. );
  79. /**
  80. * Starting Quote
  81. *
  82. * @var string
  83. */
  84. public $startQuote = '"';
  85. /**
  86. * Ending Quote
  87. *
  88. * @var string
  89. */
  90. public $endQuote = '"';
  91. /**
  92. * Contains mappings of custom auto-increment sequences, if a table uses a sequence name
  93. * other than what is dictated by convention.
  94. *
  95. * @var array
  96. */
  97. protected $_sequenceMap = array();
  98. /**
  99. * Connects to the database using options in the given configuration array.
  100. *
  101. * @return boolean True if successfully connected.
  102. * @throws MissingConnectionException
  103. */
  104. public function connect() {
  105. $config = $this->config;
  106. $this->connected = false;
  107. try {
  108. $flags = array(
  109. PDO::ATTR_PERSISTENT => $config['persistent'],
  110. PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION
  111. );
  112. $this->_connection = new PDO(
  113. "pgsql:host={$config['host']};port={$config['port']};dbname={$config['database']}",
  114. $config['login'],
  115. $config['password'],
  116. $flags
  117. );
  118. $this->connected = true;
  119. if (!empty($config['encoding'])) {
  120. $this->setEncoding($config['encoding']);
  121. }
  122. if (!empty($config['schema'])) {
  123. $this->_execute('SET search_path TO ' . $config['schema']);
  124. }
  125. } catch (PDOException $e) {
  126. throw new MissingConnectionException(array('class' => $e->getMessage()));
  127. }
  128. return $this->connected;
  129. }
  130. /**
  131. * Check if PostgreSQL is enabled/loaded
  132. *
  133. * @return boolean
  134. */
  135. public function enabled() {
  136. return in_array('pgsql', PDO::getAvailableDrivers());
  137. }
  138. /**
  139. * Returns an array of tables in the database. If there are no tables, an error is raised and the application exits.
  140. *
  141. * @param mixed $data
  142. * @return array Array of tablenames in the database
  143. */
  144. public function listSources($data = null) {
  145. $cache = parent::listSources();
  146. if ($cache != null) {
  147. return $cache;
  148. }
  149. $schema = $this->config['schema'];
  150. $sql = "SELECT table_name as name FROM INFORMATION_SCHEMA.tables WHERE table_schema = ?";
  151. $result = $this->_execute($sql, array($schema));
  152. if (!$result) {
  153. return array();
  154. } else {
  155. $tables = array();
  156. foreach ($result as $item) {
  157. $tables[] = $item->name;
  158. }
  159. $result->closeCursor();
  160. parent::listSources($tables);
  161. return $tables;
  162. }
  163. }
  164. /**
  165. * Returns an array of the fields in given table name.
  166. *
  167. * @param Model|string $model Name of database table to inspect
  168. * @return array Fields in table. Keys are name and type
  169. */
  170. public function describe($model) {
  171. $fields = parent::describe($model);
  172. $table = $this->fullTableName($model, false);
  173. $this->_sequenceMap[$table] = array();
  174. $cols = null;
  175. if ($fields === null) {
  176. $cols = $this->_execute(
  177. "SELECT DISTINCT column_name AS name, data_type AS type, is_nullable AS null,
  178. column_default AS default, ordinal_position AS position, character_maximum_length AS char_length,
  179. character_octet_length AS oct_length FROM information_schema.columns
  180. WHERE table_name = ? AND table_schema = ? ORDER BY position",
  181. array($table, $this->config['schema'])
  182. );
  183. foreach ($cols as $c) {
  184. $type = $c->type;
  185. if (!empty($c->oct_length) && $c->char_length === null) {
  186. if ($c->type == 'character varying') {
  187. $length = null;
  188. $type = 'text';
  189. } else {
  190. $length = intval($c->oct_length);
  191. }
  192. } elseif (!empty($c->char_length)) {
  193. $length = intval($c->char_length);
  194. } else {
  195. $length = $this->length($c->type);
  196. }
  197. if (empty($length)) {
  198. $length = null;
  199. }
  200. $fields[$c->name] = array(
  201. 'type' => $this->column($type),
  202. 'null' => ($c->null == 'NO' ? false : true),
  203. 'default' => preg_replace(
  204. "/^'(.*)'$/",
  205. "$1",
  206. preg_replace('/::.*/', '', $c->default)
  207. ),
  208. 'length' => $length
  209. );
  210. if ($model instanceof Model) {
  211. if ($c->name == $model->primaryKey) {
  212. $fields[$c->name]['key'] = 'primary';
  213. if ($fields[$c->name]['type'] !== 'string') {
  214. $fields[$c->name]['length'] = 11;
  215. }
  216. }
  217. }
  218. if (
  219. $fields[$c->name]['default'] == 'NULL' ||
  220. preg_match('/nextval\([\'"]?([\w.]+)/', $c->default, $seq)
  221. ) {
  222. $fields[$c->name]['default'] = null;
  223. if (!empty($seq) && isset($seq[1])) {
  224. $this->_sequenceMap[$table][$c->default] = $seq[1];
  225. }
  226. }
  227. if ($fields[$c->name]['type'] == 'boolean' && !empty($fields[$c->name]['default'])) {
  228. $fields[$c->name]['default'] = constant($fields[$c->name]['default']);
  229. }
  230. }
  231. $this->_cacheDescription($table, $fields);
  232. }
  233. if (isset($model->sequence)) {
  234. $this->_sequenceMap[$table][$model->primaryKey] = $model->sequence;
  235. }
  236. if ($cols) {
  237. $cols->closeCursor();
  238. }
  239. return $fields;
  240. }
  241. /**
  242. * Returns the ID generated from the previous INSERT operation.
  243. *
  244. * @param string $source Name of the database table
  245. * @param string $field Name of the ID database field. Defaults to "id"
  246. * @return integer
  247. */
  248. public function lastInsertId($source = null, $field = 'id') {
  249. $seq = $this->getSequence($source, $field);
  250. return $this->_connection->lastInsertId($seq);
  251. }
  252. /**
  253. * Gets the associated sequence for the given table/field
  254. *
  255. * @param mixed $table Either a full table name (with prefix) as a string, or a model object
  256. * @param string $field Name of the ID database field. Defaults to "id"
  257. * @return string The associated sequence name from the sequence map, defaults to "{$table}_{$field}_seq"
  258. */
  259. public function getSequence($table, $field = 'id') {
  260. if (is_object($table)) {
  261. $table = $this->fullTableName($table, false);
  262. }
  263. if (isset($this->_sequenceMap[$table]) && isset($this->_sequenceMap[$table][$field])) {
  264. return $this->_sequenceMap[$table][$field];
  265. } else {
  266. return "{$table}_{$field}_seq";
  267. }
  268. }
  269. /**
  270. * Deletes all the records in a table and drops all associated auto-increment sequences
  271. *
  272. * @param mixed $table A string or model class representing the table to be truncated
  273. * @param boolean $reset true for resseting the sequence, false to leave it as is.
  274. * and if 1, sequences are not modified
  275. * @return boolean SQL TRUNCATE TABLE statement, false if not applicable.
  276. */
  277. public function truncate($table, $reset = 0) {
  278. $table = $this->fullTableName($table, false);
  279. if (!isset($this->_sequenceMap[$table])) {
  280. $cache = $this->cacheSources;
  281. $this->cacheSources = false;
  282. $this->describe($table);
  283. $this->cacheSources = $cache;
  284. }
  285. if ($this->execute('DELETE FROM ' . $this->fullTableName($table))) {
  286. $table = $this->fullTableName($table, false);
  287. if (isset($this->_sequenceMap[$table]) && $reset !== 1) {
  288. foreach ($this->_sequenceMap[$table] as $field => $sequence) {
  289. $this->_execute("ALTER SEQUENCE \"{$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 tablename
  313. * @param mixed $fields
  314. * @param boolean $quote
  315. * @return array
  316. */
  317. public function fields($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 strig
  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 (!Set::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);
  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. $col = array();
  412. preg_match('/\(([^\)]+)\)/', $key['statement'], $indexColumns);
  413. $parsedColumn = $indexColumns[1];
  414. if (strpos($indexColumns[1], ',') !== false) {
  415. $parsedColumn = explode(', ', $indexColumns[1]);
  416. }
  417. $index[$key['relname']]['unique'] = $key['indisunique'];
  418. $index[$key['relname']]['column'] = $parsedColumn;
  419. }
  420. }
  421. return $index;
  422. }
  423. /**
  424. * Alter the Schema of a table.
  425. *
  426. * @param array $compare Results of CakeSchema::compare()
  427. * @param string $table name of the table
  428. * @return array
  429. */
  430. public function alterSchema($compare, $table = null) {
  431. if (!is_array($compare)) {
  432. return false;
  433. }
  434. $out = '';
  435. $colList = array();
  436. foreach ($compare as $curTable => $types) {
  437. $indexes = $colList = array();
  438. if (!$table || $table == $curTable) {
  439. $out .= 'ALTER TABLE ' . $this->fullTableName($curTable) . " \n";
  440. foreach ($types as $type => $column) {
  441. if (isset($column['indexes'])) {
  442. $indexes[$type] = $column['indexes'];
  443. unset($column['indexes']);
  444. }
  445. switch ($type) {
  446. case 'add':
  447. foreach ($column as $field => $col) {
  448. $col['name'] = $field;
  449. $colList[] = 'ADD COLUMN '.$this->buildColumn($col);
  450. }
  451. break;
  452. case 'drop':
  453. foreach ($column as $field => $col) {
  454. $col['name'] = $field;
  455. $colList[] = 'DROP COLUMN '.$this->name($field);
  456. }
  457. break;
  458. case 'change':
  459. foreach ($column as $field => $col) {
  460. if (!isset($col['name'])) {
  461. $col['name'] = $field;
  462. }
  463. $fieldName = $this->name($field);
  464. $default = isset($col['default']) ? $col['default'] : null;
  465. $nullable = isset($col['null']) ? $col['null'] : null;
  466. unset($col['default'], $col['null']);
  467. $colList[] = 'ALTER COLUMN '. $fieldName .' TYPE ' . str_replace(array($fieldName, 'NOT NULL'), '', $this->buildColumn($col));
  468. if (isset($nullable)) {
  469. $nullable = ($nullable) ? 'DROP NOT NULL' : 'SET NOT NULL';
  470. $colList[] = 'ALTER COLUMN '. $fieldName .' ' . $nullable;
  471. }
  472. if (isset($default)) {
  473. $colList[] = 'ALTER COLUMN '. $fieldName .' SET DEFAULT ' . $this->value($default, $col['type']);
  474. } else {
  475. $colList[] = 'ALTER COLUMN '. $fieldName .' DROP DEFAULT';
  476. }
  477. }
  478. break;
  479. }
  480. }
  481. if (isset($indexes['drop']['PRIMARY'])) {
  482. $colList[] = 'DROP CONSTRAINT ' . $curTable . '_pkey';
  483. }
  484. if (isset($indexes['add']['PRIMARY'])) {
  485. $cols = $indexes['add']['PRIMARY']['column'];
  486. if (is_array($cols)) {
  487. $cols = implode(', ', $cols);
  488. }
  489. $colList[] = 'ADD PRIMARY KEY (' . $cols . ')';
  490. }
  491. if (!empty($colList)) {
  492. $out .= "\t" . implode(",\n\t", $colList) . ";\n\n";
  493. } else {
  494. $out = '';
  495. }
  496. $out .= implode(";\n\t", $this->_alterIndexes($curTable, $indexes));
  497. }
  498. }
  499. return $out;
  500. }
  501. /**
  502. * Generate PostgreSQL index alteration statements for a table.
  503. *
  504. * @param string $table Table to alter indexes for
  505. * @param array $indexes Indexes to add and drop
  506. * @return array Index alteration statements
  507. */
  508. protected function _alterIndexes($table, $indexes) {
  509. $alter = array();
  510. if (isset($indexes['drop'])) {
  511. foreach ($indexes['drop'] as $name => $value) {
  512. $out = 'DROP ';
  513. if ($name == 'PRIMARY') {
  514. continue;
  515. } else {
  516. $out .= 'INDEX ' . $name;
  517. }
  518. $alter[] = $out;
  519. }
  520. }
  521. if (isset($indexes['add'])) {
  522. foreach ($indexes['add'] as $name => $value) {
  523. $out = 'CREATE ';
  524. if ($name == 'PRIMARY') {
  525. continue;
  526. } else {
  527. if (!empty($value['unique'])) {
  528. $out .= 'UNIQUE ';
  529. }
  530. $out .= 'INDEX ';
  531. }
  532. if (is_array($value['column'])) {
  533. $out .= $name . ' ON ' . $table . ' (' . implode(', ', array_map(array(&$this, 'name'), $value['column'])) . ')';
  534. } else {
  535. $out .= $name . ' ON ' . $table . ' (' . $this->name($value['column']) . ')';
  536. }
  537. $alter[] = $out;
  538. }
  539. }
  540. return $alter;
  541. }
  542. /**
  543. * Returns a limit statement in the correct format for the particular database.
  544. *
  545. * @param integer $limit Limit of results returned
  546. * @param integer $offset Offset from which to start results
  547. * @return string SQL limit/offset statement
  548. */
  549. public function limit($limit, $offset = null) {
  550. if ($limit) {
  551. $rt = '';
  552. if (!strpos(strtolower($limit), 'limit') || strpos(strtolower($limit), 'limit') === 0) {
  553. $rt = ' LIMIT';
  554. }
  555. $rt .= ' ' . $limit;
  556. if ($offset) {
  557. $rt .= ' OFFSET ' . $offset;
  558. }
  559. return $rt;
  560. }
  561. return null;
  562. }
  563. /**
  564. * Converts database-layer column types to basic types
  565. *
  566. * @param string $real Real database-layer column type (i.e. "varchar(255)")
  567. * @return string Abstract column type (i.e. "string")
  568. */
  569. public function column($real) {
  570. if (is_array($real)) {
  571. $col = $real['name'];
  572. if (isset($real['limit'])) {
  573. $col .= '(' . $real['limit'] . ')';
  574. }
  575. return $col;
  576. }
  577. $col = str_replace(')', '', $real);
  578. $limit = null;
  579. if (strpos($col, '(') !== false) {
  580. list($col, $limit) = explode('(', $col);
  581. }
  582. $floats = array(
  583. 'float', 'float4', 'float8', 'double', 'double precision', 'decimal', 'real', 'numeric'
  584. );
  585. switch (true) {
  586. case (in_array($col, array('date', 'time', 'inet', 'boolean'))):
  587. return $col;
  588. case (strpos($col, 'timestamp') !== false):
  589. return 'datetime';
  590. case (strpos($col, 'time') === 0):
  591. return 'time';
  592. case (strpos($col, 'int') !== false && $col != 'interval'):
  593. return 'integer';
  594. case (strpos($col, 'char') !== false || $col == 'uuid'):
  595. return 'string';
  596. case (strpos($col, 'text') !== false):
  597. return 'text';
  598. case (strpos($col, 'bytea') !== false):
  599. return 'binary';
  600. case (in_array($col, $floats)):
  601. return 'float';
  602. default:
  603. return 'text';
  604. break;
  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] = 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, flase 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 = preg_replace('/integer\([0-9]+\)/', 'integer', parent::buildColumn($column));
  743. $out = str_replace('integer serial', 'serial', $out);
  744. if (strpos($out, 'timestamp DEFAULT')) {
  745. if (isset($column['null']) && $column['null']) {
  746. $out = str_replace('DEFAULT NULL', '', $out);
  747. } else {
  748. $out = str_replace('DEFAULT NOT NULL', '', $out);
  749. }
  750. }
  751. if (strpos($out, 'DEFAULT DEFAULT')) {
  752. if (isset($column['null']) && $column['null']) {
  753. $out = str_replace('DEFAULT DEFAULT', 'DEFAULT NULL', $out);
  754. } elseif (in_array($column['type'], array('integer', 'float'))) {
  755. $out = str_replace('DEFAULT DEFAULT', 'DEFAULT 0', $out);
  756. } elseif ($column['type'] == 'boolean') {
  757. $out = str_replace('DEFAULT DEFAULT', 'DEFAULT FALSE', $out);
  758. }
  759. }
  760. return $out;
  761. }
  762. /**
  763. * Format indexes for create table
  764. *
  765. * @param array $indexes
  766. * @param string $table
  767. * @return string
  768. */
  769. public function buildIndex($indexes, $table = null) {
  770. $join = array();
  771. if (!is_array($indexes)) {
  772. return array();
  773. }
  774. foreach ($indexes as $name => $value) {
  775. if ($name == 'PRIMARY') {
  776. $out = 'PRIMARY KEY (' . $this->name($value['column']) . ')';
  777. } else {
  778. $out = 'CREATE ';
  779. if (!empty($value['unique'])) {
  780. $out .= 'UNIQUE ';
  781. }
  782. if (is_array($value['column'])) {
  783. $value['column'] = implode(', ', array_map(array(&$this, 'name'), $value['column']));
  784. } else {
  785. $value['column'] = $this->name($value['column']);
  786. }
  787. $out .= "INDEX {$name} ON {$table}({$value['column']});";
  788. }
  789. $join[] = $out;
  790. }
  791. return $join;
  792. }
  793. /**
  794. * Overrides DboSource::renderStatement to handle schema generation with Postgres-style indexes
  795. *
  796. * @param string $type
  797. * @param array $data
  798. * @return string
  799. */
  800. public function renderStatement($type, $data) {
  801. switch (strtolower($type)) {
  802. case 'schema':
  803. extract($data);
  804. foreach ($indexes as $i => $index) {
  805. if (preg_match('/PRIMARY KEY/', $index)) {
  806. unset($indexes[$i]);
  807. $columns[] = $index;
  808. break;
  809. }
  810. }
  811. $join = array('columns' => ",\n\t", 'indexes' => "\n");
  812. foreach (array('columns', 'indexes') as $var) {
  813. if (is_array(${$var})) {
  814. ${$var} = implode($join[$var], array_filter(${$var}));
  815. }
  816. }
  817. return "CREATE TABLE {$table} (\n\t{$columns}\n);\n{$indexes}";
  818. break;
  819. default:
  820. return parent::renderStatement($type, $data);
  821. break;
  822. }
  823. }
  824. }