Limit function for MySQL, PostgreSQL, SQLite

README.md

@@ -13,10 +13,10 @@ MySQL, Oracle, PostgreSQL and SQLite.
 
 | DB | Functions |
 |:--:|:---------:|
-| MySQL | `ACOS, ADDTIME, AES_DECRYPT, AES_ENCRYPT, ANY_VALUE, ASCII, ASIN, ATAN, ATAN2, BINARY, BIT_COUNT, BIT_XOR, CAST, CEIL, CHAR_LENGTH, COLLATE, CONCAT_WS, CONVERT_TZ, COS, COT, COUNTIF, CRC32, DATE, DATE_FORMAT, DATEADD, DATEDIFF, DATESUB, DAY, DAYNAME, DAYOFWEEK, DAYOFYEAR, DEGREES, DIV, EXP, EXTRACT, FIELD, FIND_IN_SET, FLOOR, FORMAT, FROM_BASE64, FROM_UNIXTIME, GREATEST, GROUP_CONCAT, HEX, HOUR, IFELSE, IFNULL, INET_ATON, INET_NTOA, INET6_ATON, INET6_NTOA, INSTR, IS_IPV4, IS_IPV4_COMPAT, IS_IPV4_MAPPED, IS_IPV6, JSON_CONTAINS, JSON_DEPTH, JSON_LENGTH, LAG, LAST_DAY, LEAD, LEAST, LOG, LOG10, LOG2, LPAD, MAKEDATE, MATCH, MD5, MINUTE, MONTH, MONTHNAME, NOW, NULLIF, OVER, PERIOD_DIFF, PI, POWER, QUARTER, RADIANS, RAND, REGEXP, REPLACE, ROUND, RPAD, SECOND, SECTOTIME, SHA1, SHA2, SIN, SOUNDEX, STD, STDDEV, STRTODATE, STR_TO_DATE, SUBSTRING_INDEX, TAN, TIME, TIMEDIFF, TIMESTAMPADD, TIMESTAMPDIFF, TIMETOSEC, TRUNCATE, UNHEX, UNIX_TIMESTAMP, UTC_TIMESTAMP, UUID_SHORT, VARIANCE, WEEK, WEEKDAY, WEEKOFYEAR, YEAR, YEARMONTH, YEARWEEK` |
+| MySQL | `ACOS, ADDTIME, AES_DECRYPT, AES_ENCRYPT, ANY_VALUE, ASCII, ASIN, ATAN, ATAN2, BINARY, BIT_COUNT, BIT_XOR, CAST, CEIL, CHAR_LENGTH, COLLATE, CONCAT_WS, CONVERT_TZ, COS, COT, COUNTIF, CRC32, DATE, DATE_FORMAT, DATEADD, DATEDIFF, DATESUB, DAY, DAYNAME, DAYOFWEEK, DAYOFYEAR, DEGREES, DIV, EXP, EXTRACT, FIELD, FIND_IN_SET, FLOOR, FORMAT, FROM_BASE64, FROM_UNIXTIME, GREATEST, GROUP_CONCAT, HEX, HOUR, IFELSE, IFNULL, INET_ATON, INET_NTOA, INET6_ATON, INET6_NTOA, INSTR, IS_IPV4, IS_IPV4_COMPAT, IS_IPV4_MAPPED, IS_IPV6, JSON_CONTAINS, JSON_DEPTH, JSON_LENGTH, LAG, LAST_DAY, LEAD, LEAST, LIMIT, LOG, LOG10, LOG2, LPAD, MAKEDATE, MATCH, MD5, MINUTE, MONTH, MONTHNAME, NOW, NULLIF, OVER, PERIOD_DIFF, PI, POWER, QUARTER, RADIANS, RAND, REGEXP, REPLACE, ROUND, RPAD, SECOND, SECTOTIME, SHA1, SHA2, SIN, SOUNDEX, STD, STDDEV, STRTODATE, STR_TO_DATE, SUBSTRING_INDEX, TAN, TIME, TIMEDIFF, TIMESTAMPADD, TIMESTAMPDIFF, TIMETOSEC, TRUNCATE, UNHEX, UNIX_TIMESTAMP, UTC_TIMESTAMP, UUID_SHORT, VARIANCE, WEEK, WEEKDAY, WEEKOFYEAR, YEAR, YEARMONTH, YEARWEEK` |
 | Oracle | `CEIL, DAY, FLOOR, HOUR, LISTAGG, MINUTE, MONTH, NVL, SECOND, TO_CHAR, TO_DATE, TRUNC, YEAR` |
