<?php /** * This file is part of the CodeIgniter 4 framework. * * (c) CodeIgniter Foundation <admin@codeigniter.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace CodeIgniter\Database\Postgre; use CodeIgniter\Database\BaseBuilder; use CodeIgniter\Database\Exceptions\DatabaseException; /** * Builder for Postgre */ class Builder extends BaseBuilder { /** * ORDER BY random keyword * * @var array */ protected $randomKeyword = [ 'RANDOM()', ]; /** * Specifies which sql statements * support the ignore option. * * @var array */ protected $supportedIgnoreStatements = [ 'insert' => 'ON CONFLICT DO NOTHING', ]; //-------------------------------------------------------------------- /** * Compile Ignore Statement * * Checks if the ignore option is supported by * the Database Driver for the specific statement. * * @param string $statement * * @return string */ protected function compileIgnore(string $statement) { $sql = parent::compileIgnore($statement); if (! empty($sql)) { $sql = ' ' . trim($sql); } return $sql; } //-------------------------------------------------------------------- /** * ORDER BY * * @param string $orderBy * @param string $direction ASC, DESC or RANDOM * @param boolean $escape * * @return BaseBuilder */ public function orderBy(string $orderBy, string $direction = '', bool $escape = null) { $direction = strtoupper(trim($direction)); if ($direction === 'RANDOM') { if (ctype_digit($orderBy)) { $orderBy = (float) ($orderBy > 1 ? "0.{$orderBy}" : $orderBy); } if (is_float($orderBy)) { $this->db->simpleQuery("SET SEED {$orderBy}"); } $orderBy = $this->randomKeyword[0]; $direction = ''; $escape = false; } return parent::orderBy($orderBy, $direction, $escape); } //-------------------------------------------------------------------- /** * Increments a numeric column by the specified value. * * @param string $column * @param integer $value * * @throws DatabaseException * * @return mixed */ public function increment(string $column, int $value = 1) { $column = $this->db->protectIdentifiers($column); $sql = $this->_update($this->QBFrom[0], [$column => "to_number({$column}, '9999999') + {$value}"]); return $this->db->query($sql, $this->binds, false); } //-------------------------------------------------------------------- /** * Decrements a numeric column by the specified value. * * @param string $column * @param integer $value * * @throws DatabaseException * * @return mixed */ public function decrement(string $column, int $value = 1) { $column = $this->db->protectIdentifiers($column); $sql = $this->_update($this->QBFrom[0], [$column => "to_number({$column}, '9999999') - {$value}"]); return $this->db->query($sql, $this->binds, false); } //-------------------------------------------------------------------- /** * Replace * * Compiles an replace into string and runs the query. * Because PostgreSQL doesn't support the replace into command, * we simply do a DELETE and an INSERT on the first key/value * combo, assuming that it's either the primary key or a unique key. * * @param array $set An associative array of insert values * * @return mixed * @throws DatabaseException * @internal param true $bool returns the generated SQL, false executes the query. */ public function replace(array $set = null) { if ($set !== null) { $this->set($set); } if (! $this->QBSet) { if (CI_DEBUG) { throw new DatabaseException('You must use the "set" method to update an entry.'); } // @codeCoverageIgnoreStart return false; // @codeCoverageIgnoreEnd } $table = $this->QBFrom[0]; $set = $this->binds; // We need to grab out the actual values from // the way binds are stored with escape flag. array_walk($set, function (&$item) { $item = $item[0]; }); $keys = array_keys($set); $values = array_values($set); $builder = $this->db->table($table); $exists = $builder->where("$keys[0] = $values[0]", null, false)->get()->getFirstRow(); if (empty($exists)) { $result = $builder->insert($set); } else { array_pop($set); $result = $builder->update($set, "$keys[0] = $values[0]"); } unset($builder); $this->resetWrite(); return $result; } //-------------------------------------------------------------------- /** * Delete * * Compiles a delete string and runs the query * * @param mixed $where * @param integer $limit * @param boolean $resetData * * @return mixed * @throws DatabaseException * @internal param the $mixed where clause * @internal param the $mixed limit clause * @internal param $bool */ public function delete($where = '', int $limit = null, bool $resetData = true) { if (! empty($limit) || ! empty($this->QBLimit)) { throw new DatabaseException('PostgreSQL does not allow LIMITs on DELETE queries.'); } return parent::delete($where, $limit, $resetData); } //-------------------------------------------------------------------- /** * LIMIT string * * Generates a platform-specific LIMIT clause. * * @param string $sql SQL Query * * @return string */ protected function _limit(string $sql, bool $offsetIgnore = false): string { return $sql . ' LIMIT ' . $this->QBLimit . ($this->QBOffset ? " OFFSET {$this->QBOffset}" : ''); } //-------------------------------------------------------------------- /** * Update statement * * Generates a platform-specific update string from the supplied data * * @param string $table * @param array $values * * @return string * @throws DatabaseException * @internal param the $string table name * @internal param the $array update data */ protected function _update(string $table, array $values): string { if (! empty($this->QBLimit)) { throw new DatabaseException('Postgres does not support LIMITs with UPDATE queries.'); } $this->QBOrderBy = []; return parent::_update($table, $values); } //-------------------------------------------------------------------- /** * Update_Batch statement * * Generates a platform-specific batch update string from the supplied data * * @param string $table Table name * @param array $values Update data * @param string $index WHERE key * * @return string */ protected function _updateBatch(string $table, array $values, string $index): string { $ids = []; foreach ($values as $val) { $ids[] = $val[$index]; foreach (array_keys($val) as $field) { if ($field !== $index) { $final[$field][] = "WHEN {$val[$index]} THEN {$val[$field]}"; } } } $cases = ''; foreach ($final as $k => $v) // @phpstan-ignore-line { $cases .= "{$k} = (CASE {$index}\n" . implode("\n", $v) . "\nELSE {$k} END), "; } $this->where("{$index} IN(" . implode(',', $ids) . ')', null, false); return "UPDATE {$table} SET " . substr($cases, 0, -2) . $this->compileWhereHaving('QBWhere'); } //-------------------------------------------------------------------- /** * Delete statement * * Generates a platform-specific delete string from the supplied data * * @param string $table The table name * * @return string */ protected function _delete(string $table): string { $this->QBLimit = false; return parent::_delete($table); } //-------------------------------------------------------------------- /** * Truncate statement * * Generates a platform-specific truncate string from the supplied data * * If the database does not support the truncate() command, * then this method maps to 'DELETE FROM table' * * @param string $table The table name * * @return string */ protected function _truncate(string $table): string { return 'TRUNCATE ' . $table . ' RESTART IDENTITY'; } //-------------------------------------------------------------------- /** * Platform independent LIKE statement builder. * * In PostgreSQL, the ILIKE operator will perform case insensitive * searches according to the current locale. * * @see https://www.postgresql.org/docs/9.2/static/functions-matching.html * * @param string|null $prefix * @param string $column * @param string|null $not * @param string $bind * @param boolean $insensitiveSearch * * @return string $like_statement */ public function _like_statement(?string $prefix, string $column, ?string $not, string $bind, bool $insensitiveSearch = false): string { $op = $insensitiveSearch === true ? 'ILIKE' : 'LIKE'; return "{$prefix} {$column} {$not} {$op} :{$bind}:"; } //-------------------------------------------------------------------- /** * JOIN * * Generates the JOIN portion of the query * * @param string $table * @param string $cond The join condition * @param string $type The type of join * @param boolean $escape Whether not to try to escape identifiers * * @return BaseBuilder */ public function join(string $table, string $cond, string $type = '', bool $escape = null) { if (! in_array('FULL OUTER', $this->joinTypes, true)) { $this->joinTypes = array_merge($this->joinTypes, ['FULL OUTER']); } return parent::join($table, $cond, $type, $escape); } //-------------------------------------------------------------------- }