Skip to content

feat: add pretend support to seed run command #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
elpete wants to merge 2 commits into
base: master
Choose a base branch
from
+30 −4
Open

feat: add pretend support to seed run command #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a8fe34
fix: skip seeds when running in pretend mode
elpete Apr 3, 2026
26dd725
feat: add pretend support to seed run command
elpete Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions commands/migrate/seed/run.cfc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,16 @@ component extends="commandbox-migrations.models.BaseMigrationCommand" {
* @manager.hint The Migration Manager to use.
* @manager.optionsUDF completeManagers
* @verbose.hint If true, errors output a full stack trace.
* @pretend.hint If true, only pretends to run the query. The SQL that would have been run is printed to the console.
* @file.hint If provided, outputs the SQL that would have been run to the file. Only applies when running `pretend`.
*/
function run( string name = "", string manager = "default", boolean verbose = false ) {
function run(
string name = "",
string manager = "default",
boolean verbose = false,
boolean pretend = false,
string file
) {
setup( arguments.manager );

if ( getCFMigrationsType() == "boxJSON" ) {
Expand All @@ -26,16 +34,29 @@ component extends="commandbox-migrations.models.BaseMigrationCommand" {

pagePoolClear();

var statements = [];
var currentlyRunningSeeder = "UNKNOWN";
try {
migrationService.seed(
seedName = arguments.name == "" ? nullValue() : arguments.name,
pretend = arguments.pretend,
preProcessHook = ( seeder ) => {
currentlyRunningSeeder = seeder;
print.yellow( "Seeding: " ).line( seeder ).toConsole();
},
postProcessHook = ( seeder ) => {
print.green( "Seeded: " ).line( seeder ).toConsole();
postProcessHook = ( seeder, qb ) => {
if ( !pretend ) {
print.green( "Seeded: " ).line( seeder ).toConsole();
} else {
print.green( "Pretended to seed: " ).line( seeder ).toConsole();
print.line();
for ( var q in qb.getQueryLog() ) {
var inlineSql = qb.getUtils().replaceBindings( q.sql, q.bindings, true );
statements.append( inlineSql );
print.line( inlineSql );
print.line();
}
}
}
);
} catch ( any e ) {
Expand Down Expand Up @@ -66,6 +87,11 @@ component extends="commandbox-migrations.models.BaseMigrationCommand" {
if ( currentlyRunningSeeder == "UNKNOWN" ) {
print.line( "No seeders to run." );
}

if ( arguments.pretend && !isNull( arguments.file ) ) {
file action="write" file="#fileSystemUtil.resolvePath( arguments.file )#" mode="666" output="#trim( statements.toList( ";" & chr( 10 ) & chr( 10 ) ) )#";
print.whiteOnBlueLine( "Wrote SQL to file: #arguments.file#" );
}
}

function completeSeedNames( string paramSoFar, struct passedNamedParameters ) {
Expand Down
2 changes: 1 addition & 1 deletion commands/migrate/up.cfc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ component extends="commandbox-migrations.models.BaseMigrationCommand" {
if ( arguments.seed ) {
print.line();
command( "migrate seed run" )
.params( argumentCollection = { manager: arguments.manager, verbose: arguments.verbose } )
.params( argumentCollection = { manager: arguments.manager, verbose: arguments.verbose, pretend: arguments.pretend } )
.run();
}

Expand Down