Skip to content

Commit 0b47dfe

Browse files
committed
docs: clarify that $db is for testing purposes
1 parent eafda29 commit 0b47dfe

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

system/Database/MigrationRunner.php

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -122,14 +122,11 @@ class MigrationRunner
122122
protected $groupSkip = false;
123123

124124
/**
125-
* Constructor.
125+
* The migration can manage multiple databases. So it should always use the
126+
* default DB group so that it creates the `migrations` table in the default
127+
* DB group. Therefore, passing $db is for testing purposes only.
126128
*
127-
* When passing in $db, you may pass any of the following to connect:
128-
* - group name
129-
* - existing connection instance
130-
* - array of database configuration values
131-
*
132-
* @param array|ConnectionInterface|string|null $db
129+
* @param array|ConnectionInterface|string|null $db DB group. For testing purposes only.
133130
*
134131
* @throws ConfigException
135132
*/

0 commit comments

Comments
 (0)