added ability to set cat executable path and support for ccat utility

Author: FacedSID

src/Transport/ClickhouseCLIClientTransport.php

@@ -21,21 +21,39 @@ class ClickhouseCLIClientTransport implements TransportInterface
      */
     protected $executablePath;
 
+    /**
+     * Path to executable cat command
+     *
+     * @var string
+     */
+    protected $catExecutablePath;
+
     /**
      * Last execute query
      *
      * @var string
      */
     protected $lastQuery = '';
 
+    /**
+     * Use special ccat command to cat files into one without ARG_MAX limits
+     *
+     * @var bool
+     */
+    protected $useCcat;
+
     /**
      * ClickhouseCLIClientTransport constructor.
      *
      * @param string|null $executablePath
+     * @param string|null $catExecutablePath
+     * @param bool        $useCcat
      */
-    public function __construct(string $executablePath = null)
+    public function __construct(string $executablePath = null, string $catExecutablePath = null, bool $useCcat = false)
     {
         $this->setExecutablePath($executablePath);
+        $this->setCatExecutablePath($catExecutablePath);
+        $this->useCcat = $useCcat;
     }
 
     /**
@@ -52,6 +70,20 @@ protected function setExecutablePath(string $executablePath = null)
         $this->executablePath = $executablePath;
     }
 
+    /**
+     * Set path to cat executable.
+     *
+     * @param string|null $catExecutablePath
+     */
+    protected function setCatExecutablePath(string $catExecutablePath = null)
+    {
+        if (is_null($catExecutablePath)) {
+            $catExecutablePath = 'cat';
+        }
+
+        $this->catExecutablePath = $catExecutablePath;
+    }
+
     /**
      * Sends query to given $server.
      *
@@ -118,20 +150,32 @@ public function sendFilesAsOneWithQuery(Server $server, string $query, array $fi
          * We will put the list of files into tmp file and then we will use command:
          *
          * (IFS=$'\n'; cat $(< tmp-file))
-         * 
+         *
          * to iterate through file and cat each file into stdout
+         *
+         * ccat is used to ignore ARG_MAX constant when trying to push too many files
          */
-        $fileName = $this->writeTemporaryFile(implode(PHP_EOL, array_map(function(string $file) {
-            return 'cat '.$file;
-        }, $files)));
+        if ($this->useCcat) {
+            $files = implode(PHP_EOL, $files);
+        } else {
+            $files = implode(PHP_EOL, array_map(function(string $file) {
+                return 'cat '.$file;
+            }, $files));
+        }
+
+        $fileName = $this->writeTemporaryFile($files);
 
         $command = $this->buildCommandForWriteFilesAsOne($server, $query, $fileName, $settings);
 
         try {
             $this->executeCommand($command);
+
+            if (!is_null($fileName)) {
+                $this->removeTemporaryFile($fileName);
+            }
         } catch (\Throwable $e) {
             $this->removeTemporaryFile($fileName);
-            
+
             throw $e;
         }
 
@@ -243,7 +287,7 @@ protected function buildCommandForWrite(Server $server, string $query, string $f
         $command = [];
 
         if (!is_null($file)) {
-            $command[] = "$(which cat) ".$file.' |';
+            $command[] = $this->catExecutablePath.' '.$file.' |';
         }
 
         $command = array_merge($command, [
@@ -253,7 +297,7 @@ protected function buildCommandForWrite(Server $server, string $query, string $f
             "--database='{$server->getDatabase()}'",
             "--query={$query}"
         ]);
-    
+
         foreach ($settings as $key => $value) {
             $command[] = '--'.$key.'='.escapeshellarg($value);
         }
@@ -275,19 +319,26 @@ protected function buildCommandForWriteFilesAsOne(Server $server, string $query,
     {
         $query = escapeshellarg($query);
 
-        $command = [
-            '$(cat '.$file.') | ',
+        $command = [];
+
+        if ($this->useCcat) {
+            $command[] = $this->catExecutablePath.' '.$file.' | ';
+        } else {
+            $command[] = '$('.$this->catExecutablePath.' '.$file.') | ';
+        }
+
+        $command = array_merge($command, [
             $this->executablePath,
             "--host='{$server->getHost()}'",
             "--port='{$server->getPort()}'",
             "--database='{$server->getDatabase()}'",
             "--query={$query}",
-        ];
-        
+        ]);
+
         foreach ($settings as $key => $value) {
             $command[] = '--'.$key.'='.escapeshellarg($value);
         }
-        
+
         return implode(' ', $command);
     }
 
@@ -306,7 +357,7 @@ protected function buildCommandForRead(Server $server, string $query, $tables =
         $fileName = $this->writeTemporaryFile($query);
 
         $command = [
-            "cat {$fileName} |",
+            $this->catExecutablePath." {$fileName} |",
             $this->executablePath,
             "--host='{$server->getHost()}'",
             "--port='{$server->getPort()}'",
@@ -323,7 +374,7 @@ protected function buildCommandForRead(Server $server, string $query, $tables =
                 $command = array_merge($command, $this->parseTempTable($table));
             }
         }
-    
+
         foreach ($settings as $key => $value) {
             $command[] = '--'.$key.'='.escapeshellarg($value);
         }