Postgresql indexes

CHANGELOG.md

@@ -2,6 +2,58 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 2.9.2 - TBD
+
+### Added
+
+- Nothing.
+
+### Changed
+
+- Nothing.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
+## 2.9.1 - 2017-12-07
+
+### Added
+
+- Nothing.
+
+### Changed
+
+- [#289](https://github.com/zendframework/zend-db/pull/289) reverts a change
+  introduced in 2.9.0 and modifies the behavior of the PDO adapter slightly
+  to remove a regression. In 2.9.0, when binding parameters with names that
+  contained characters not supported by PDO, we would pass the parameter names
+  to `md5()`; this caused a regression, as the SQL string containing the
+  parameter name was not also updated.
+
+  This patch modifies the behavior during a bind-operation to instead raise an
+  exception if a parameter name contains characters not supported by PDO.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
 ## 2.9.0 - 2017-12-06
 
 ### Added

src/Adapter/Driver/Pdo/Pdo.php

@@ -304,8 +304,16 @@ public function getPrepareType()
     public function formatParameterName($name, $type = null)
     {
         if ($type === null && ! is_numeric($name) || $type == self::PARAMETERIZATION_NAMED) {
-            // using MD5 because of the PDO restriction [A-Za-z0-9_] for bindParam name
-            return ':' . md5($name);
+            // @see https://bugs.php.net/bug.php?id=43130
+            if (preg_match('/[^a-zA-Z0-9_]/', $name)) {
+                throw new Exception\RuntimeException(sprintf(
+                    'The PDO param %s contains invalid characters.'
+                    . ' Only alphabetic characters, digits, and underscores (_)'
+                    . ' are allowed.',
+                    $name
+                ));
+            }
+            return ':' . $name;
         }
 
         return '?';

src/Sql/Ddl/Index/Index.php

@@ -26,7 +26,7 @@ class Index extends AbstractIndex
      * @param  null|string $name
      * @param array $lengths
      */
-    public function __construct($columns, $name = null, array $lengths = [])
+    public function __construct($columns = null, $name = null, array $lengths = [])
     {
         $this->setColumns($columns);
 

src/Sql/Platform/Platform.php

@@ -32,17 +32,19 @@ public function __construct(AdapterInterface $adapter)
     {
         $this->defaultPlatform = $adapter->getPlatform();
 
-        $mySqlPlatform     = new Mysql\Mysql();
-        $sqlServerPlatform = new SqlServer\SqlServer();
-        $oraclePlatform    = new Oracle\Oracle();
-        $ibmDb2Platform    = new IbmDb2\IbmDb2();
-        $sqlitePlatform    = new Sqlite\Sqlite();
-
-        $this->decorators['mysql']     = $mySqlPlatform->getDecorators();
-        $this->decorators['sqlserver'] = $sqlServerPlatform->getDecorators();
-        $this->decorators['oracle']    = $oraclePlatform->getDecorators();
-        $this->decorators['ibmdb2']    = $ibmDb2Platform->getDecorators();
-        $this->decorators['sqlite']    = $sqlitePlatform->getDecorators();
+        $mySqlPlatform      = new Mysql\Mysql();
+        $sqlServerPlatform  = new SqlServer\SqlServer();
+        $oraclePlatform     = new Oracle\Oracle();
+        $ibmDb2Platform     = new IbmDb2\IbmDb2();
+        $sqlitePlatform     = new Sqlite\Sqlite();
+        $postgresqlPlatform = new Postgresql\Postgresql();
+
+        $this->decorators['mysql']      = $mySqlPlatform->getDecorators();
+        $this->decorators['sqlserver']  = $sqlServerPlatform->getDecorators();
+        $this->decorators['oracle']     = $oraclePlatform->getDecorators();
+        $this->decorators['ibmdb2']     = $ibmDb2Platform->getDecorators();
+        $this->decorators['sqlite']     = $sqlitePlatform->getDecorators();
+        $this->decorators['postgresql'] = $postgresqlPlatform->getDecorators();
     }
 
     /**

src/Sql/Platform/Postgresql/Ddl/AlterTableDecorator.php

@@ -0,0 +1,195 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Db\Sql\Platform\Postgresql\Ddl;
+
+use Zend\Db\Adapter\Driver\DriverInterface;
+use Zend\Db\Adapter\ParameterContainer;
+use Zend\Db\Adapter\Platform\PlatformInterface;
+use Zend\Db\Sql\Ddl\AlterTable;
+use Zend\Db\Sql\Ddl\Index\Index;
+use Zend\Db\Sql\Platform\PlatformDecoratorInterface;
+use Zend\Db\Sql\Platform\Postgresql\Ddl\Index\IndexDecorator;
+
+class AlterTableDecorator extends AlterTable implements PlatformDecoratorInterface
+{
+    const ADD_INDEXES = 'addIndexes';
+    const DROP_INDEXES = 'dropIndexes';
+
+    /**
+     * @var AlterTable
+     */
+    protected $subject;
+
+    /**
+     * @var IndexDecorator[]
+     */
+    protected $addIndexes = [];
+
+    /**
+     * @var string[]
+     */
+    protected $dropIndexes = [];
+
+    /**
+     * @var bool
+     */
+    private $hasCreateTable = true;
+
+    /**
+     * Compensate for dropConstraint() interface not distinguishing between string and index object.
+     * Add IF EXISTS for safety to handle either until/if new signature is approved.
+     *
+     * @var array
+     */
+    protected $dropConstraintSpecification = [
+        "%1\$s" => [
+            [1 => "DROP CONSTRAINT IF EXISTS %1\$s,\n", 'combinedby' => ""],
+        ]
+    ];
+
+    protected $indexSpecification = [
+        'statementEnd' => '%1$s',
+        self::ADD_INDEXES => [
+            "%1\$s" => [
+                [1 => '%1$s;', 'combinedby' => "\n"]
+            ]
+        ],
+        self::DROP_INDEXES => [
+            "%1\$s" => [
+                [1 => 'DROP INDEX IF EXISTS %1$s;', 'combinedby' => "\n"]
+            ]
+        ]
+    ];
+
+    /**
+     * @inheritDoc
+     */
+    public function setSubject($subject)
+    {
+        $this->subject = $subject;
+
+        $this->specifications[self::DROP_CONSTRAINTS] = $this->dropConstraintSpecification;
+        $this->subject->specifications = $this->specifications;
+
+        return $this;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function buildSqlString(
+        PlatformInterface $platform,
+        DriverInterface $driver = null,
+        ParameterContainer $parameterContainer = null
+    ) {
+        $this->separateIndexesFromConstraints();
+        $this->duplicateDropConstraintToDropIndex();
+        $this->deleteUnneededSpecification();
+
+        // unlike CreateTableDecorator where CREATE TABLE is always present for new tables, regardless of Incex creation
+        // PostgreSQL does not use ALTER TABLE to add/drop indexes to existing tables.
+        // Therefore, if the only change is index related, DDL would have dangling ALTER TABLE.
+        // Consequently, table alterations outside of ALTER TABLE syntax get processed as whole different specification chunk
+        $alterTable = '';
+        if ($this->hasCreateTable) {
+            $alterTable = parent::buildSqlString($platform, $driver, $parameterContainer);
+            $this->subject->specifications = $this->specifications = $this->indexSpecification;
+        }
+
+        $indexes = parent::buildSqlString($platform, $driver, $parameterContainer);
+        return $alterTable.$indexes;
+    }
+
+    private function separateIndexesFromConstraints()
+    {
+        // take advantage of PHP's ability to access protected properties of different instances created from same class
+        $this->addIndexes = array_filter($this->subject->addConstraints, function ($constraint) {
+            return $constraint instanceof Index;
+        });
+
+        $filteredConstraints = array_filter($this->subject->addConstraints, function ($constraint) {
+            return !($constraint instanceof Index);
+        });
+
+        $this->subject->addConstraints = $filteredConstraints;
+
+        array_walk($this->addIndexes, function (&$index, $key) {
+            $indexDecorator = new IndexDecorator();
+            $indexDecorator->setSubject($index);
+            $indexDecorator->setTable($this->subject->table);
+            $index = $indexDecorator;
+        });
+    }
+
+    /**
+     * DROP CONSTRAINT always with DROP INDEX to compensate for dropConstraint() interface
+     * only accepting strings, not inspectable objects.
+     * @TODO if new signature removeConstraint(string|AbstractConstraint) gets approved, delete this method
+     */
+    private function duplicateDropConstraintToDropIndex()
+    {
+        $this->dropIndexes = $this->subject->dropConstraints;
+    }
+
+    /**
+     * @param PlatformInterface|null $adapterPlatform
+     * @return array|void
+     */
+    protected function processAddIndexes(PlatformInterface $adapterPlatform = null)
+    {
+        if (!$this->addIndexes) {
+            return;
+        }
+
+        $sqls = [];
+
+        foreach ($this->addIndexes as $index) {
+            $sqls[] = $this->processExpression($index, $adapterPlatform);
+        }
+
+        return [$sqls];
+    }
+
+    protected function processDropIndexes(PlatformInterface $adapterPlatform = null)
+    {
+        if (!$this->dropIndexes) {
+            return;
+        }
+
+        $sqls = [];
+
+        foreach ($this->dropIndexes as $index) {
+            $sqls[] = $adapterPlatform->quoteIdentifier($index);
+        }
+
+        return [$sqls];
+    }
+
+    /**
+     * @param PlatformInterface|null $adapterPlatform
+     * @return array|void
+     */
+    protected function processStatementEnd(PlatformInterface $adapterPlatform = null)
+    {
+        return [";\n"];
+    }
+
+    private function deleteUnneededSpecification()
+    {
+        $subject = $this->subject;
+        if (!($subject->addColumns || $subject->changeColumns || $subject->dropColumns
+            || $subject->addConstraints || $subject->dropConstraints)) {
+            $this->hasCreateTable = false;
+
+            unset($this->indexSpecification['statementEnd']);
+            $this->subject->specifications = $this->specifications = $this->indexSpecification;
+        }
+    }
+}