DBIx::C...:status(3)

✨ DBIx::C...:status(3) ✨

okay so bestie, this is the manual page for the status command from the DBIx::Class::Migration family — it's giving "schema detective" energy and honestly? iconic. 💅

---

🌸 NAME 🌸

DBIx::Class::Migration::Script::Help::status — Schema and Database Status. literally what it says on the tin, no cap. 🎀

---

🦋 SYNOPSIS 🦋

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

that's it. that's the whole vibe. run this and you're in business, bestie. ✨

---

💖 DESCRIPTION 💖

okay so what does this actually do? it returns the version of the deployed database (if it is deployed, like if it exists and everything) and the version of the current "schema". two versions, side by side, living their best lives. 🫶

you will use this command when you need to see if a database needs upgrading — like a vibe check for your DB — and to check on the results of your migrations. it's literally your migration gossip source. "did my migration work?" "what version are we on?" this command has the answers. 👑

---

🔥 OPTIONS 🔥

This command accepts the following options. You may learn more about each option by typing dbic-migration help OPTION — yes bestie, there's a help for the help. we love a self-aware king. 💀

Format is "canonical (@aliases)".

🌈 includes (I,lib,libs,include)

Optional! not required, it's giving "take it or leave it" energy.

Adds the listed paths to @INC. Handy during development when you want to use a development schema class — like when you're in your lab cooking up something new and you need perl to find it. 🧚

⭐ schema_class (S)

Accepts Str. Required. like, you cannot skip this one bestie, it's mandatory. 🙈

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". so specific. so structured. we stan a well-namespaced class. 💜

if the "schema_class" cannot be loaded, a hard exception will be thrown. like, thrown hard. no soft landing, no gentle nudge. it's giving dramatic exit. 😭

🎀 sandbox_class (T)

The developer sandbox database that we are reading status information from. it's your lil dev playground and this command is peeking in to see what's up. 🍓

🌸 username (U)

🌸 password (P)

🌸 dsn

Optional! again with the optional energy, we love choices.

Connection information for the database you are checking the status of. You will likely use this when in an enviroment above development and you are no longer using a database sandbox — like when you've graduated from sandbox life to real-deal production vibes. "dsn" is as defined in DBI. (yes, the typo "enviroment" is in the original bestie, we don't fix, we preserve. 💅)

🦋 target_dir (D)

Optional! (again!)

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 if you want your sandbox somewhere else, this is your moment. main character directory energy. 🔥

---

👑 SEE ALSO 👑

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

all the related reading, all the lore, all the connected universe. iykyk. 🌟

---

💜 AUTHOR 💜

See DBIx::Class::Migration for author information — the real ones are credited over there. 🫶

---

🌈 COPYRIGHT & LICENSE 🌈

See DBIx::Class::Migration for copyright and license information — all the legal bits live with the parent module. periodt. 💅

---

and that's the whole page bestie! this was perl v5.42.0, dated 2020-06-03 — vintage but still slaying. go check those database versions and live your best migration life. 🎀✨💖