add function renameTable

Author: ierusalim

README.md

@@ -39,6 +39,7 @@ contains functions for simple operations with ClickHouse.
 * **sendFileInsert**($file, $table) - send TabSeparated-file into table (structure autodetect)
 * **clearTable**($table [, $sess]) - clear table (DROP and re-create)
 * **dropTable**($table [, $sess]) - drop specified table
+* **renameTable**($from_name_or_arr [, $to_name] [, $sess]) - rename tables
 * **getTableFields**($table, ...) - returns [field_name=>field_type] array
 * **getTableInfo**($table [, $extended]) - returns array with info about table
 * **getTablesList**([$db] [,$pattern]) - returns tables list by SHOW TABLES request

src/ClickHouseFunctions.php

@@ -10,6 +10,7 @@
  * - >sendFileInsert($file, $table) - send TabSeparated-file into table
  * - >dropTable($table [, $sess]) - drop table
  * - >clearTable($table [, $sess]) - clear table (DROP and re-create)
+ * - >renameTable($from_name_or_arr [, $to_name] [, $sess]) - rename tables
  * - >getTableFields($table [, $sess]) - returns [field_name=>field_type] array
  * - >getTableInfo($table [, $extended]) - returns array with info about table
  *
@@ -442,13 +443,15 @@ public function getDatabasesList()
      *
      * @param string|null $name Database name
      * @param string|null $like_pattern pattern for search table, example: d%
+     * @param string|null $sess session_id
      * @return array|string Results in array or string with error description
      */
-    public function getTablesList($name = null, $like_pattern = null)
+    public function getTablesList($name = null, $like_pattern = null, $sess = null)
     {
         return $this->queryStrings('SHOW TABLES ' .
                     (empty($name) ? '' : $this->from . $name) .
-                    (empty($like_pattern) ? '' : " LIKE '$like_pattern'"));
+                    (empty($like_pattern) ? '' : " LIKE '$like_pattern'"),
+                    false, $sess);
     }
 
     /**
@@ -637,6 +640,38 @@ public function clearTable($table, $sess = null)
         return $this->queryFalse($create_request, [], $sess);
     }
 
+    /**
+     * Rename one table(from_name, to_name) or array of tables
+     *
+     * To rename many tables with one query, need to set an array, example:
+     * - >renameTable(['from_name1' => 'to_name1', 'from_name2' => 'to_name2'])
+     *
+     * @param string|array $from_name_or_arr Old name or array [oldname=>newname,...]
+     * @param string|null $to_name New name, or ignored if first parameter is array
+     * @param string|null $sess session_id
+     * @return boolean|string Return false if ok, or string with error description
+     */
+    public function renameTable($from_name_or_arr, $to_name = null, $sess = null)
+    {
+        if (!\is_array($from_name_or_arr)) {
+            if (empty($to_name)) {
+                return "table name not specified";
+            } else {
+                $from_name_or_arr = [$from_name_or_arr => $to_name];
+            }
+        }
+        $sql = '';
+        foreach ($from_name_or_arr as $from_name => $to_name) {
+            if (empty($sql)) {
+                $sql = "RENAME TABLE ";
+            } else {
+                $sql .=", ";
+            }
+            $sql .= "`$from_name` TO `$to_name`";
+        }
+        return $this->queryFalse($sql, [], $sess);
+    }
+
     /**
      * Send file to ClickHouse-server and insert into table
      *

src/ClickHouseQuery.php

@@ -202,14 +202,12 @@ public function queryValue($sql, $post_data = null, $sess = null)
 
     /**
      * Return strings array (using TabSeparated-formats for data transfer)
-     *
-     * If results have more of one column, strings need be explode by tab
-     *
-     * If $with_names_types is true, first 2 strings of results in array
-     *  contain names and types of returned columns.
+     * - If results have more of one column, strings need be explode by tab
+     * - If $with_names_types is true, first 2 strings of results
+     *   contains names and types of returned columns.
      *
      * Nuances:
-     * - Returned data not unescaped!
+     * - Returned data not unescaped
      * - If have option 'extreme' or 'WITH TOTALS' requires filtering extra lines
      *
      * @param string      $sql SQL-request

tests/src/ClickHouseFunctionsTest.php

@@ -352,6 +352,62 @@ public function testDropTable()
         $this->assertFalse($arr);
     }
 
+    /**
+     * @covers ierusalim\ClickHouse\ClickHouseFunctions::renameTable
+     */
+    public function testRenameTable()
+    {
+        $ch = $this->object;
+
+        $prefix = 'tempren';
+        $postfix = 'xxx';
+
+        $table_from = $prefix . 'from';
+        $table_next = $prefix . 'next';
+        $table_to = $prefix . 'to';
+
+        $ans = $ch->createTableQuick($table_from, [
+            'id' => 'Int16',
+            'dt' => ['Date', 'now()']
+        ], 2);
+        $this->assertFalse($ans);
+
+        $ans = $ch->renameTable($table_from, $table_to);
+
+        $arr = $ch->getTablesList(null, $table_to);
+        $this->assertEquals($table_to, $arr[0]);
+
+        $ans = $ch->createTableQuick($table_next, [
+            'id' => 'Int16',
+            'dt' => ['Date', 'now()']
+        ], 2);
+        $this->assertFalse($ans);
+
+        $arr = $ch->getTablesList(null, $prefix .'%');
+
+        $ren_arr = [];
+        foreach ($arr as $table) {
+            if (substr($table, -strlen($postfix)) != $postfix) {
+                $ren_arr[$table] = $table . $postfix;
+            }
+        }
+        $ans = $ch->renameTable($ren_arr);
+
+        $arr = $ch->getTablesList(null, $prefix . '%');
+        $drop_count = 0;
+        foreach ($arr as $drop_table) {
+            if (\substr($table, -\strlen($postfix)) != $postfix) {
+                $this->assertFalse($ch->dropTable($drop_table));
+                $drop_count++;
+            }
+        }
+        $this->assertGreaterThan(1, $drop_count);
+        $this->assertEquals(\count($arr), $drop_count);
+
+        // test bad param
+        $this->assertTrue(\is_string($ch->renameTable($table_from)));
+    }
+
     /**
      * @covers ierusalim\ClickHouse\ClickHouseFunctions::clearTable
      */