DBIx::C...:prepare(3)

💅 DBIx::Class::Migration::Script::Help::prepare — the prepare command, bestie edition 🎀

okay so this page is from DBIx::C...:prepare(3), part of the User Contributed Perl Documentation — and it's literally the whole glow-up guide for dbic-migration prepare. no cap, it's giving "let's make some migration files" energy and we're gonna walk through it together 🦋

---

✨ NAME ✨

DBIx::Class::Migration::Script::Help::prepare — Create migration files. that's the whole vibe. 💖

---

🌸 SYNOPSIS 🌸

here's the moment, the main character entrance:

dbic-migration prepare \
  --lib=lib \
  --schema_class=MyApp::Schema

iconic. copy it exactly, don't come for me. 💅

---

🦋 DESCRIPTION 🦋

So what does this actually do? It creates a fixtures directory AND a migrations directory under target_dir (but only if they don't already exist, she's not out here duplicating) and makes deployment files for the current schema. 🫶

BUT — and this is the important part — if deployment files already exist, it will fail unless you use overwrite_migrations. like, it's not gonna just steamroll your stuff. respect. 😌

The migrations directory reflects a directory structure as documented in DBIx::Class::DeploymentHandler. so if you're like "what's all this folder structure about", go read that, iykyk. 📁

If this is the first version, we create directories and initial DLL, etc. (yes, it says DLL, that's what the page says, don't @ me 💀). For versions greater than 1, we will also generate diffs and copy any fixture configs etc (as well as generating a fresh 'all_table.json' fixture config). ✨

For safety reasons, we never overwrite any fixture configs (even if overwrite_migrations is true.) 🔥 So your fixture configs are safe, periodt. put them down, they're protected.

---

👑 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. (yes bestie, there's a whole help system, go explore 🌈)

🎀 includes

• Aliases: I, lib, libs, include

Accepts String, Optional.

Adds the listed paths to @INC. Handy during development when you want to use a development schema class. lowkey the move when you're still cooking your schema locally 🧚

🎀 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. this is THE foundation, she's the blueprint 💜

If the schema_class cannot be loaded, a hard exception will be thrown. 😭 no soft vibes, no gentle warning — it's a whole hard exception. make sure that class actually loads, bestie.

🎀 force_overwrite (O)

Optional. Bool.

Usually if you've already prepared migration files for the current version as specified in your schema_class we don't write out files even if you call prepare. If you want to force overwrite previously prepared files (and lose all your customizations) you can do so with this option. ⚠️

like… lose all your customizations. read that again. that's the trade, and it's a real one bestie, so be sure before you commit. 🙈

This option won't overwrite previously existing fixture configuration files. so at least those are still safe 🫶

🎀 target_dir (D)

Optional. String (Path to directory).

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). so like, if the default spot isn't it for you, this is your moment to pick a different one 🌸

🎀 databases

• Aliases: database

Value: Str or Array of Str (default: SQLite). Optional.

By default we create migrations for SQLite. You can use this option to change that default, or to write our migrations for more than one database. multi-database era, we love to see it 💖

You can prepare deployment for any database type that SQL::Translator understands. that's the range, and it's wide 🔥

dbic-migration prepare --database SQLite --database MySQL --PostgreSQL

Please note if you choose to manually set this value, you won't automatically get the default or inferred type. so like, set it on purpose and know what you're doing 👀

🎀 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 DBIx::Class::Migration::MySQLSandbox or DBIx::Class::Migration::PostgresqlSandbox. pick your fighter 💅

🎀 user

• Aliases: U

(that's it, that's the entry — the page keeps it short and sweet 🎀)

🎀 password

• Aliases: P

(same vibe, short and sweet, no extra detail on this page ✨)

🎀 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). so like, no dsn = sandbox time, that's the deal 🦋

---

⭐ SEE ALSO ⭐

go click around, bestie, the whole ecosystem is right here:

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

---

💖 AUTHOR 💖

See DBIx::Class::Migration for author information — the receipts live over there 🫶

---

🌈 COPYRIGHT & LICENSE 🌈

See DBIx::Class::Migration for copyright and license information — same, all the legal bits are on that page 👑

---

and that's the whole page, no crumbs left 💅 this was rendered for ya by perl v5.42.0, dated 2020-06-03, and yeah, the footer knows it's DBIx::C...:prepare(3) — go prep those migrations, bestie, you're gonna slay 🦋✨🎀