Fix maximum number of bound parameters for MySQL

Also deprecate unnecessary Options getters and setters.

Author: theodorejb

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [6.3.1] - 2024-10-13
+### Changed
+- Improved `makeBinaryParam()` implementation for SQL Server.
+
+### Fixed
+- Maximum number of MySQL bound parameters.
+
+### Deprecated
+- Unnecessary `Options` getters and setters.
+
+
 ## [6.3.0] - 2024-10-05
 ### Changed
 - Use `mysqli_stmt::get_result()` instead of `bind_result()` internally
@@ -327,6 +338,7 @@ insert a single row.
 - Initial release
 
 
+[6.3.1]: https://github.com/theodorejb/peachy-sql/compare/v6.3.0...v6.3.1
 [6.3.0]: https://github.com/theodorejb/peachy-sql/compare/v6.2.0...v6.3.0
 [6.2.0]: https://github.com/theodorejb/peachy-sql/compare/v6.1.0...v6.2.0
 [6.1.0]: https://github.com/theodorejb/peachy-sql/compare/v6.0.3...v6.1.0

README.md

@@ -15,8 +15,8 @@ and SQL Server, and runs on PHP 7.4+.
 ## Usage
 
 Start by instantiating the `Mysql` or `SqlServer` class with a database connection,