-| SQLite | `CASE WHEN THEN ELSE END, DATE, DATE_FORMAT*, DAY, HOUR, IFNULL, JULIANDAY, MINUTE, MONTH, REPLACE, ROUND, SECOND, STRFTIME, WEEK, WEEKDAY, YEAR` |
-| PostgreSQL | `AT_TIME_ZONE, COUNT_FILTER, DATE, DATE_PART, DATE_TRUNC, DAY, EXTRACT, GREATEST, HOUR, LEAST, MINUTE, MONTH, REGEXP_REPLACE, SECOND, STRING_AGG, TO_CHAR, TO_DATE, YEAR` |
+| SQLite | `CASE WHEN THEN ELSE END, DATE, DATE_FORMAT*, DAY, HOUR, IFNULL, JULIANDAY, LIMIT, MINUTE, MONTH, REPLACE, ROUND, SECOND, STRFTIME, WEEK, WEEKDAY, YEAR` |
+| PostgreSQL | `AT_TIME_ZONE, COUNT_FILTER, DATE, DATE_PART, DATE_TRUNC, DAY, EXTRACT, GREATEST, HOUR, LEAST, LIMIT, MINUTE, MONTH, REGEXP_REPLACE, SECOND, STRING_AGG, TO_CHAR, TO_DATE, YEAR` |
 
 > Note: SQLite date functions are implemented as `strftime(format, value)`.
   SQLite only supports the [most common formats](https://www.sqlite.org/lang_datefunc.html),

config/mysql.yml

@@ -107,6 +107,7 @@ doctrine:
                  lag: DoctrineExtensions\Query\Mysql\Lag
                  lead: DoctrineExtensions\Query\Mysql\Lead
                  least: DoctrineExtensions\Query\Mysql\Least
+                 limit: DoctrineExtensions\Query\Mysql\Limit
                  lpad: DoctrineExtensions\Query\Mysql\Lpad
                  match: DoctrineExtensions\Query\Mysql\MatchAgainst
                  md5: DoctrineExtensions\Query\Mysql\Md5

config/postgres.yml

@@ -21,4 +21,5 @@ doctrine:
                 string_agg: DoctrineExtensions\Query\Postgresql\StringAgg
                 greatest: DoctrineExtensions\Query\Postgresql\Greatest
                 least: DoctrineExtensions\Query\Postgresql\Least
+                limit: DoctrineExtensions\Query\Postgresql\Limit
                 regexp_replace: DoctrineExtensions\Query\Postgresql\RegexpReplace

config/sqlite.yml

@@ -37,6 +37,7 @@ doctrine:
                  ifelse: DoctrineExtensions\Query\Sqlite\IfElse
                  ifnull: DoctrineExtensions\Query\Sqlite\IfNull
                  least: DoctrineExtensions\Query\Sqlite\Least
+                 limit: DoctrineExtensions\Query\Sqlite\Limit
 #                 match: DoctrineExtensions\Query\Sqlite\MatchAgainst
 #                 md5: DoctrineExtensions\Query\Sqlite\Md5
 #                 nullif: DoctrineExtensions\Query\Sqlite\NullIf

src/Query/Mysql/Limit.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace DoctrineExtensions\Query\Mysql;
+
+use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Literal;
+use Doctrine\ORM\Query\AST\Subselect;
+use Doctrine\ORM\Query\Parser;
+use Doctrine\ORM\Query\SqlWalker;
+use Doctrine\ORM\Query\TokenType;
+
+/**
+ * @author Piotr Reclik <reclikp@gmail.com>
+ * @example SELECT LIMIT((sub-query), limitValue)
+ */
+class Limit extends FunctionNode
+{
+    /** @var Subselect */
+    private $subSelect;
+
+    /** @var Literal */
+    private $limit;
+
+    public function getSql(SqlWalker $sqlWalker): string
+    {
+        return "({$this->subSelect->dispatch($sqlWalker)} LIMIT {$this->limit->dispatch($sqlWalker)})";
+    }
+
+    public function parse(Parser $parser): void
+    {
+        $parser->match(TokenType::T_IDENTIFIER);
+        $parser->match(TokenType::T_OPEN_PARENTHESIS);
+        $parser->match(TokenType::T_OPEN_PARENTHESIS);
+
+        $this->subSelect = $parser->Subselect();
+
+        $parser->match(TokenType::T_CLOSE_PARENTHESIS);
+
+        $parser->match(TokenType::T_COMMA);
+
+        $this->limit = $parser->ArithmeticPrimary();
+
+        $parser->match(TokenType::T_CLOSE_PARENTHESIS);
+    }
+}

src/Query/Postgresql/Limit.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace DoctrineExtensions\Query\Postgresql;
+
+use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Literal;
+use Doctrine\ORM\Query\AST\Subselect;
+use Doctrine\ORM\Query\Parser;
+use Doctrine\ORM\Query\SqlWalker;
+use Doctrine\ORM\Query\TokenType;
+
+/**
+ * @author Piotr Reclik <reclikp@gmail.com>
+ * @example SELECT LIMIT((sub-query), limitValue)
+ */
+class Limit extends FunctionNode
+{
+    /** @var Subselect */
+    private $subSelect;
+
+    /** @var Literal */
+    private $limit;
+
+    public function getSql(SqlWalker $sqlWalker): string
+    {
+        return "({$this->subSelect->dispatch($sqlWalker)} LIMIT {$this->limit->dispatch($sqlWalker)})";
+    }
+
+    public function parse(Parser $parser): void
+    {
+        $parser->match(TokenType::T_IDENTIFIER);
+        $parser->match(TokenType::T_OPEN_PARENTHESIS);
+        $parser->match(TokenType::T_OPEN_PARENTHESIS);
+
+        $this->subSelect = $parser->Subselect();
+
+        $parser->match(TokenType::T_CLOSE_PARENTHESIS);
+
+        $parser->match(TokenType::T_COMMA);
+
+        $this->limit = $parser->ArithmeticPrimary();
+
+        $parser->match(TokenType::T_CLOSE_PARENTHESIS);
+    }
+}

src/Query/Sqlite/Limit.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace DoctrineExtensions\Query\Sqlite;
+
+use Doctrine\ORM\Query\AST\Functions\FunctionNode;
+use Doctrine\ORM\Query\AST\Literal;
+use Doctrine\ORM\Query\AST\Subselect;
+use Doctrine\ORM\Query\Parser;
+use Doctrine\ORM\Query\SqlWalker;
+use Doctrine\ORM\Query\TokenType;
+
+/**
+ * @author Piotr Reclik <reclikp@gmail.com>
+ * @example SELECT LIMIT((sub-query), limitValue)
+ */
+class Limit extends FunctionNode
+{
+    /** @var Subselect */
+    private $subSelect;
+
+    /** @var Literal */
+    private $limit;
+
+    public function getSql(SqlWalker $sqlWalker): string
+    {
+        return "({$this->subSelect->dispatch($sqlWalker)} LIMIT {$this->limit->dispatch($sqlWalker)})";
+    }
+
+    public function parse(Parser $parser): void
+    {
+        $parser->match(TokenType::T_IDENTIFIER);
+        $parser->match(TokenType::T_OPEN_PARENTHESIS);
+        $parser->match(TokenType::T_OPEN_PARENTHESIS);
+
+        $this->subSelect = $parser->Subselect();
+
+        $parser->match(TokenType::T_CLOSE_PARENTHESIS);
+
+        $parser->match(TokenType::T_COMMA);
+
+        $this->limit = $parser->ArithmeticPrimary();
+
+        $parser->match(TokenType::T_CLOSE_PARENTHESIS);
+    }
+}

tests/Query/Mysql/LimitTest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace DoctrineExtensions\Tests\Query\Mysql;
+
+use DoctrineExtensions\Tests\Query\MysqlTestCase;
+
+class LimitTest extends MysqlTestCase
+{
+    public function testLimit(): void
+    {
+        $this->assertDqlProducesSql(
+            'SELECT b0 FROM DoctrineExtensions\Tests\Entities\Blank b0 WHERE b0.id = LIMIT((SELECT b1 FROM DoctrineExtensions\Tests\Entities\Blank b1 ORDER BY b1.id DESC), 1)',
+            'SELECT b0_.id AS id_0 FROM Blank b0_ WHERE b0_.id = (SELECT b1_.id FROM Blank b1_ ORDER BY b1_.id DESC LIMIT 1)'
+        );
+    }
+}

tests/Query/Postgresql/LimitTest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace DoctrineExtensions\Tests\Query\Postgresql;
+
+use DoctrineExtensions\Tests\Query\PostgresqlTestCase;
+
+class LimitTest extends PostgresqlTestCase
+{
+    public function testLimit(): void
+    {
+        $this->assertDqlProducesSql(
+            'SELECT b0 FROM DoctrineExtensions\Tests\Entities\Blank b0 WHERE b0.id = LIMIT((SELECT b1 FROM DoctrineExtensions\Tests\Entities\Blank b1 ORDER BY b1.id DESC), 1)',
+            'SELECT b0_.id AS id_0 FROM Blank b0_ WHERE b0_.id = (SELECT b1_.id FROM Blank b1_ ORDER BY b1_.id DESC LIMIT 1)'
+        );
+    }
+}

tests/Query/Sqlite/LimitTest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace DoctrineExtensions\Tests\Query\Sqlite;
+
+use DoctrineExtensions\Tests\Query\SqliteTestCase;
+
+class LimitTest extends SqliteTestCase
+{
+    public function testLimit(): void
+    {
+        $this->assertDqlProducesSql(
+            'SELECT b0 FROM DoctrineExtensions\Tests\Entities\Blank b0 WHERE b0.id = LIMIT((SELECT b1 FROM DoctrineExtensions\Tests\Entities\Blank b1 ORDER BY b1.id DESC), 1)',
+            'SELECT b0_.id AS id_0 FROM Blank b0_ WHERE b0_.id = (SELECT b1_.id FROM Blank b1_ ORDER BY b1_.id DESC LIMIT 1)'
+        );
+    }
+}