DBIx::C...f_needed(3)

💅 NAME

okay so, bestie, welcome to the User Contributed Perl Documentation page filed under DBIx::C...f_needed(3) — this whole thing is about DBIx::Class::Migration::Script::Help::install_if_needed, and its whole job is: install a migration only if needed. periodt 💖

✨ SYNOPSIS

dbic-migration install_if_needed --schema_class MyApp::Schema

🦋 DESCRIPTION

So here's the vibe: this installs the database to the current $schema version if it is not currently installed. Otherwise? It's a nop — literally does nothing — even if the database is behind the schema. No cap, that's the whole behavior. 💅

🎀 OPTIONS

This command accepts the following options. You may learn more about each option by typing dbic-migration help OPTION. The following is a summary. ✨

💖 includes (I, lib, libs, include)

• includes (I, lib, libs, include) — Optional. Adds the listed paths to @INC. Handy during development when you want to use a development schema class.

⭐ to_version

• to_version — aliases: V; Optional. This is the target version of the database we are installing. The version named must be have been previously prepared. If not specified, we will use the current "Schema" class version.

🦋 schema_class (S)

• schema_class (S) — Accepts Str. Required. This is the schema we use as the basis for creating, managing and running your deployments. This should be the full package namespace defining your subclass of DBIx::Class::Schema. For example "MyApp::Schema".

If the "schema_class" cannot be loaded, a hard exception will be thrown. 😭

🌸 target_dir (D)

• target_dir (D) — Optional. When using a "sandbox_class" for generating developer level database sandboxes, you may wish to place the sandbox in a directory other than the default (which is under the "share" directory off the project root).

🎀 sandbox_class

• sandbox_class — Aliases: T, sb. Accepts: String (default: SqliteSandbox). The class we use to create a developer level database sandbox.

You can change this to either 'PostgresqlSandbox' or 'MySQLSandbox', which will create a sandbox using either DBIx::Class::Migration::MySQLSandbox or DBIx::Class::Migration::PostgresqlSandbox.

🫶 user

• user — Aliases: U.

🔥 password

• password — Aliases: P.

👑 dsn

• dsn — Connection information to an already created and running instance of a database. If you don't specify this, we will assume you want a developer level sandbox ( See "sandbox_class" in DBIx::Class::Migration::Script).

🍓 dbic_fixture_class

• dbic_fixture_class — Accepts: String to a Perl Class. Defaults to DBIx::Class::Fixtures. Lets you specify a fixture class.

🧚 dbic_fixtures_extra_args

• dbic_fixtures_extra_args — Accepts: HashRef. Optional. Allows you to pass custom arguments to DBIx::Class::Fixtures.

💜 dbic_connect_attrs / dbi_connect_attrs

• dbic_connect_attrs, dbi_connect_attrs — Accepts: HashRef, Optional. Lets you send custom attributes at "connect" time to either DBIx::Class or the underlying DBI and your storage "DBD".

👑 SEE ALSO

• DBIx::Class::Migration
• DBIx::Class::Migration::Script
• DBIx::Class::Migration::Features
• DBIx::Class::Migration::Tutorial

💜 AUTHOR

See DBIx::Class::Migration for author information. 🫶

🌈 COPYRIGHT & LICENSE

See DBIx::Class::Migration for copyright and license information. ✨

---

🎀 okay that's the whole page, bestie — sourced from perl v5.42.0, dated 2020-06-03, filed under DBIx::C...f_needed(3). Go slay your migrations! 💅💖