updated

Author: github-actions[bot]

changelog.markdown

@@ -9,6 +9,29 @@ title: Codeception Changelog
 
 
 
+### module-db 3.2.0: 3.2.0
+
+Released by [![](https://avatars.githubusercontent.com/u/4129631?v=4&s=16) szhajdu](https://github.com/szhajdu) on 2025/01/31 22:25:44 / [Repository](https://github.com/Codeception/module-db)   / [Releases](https://github.com/Codeception/module-db/releases)
+
+
+
+## What's Changed
+* test: Run test against PHP 8.3 by **[szhajdu](https://github.com/szhajdu)** in https://github.com/Codeception/module-db/pull/71
+* docs: Use short array syntax for consistency by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/module-db/pull/72
+* feat: Configure nullable types explicitly by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/module-db/pull/73
+* test: /opt/mssql-tools/bin/sqlcmd tool not found in given path by **[szhajdu](https://github.com/szhajdu)** in https://github.com/Codeception/module-db/pull/80
+* test: Run test against PHP 8.4 by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/module-db/pull/77
+* test: Avoid deprecated direct access to driver and dbh property by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/module-db/pull/81
+* docs: Fix yaml format in PHPDoc and remove duplication by **[ThomasLandauer](https://github.com/ThomasLandauer)** in https://github.com/Codeception/module-db/pull/78
+* chore: Remove unnecessary files from Composer package by **[s1lver](https://github.com/s1lver)** in https://github.com/Codeception/module-db/pull/83
+
+## New Contributors
+* **[ThomasLandauer](https://github.com/ThomasLandauer)** made their first contribution in https://github.com/Codeception/module-db/pull/78
+* **[s1lver](https://github.com/s1lver)** made their first contribution in https://github.com/Codeception/module-db/pull/83
+
+**Full Changelog**: https://github.com/Codeception/module-db/compare/3.1.4...3.2.0
+
+
 ### module-laravel 3.2.0: 3.2.0
 
 Released by [![](https://avatars.githubusercontent.com/u/64917965?v=4&s=16) TavoNiievez](https://github.com/TavoNiievez) on 2025/01/13 11:42:45 / [Repository](https://github.com/Codeception/module-laravel)   / [Releases](https://github.com/Codeception/module-laravel/releases)

docs/modules/Db.md

@@ -25,7 +25,7 @@ The most important function of this module is to clean a database before each te
 This module also provides actions to perform checks in a database, e.g. [seeInDatabase()](https://codeception.com/docs/modules/Db#seeInDatabase)
 
 In order to have your database populated with data you need a raw SQL dump.
-Simply put the dump in the `tests/_data` directory (by default) and specify the path in the config.
+Simply put the dump in the `tests/Support/Data` directory (by default) and specify the path in the config.
 The next time after the database is cleared, all your data will be restored from the dump.
 Don't forget to include `CREATE TABLE` statements in the dump.
 
@@ -40,85 +40,80 @@ Also available:
 * MS SQL
 * Oracle
 
-Connection is done by database Drivers, which are stored in the `Codeception\Lib\Driver` namespace.
-[Check out the drivers](https://github.com/Codeception/Codeception/tree/2.4/src/Codeception/Lib/Driver)
-if you run into problems loading dumps and cleaning databases.
-
-### Config
-
-* dsn *required* - PDO DSN
-* user *required* - username to access database
-* password *required* - password
-* dump - path to database dump
-* populate: false - whether the the dump should be loaded before the test suite is started
-* cleanup: false - whether the dump should be reloaded before each test
-* reconnect: false - whether the module should reconnect to the database before each test
-* waitlock: 0 - wait lock (in seconds) that the database session should use for DDL statements
-* ssl_key - path to the SSL key (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-key)
-* ssl_cert - path to the SSL certificate (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-cert)
-* ssl_ca - path to the SSL certificate authority (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-ca)
-* ssl_verify_server_cert - disables certificate CN verification (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php)
-* ssl_cipher - list of one or more permissible ciphers to use for SSL encryption (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-cipher)
-* databases - include more database configs and switch between them in tests.
-* initial_queries - list of queries to be executed right after connection to the database has been initiated, i.e. creating the database if it does not exist or preparing the database collation
-* skip_cleanup_if_failed - Do not perform the cleanup if the tests failed. If this is used, manual cleanup might be required when re-running
-### Example
-
-    modules:
-       enabled:
-          - Db:
-             dsn: 'mysql:host=localhost;dbname=testdb'
-             user: 'root'
-             password: ''
-             dump: 'tests/_data/dump.sql'
-             populate: true
-             cleanup: true
-             reconnect: true
-             waitlock: 10
-             skip_cleanup_if_failed: true
-             ssl_key: '/path/to/client-key.pem'
-             ssl_cert: '/path/to/client-cert.pem'
-             ssl_ca: '/path/to/ca-cert.pem'
-             ssl_verify_server_cert: false
-             ssl_cipher: 'AES256-SHA'
-             initial_queries:
-                 - 'CREATE DATABASE IF NOT EXISTS temp_db;'
-                 - 'USE temp_db;'
-                 - 'SET NAMES utf8;'
+Connection is done by database drivers, which are stored in the `Codeception\Lib\Driver` namespace.
+Check out the drivers if you run into problems loading dumps and cleaning databases.
+
+### Example `Functional.suite.yml`
+{% highlight yaml %}
+
+modules:
+    enabled:
+        - Db:
+            dsn: 'mysql:host=localhost;dbname=testdb'
+            user: 'root'
+            password: ''
+            dump: 'tests/Support/Data/dump.sql'
+            populate: true # whether the dump should be loaded before the test suite is started
+            cleanup: true # whether the dump should be reloaded before each test
+            reconnect: true # whether the module should reconnect to the database before each test
+            waitlock: 10 # wait lock (in seconds) that the database session should use for DDL statements
+            databases: # include more database configs and switch between them in tests.
+            skip_cleanup_if_failed: true # Do not perform the cleanup if the tests failed. If this is used, manual cleanup might be required when re-running
+            ssl_key: '/path/to/client-key.pem' # path to the SSL key (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-key)
+            ssl_cert: '/path/to/client-cert.pem' # path to the SSL certificate (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-cert)
+            ssl_ca: '/path/to/ca-cert.pem' # path to the SSL certificate authority (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-ca)
+            ssl_verify_server_cert: false # disables certificate CN verification (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php)
+            ssl_cipher: 'AES256-SHA' # list of one or more permissible ciphers to use for SSL encryption (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-cipher)
+            initial_queries: # list of queries to be executed right after connection to the database has been initiated, i.e. creating the database if it does not exist or preparing the database collation
+                - 'CREATE DATABASE IF NOT EXISTS temp_db;'
+                - 'USE temp_db;'
+                - 'SET NAMES utf8;'
+
+{% endhighlight %}
 
 ### Example with multi-dumps
-    modules:
-         enabled:
-            - Db:
-               dsn: 'mysql:host=localhost;dbname=testdb'
-               user: 'root'
-               password: ''
-               dump:
-                  - 'tests/_data/dump.sql'
-                  - 'tests/_data/dump-2.sql'
+{% highlight yaml %}
+
+modules:
+    enabled:
+        - Db:
+            dsn: 'mysql:host=localhost;dbname=testdb'
+            user: 'root'
+            password: ''
+            dump:
+                - 'tests/Support/Data/dump.sql'
+                - 'tests/Support/Data/dump-2.sql'
+
+{% endhighlight %}
 
 ### Example with multi-databases
+{% highlight yaml %}
 
-    modules:
-       enabled:
-          - Db:
-             dsn: 'mysql:host=localhost;dbname=testdb'
-             user: 'root'
-             password: ''
-             databases:
+modules:
+    enabled:
+        - Db:
+            dsn: 'mysql:host=localhost;dbname=testdb'
+            user: 'root'
+            password: ''
+            databases:
                 db2:
-                   dsn: 'mysql:host=localhost;dbname=testdb2'
-                   user: 'userdb2'
-                   password: ''
+                    dsn: 'mysql:host=localhost;dbname=testdb2'
+                    user: 'userdb2'
+                    password: ''
+
+{% endhighlight %}
 
-### Example with Sqlite
+### Example with SQLite
+{% highlight yaml %}
+
+modules:
+    enabled:
+        - Db:
+            dsn: 'sqlite:relative/path/to/sqlite-database.db'
+            user: ''
+            password: ''
 
-    modules:
-       enabled:
-          - Db:
-             dsn: 'sqlite:relative/path/to/sqlite-database.db'
-             user: ''
-             password: ''
+{% endhighlight %}
 
 ### SQL data dump
 
@@ -134,31 +129,32 @@ For MySQL:
 {% highlight yaml %}
 
 modules:
-   enabled:
-      - Db:
-         dsn: 'mysql:host=localhost;dbname=testdb'
-         user: 'root'
-         password: ''
-         dump: 'tests/_data/dump.sql'
-         populate: true # run populator before all tests
-         cleanup: true # run populator before each test
-         populator: 'mysql -u $user -h $host $dbname < $dump'
+    enabled:
+        - Db:
+            dsn: 'mysql:host=localhost;dbname=testdb'
+            user: 'root'
+            password: ''
+            dump: 'tests/Support/Data/dump.sql'
+            populate: true # run populator before all tests
+            cleanup: true # run populator before each test
+            populator: 'mysql -u $user -h $host $dbname < $dump'
 
 {% endhighlight %}
 
-For PostgreSQL (using pg_restore)
+For PostgreSQL (using `pg_restore`)
 
 {% highlight yaml %}
+
 modules:
-   enabled:
-      - Db:
-         dsn: 'pgsql:host=localhost;dbname=testdb'
-         user: 'root'
-         password: ''
-         dump: 'tests/_data/db_backup.dump'
-         populate: true # run populator before all tests
-         cleanup: true # run populator before each test
-         populator: 'pg_restore -u $user -h $host -D $dbname < $dump'
+    enabled:
+        - Db:
+            dsn: 'pgsql:host=localhost;dbname=testdb'
+            user: 'root'
+            password: ''
+            dump: 'tests/Support/Data/db_backup.dump'
+            populate: true # run populator before all tests
+            cleanup: true # run populator before each test
+            populator: 'pg_restore -u $user -h $host -D $dbname < $dump'
 
 {% endhighlight %}
 
@@ -334,7 +330,7 @@ Provide table name, desired column and criteria.
 {% highlight php %}
 
 <?php
-$mails = $I->grabColumnFromDatabase('users', 'email', array('name' => 'RebOOter'));
+$mails = $I->grabColumnFromDatabase('users', 'email', ['name' => 'RebOOter']);
 
 {% endhighlight %}
 
@@ -353,7 +349,7 @@ Provide table name and criteria.
 {% highlight php %}
 
 <?php
-$mail = $I->grabEntriesFromDatabase('users', array('name' => 'Davert'));
+$mail = $I->grabEntriesFromDatabase('users', ['name' => 'Davert']);
 
 {% endhighlight %}
 Comparison expressions can be used as well:
@@ -384,7 +380,7 @@ Provide table name, desired column and criteria.
 {% highlight php %}
 
 <?php
-$mail = $I->grabEntryFromDatabase('users', array('name' => 'Davert'));
+$mail = $I->grabEntryFromDatabase('users', ['name' => 'Davert']);
 
 {% endhighlight %}
 Comparison expressions can be used as well:
@@ -414,7 +410,7 @@ Provide table name, desired column and criteria.
 {% highlight php %}
 
 <?php
-$mail = $I->grabFromDatabase('users', 'email', array('name' => 'Davert'));
+$mail = $I->grabFromDatabase('users', 'email', ['name' => 'Davert']);
 
 {% endhighlight %}
 Comparison expressions can be used as well:
@@ -451,7 +447,7 @@ unless you've configured "skip_cleanup_if_failed", and the test fails.
 {% highlight php %}
 
 <?php
-$I->haveInDatabase('users', array('name' => 'miles', 'email' => '[email protected]'));
+$I->haveInDatabase('users', ['name' => 'miles', 'email' => '[email protected]']);
 
 {% endhighlight %}
 
@@ -559,7 +555,7 @@ Update an SQL record into a database.
 {% highlight php %}
 
 <?php
-$I->updateInDatabase('users', array('isAdmin' => true), array('email' => '[email protected]'));
+$I->updateInDatabase('users', ['isAdmin' => true], ['email' => '[email protected]']);
 
 {% endhighlight %}