-which should be an existing [mysqli object](http://www.php.net/manual/en/mysqli.construct.php)
-or [SQLSRV connection resource](http://www.php.net/manual/en/function.sqlsrv-connect.php):
+which should be an existing [mysqli object](https://www.php.net/manual/en/mysqli.construct.php)
+or [SQLSRV connection resource](https://www.php.net/manual/en/function.sqlsrv-connect.php):
 
 ```php
 $peachySql = new PeachySQL\Mysql($mysqlConn);
@@ -207,7 +207,7 @@ $ids = $result->ids; // e.g. [64, 66, 68]
 
 Note: SQL Server allows a maximum of 1,000 rows to be inserted at a time, and limits
 individual queries to 2,099 or fewer bound parameters. MySQL supports a maximum of
-65,536 bound parameters per query. These limits can be easily reached when attempting
+65,535 bound parameters per query. These limits can be easily reached when attempting
 to bulk-insert hundreds or thousands of rows at a time. To avoid these limits, the
 `insertRows()` method automatically splits large queries into batches to efficiently
 handle any number of rows (`queryCount` contains the number of required batches).

lib/BaseOptions.php

@@ -9,8 +9,17 @@
  */
 abstract class BaseOptions
 {
-    protected int $maxBoundParams = 0;
-    protected int $maxInsertRows = 0;
+    /**
+     * The maximum number of parameters which can be bound in a single query.
+     * If greater than zero, PeachySQL will batch insert queries to avoid the limit.
+     */
+    public int $maxBoundParams = 0;
+
+    /**
+     * The maximum number of rows which can be inserted via a single query.
+     * If greater than zero, PeachySQL will batch insert queries to avoid the limit.
+     */
+    public int $maxInsertRows = 0;
 
     /**
      * Escapes a table or column name, and validates that it isn't blank
@@ -33,6 +42,8 @@ public function escapeIdentifier(string $identifier): string
     /**
      * Specify the maximum number of parameters which can be bound in a single query.
      * If greater than zero, PeachySQL will batch insert queries to avoid the limit.
+     * @deprecated Use public property instead
+     * @api
      */
     public function setMaxBoundParams(int $maxParams): void
     {
@@ -43,6 +54,10 @@ public function setMaxBoundParams(int $maxParams): void
         $this->maxBoundParams = $maxParams;
     }
 
+    /**
+     * @deprecated Use public property instead
+     * @api
+     */
     public function getMaxBoundParams(): int
     {
         return $this->maxBoundParams;
@@ -51,6 +66,8 @@ public function getMaxBoundParams(): int
     /**
      * Specify the maximum number of rows which can be inserted via a single query.
      * If greater than zero, PeachySQL will batch insert queries to remove the limit.
+     * @deprecated Use public property instead
+     * @api
      */
     public function setMaxInsertRows(int $maxRows): void
     {
@@ -61,6 +78,10 @@ public function setMaxInsertRows(int $maxRows): void
         $this->maxInsertRows = $maxRows;
     }
 
+    /**
+     * @deprecated Use public property instead
+     * @api
+     */
     public function getMaxInsertRows(): int
     {
         return $this->maxInsertRows;

lib/Mysql/Options.php

@@ -11,7 +11,8 @@
  */
 class Options extends BaseOptions
 {
-    protected int $maxBoundParams = 65536; // 2^16
+    // https://stackoverflow.com/questions/6581573/what-are-the-max-number-of-allowable-parameters-per-database-provider-type
+    public int $maxBoundParams = 65_535; // 2 ** 16 - 1;
 
     // use backticks to delimit identifiers since not everyone uses ANSI mode
     public function escapeIdentifier(string $identifier): string

lib/PeachySql.php

@@ -16,7 +16,8 @@
  */
 abstract class PeachySql
 {
-    protected BaseOptions $options;
+    /** @readonly */
+    public BaseOptions $options;
 
     /** Begins a transaction */
     abstract public function begin(): void;
@@ -50,6 +51,8 @@ abstract protected function insertBatch(string $table, array $colVals, int $iden
 
     /**
      * Returns the current PeachySQL options
+     * @deprecated Use public readonly property instead
+     * @api
      */
     public function getOptions(): BaseOptions
     {
@@ -84,7 +87,7 @@ public function insertRow(string $table, array $colVals): InsertResult
     public function insertRows(string $table, array $colVals, int $identityIncrement = 1): BulkInsertResult
     {
         // check whether the query needs to be split into multiple batches
-        $batches = Insert::batchRows($colVals, $this->options->getMaxBoundParams(), $this->options->getMaxInsertRows());
+        $batches = Insert::batchRows($colVals, $this->options->maxBoundParams, $this->options->maxInsertRows);
         $ids = [];
         $affected = 0;
 

lib/QueryableSelector.php

@@ -12,7 +12,7 @@ class QueryableSelector extends Selector
 
     public function __construct(SqlParams $query, PeachySql $peachySql)
     {
-        parent::__construct($query, $peachySql->getOptions());
+        parent::__construct($query, $peachySql->options);
         $this->peachySql = $peachySql;
     }
 

lib/SqlServer/Options.php

@@ -11,6 +11,7 @@
  */
 class Options extends BaseOptions
 {
-    protected int $maxBoundParams = 2099;
-    protected int $maxInsertRows = 1000;
+    // https://learn.microsoft.com/en-us/sql/sql-server/maximum-capacity-specifications-for-sql-server
+    public int $maxBoundParams = 2100 - 1;
+    public int $maxInsertRows = 1000;
 }

test/Mysql/OptionsTest.php

@@ -12,34 +12,6 @@
  */
 class OptionsTest extends TestCase
 {
-    public function testMaxBoundParams(): void
-    {
-        $options = new Options();
-        $options->setMaxBoundParams(2000);
-        $this->assertSame(2000, $options->getMaxBoundParams());
-
-        try {
-            $options->setMaxBoundParams(-1); // should throw exception
-            $this->fail('setMaxBoundParams failed to throw expected exception');
-        } catch (\InvalidArgumentException $e) {
-            $this->assertSame('The maximum number of bound parameters must be greater than or equal to zero', $e->getMessage());
-        }
-    }
-
-    public function testMaxInsertRows(): void
-    {
-        $options = new Options();
-        $options->setMaxInsertRows(1000);
-        $this->assertSame(1000, $options->getMaxInsertRows());
-
-        try {
-            $options->setMaxInsertRows(-1); // should throw exception
-            $this->fail('setMaxInsertRows failed to throw expected exception');
-        } catch (\InvalidArgumentException $e) {
-            $this->assertSame('The maximum number of insert rows must be greater than or equal to zero', $e->getMessage());
-        }
-    }
-
     public function testEscapeIdentifier(): void
     {
         $options = new Options();