DBIx::C...t::Help(3)

πŸ“¦ version 0.075, in opensuse-leap 16.0

πŸ’… DBIx::Class::Migration::Script::Help(3) β€” aka the dbic-migration cheat sheet, bestie edition πŸŽ€

okay so this page is literally the handbook for DBIx::Class::Migration::Script::Help β€” it's the summary of all the commands, and honestly? iconic. it's giving "table of contents but make it cute." every command, every option, every flag is down below, no cap, nothing skipped ✨


🌸 NAME 🌸

DBIx::Class::Migration::Script::Help β€” the summary of the commands, periodt πŸ’–


πŸ¦‹ USAGE πŸ¦‹

dbic-migration [options] Command

πŸ‘‘ COMMANDS πŸ‘‘

so here's the rundown of everything that's available, bestie β€” read it and weep (with joy) 😭

πŸŽ€ Informational Commands

  • help β€” the tl;dr of the commandline help 🌸
  • help [word] β€” the detailed help for [command] or [option], i.e. the deep dive you actually want πŸ’…
  • version β€” tells you which version of DBIx::Class::Migration you're running rn ⭐
  • status β€” the current database and schema version, your vibe check for the DB πŸ¦‹

πŸ”₯ Preparing and using Migrations

  • prepare β€” makes deployment files for your schema_class ✨
  • install β€” installs a version into the database βœ…
  • upgrade β€” upgrades the database, we love a glow-up πŸ’–
  • downgrade β€” downgrades the database, going back, no shame 🫢
  • install_if_needed β€” installs the database if it's not installed already (if it is installed, it just... doesn't, lowkey efficient) πŸ™ˆ
  • install_version_storage β€” populates the DBIC:DH metadata tables πŸ‘‘

🧚 Commands for working with Fixtures

  • dump_named_sets β€” creates fixture sets for the named sets πŸ“
  • dump_all_sets β€” dumps all available fxture sets 🌈
  • populate β€” deploys the current database from fixtures 🌸

πŸ’€ Utility Commands

  • drop_tables β€” drops all tables in the target database. CAREFUL! like, for real, be careful, this is the main character of destructive commands 😭
  • delete_table_rows β€” truncates all the tables (no data, keep structure) β€” empty out the data but leave the structure standing, bestie πŸ’…
  • make_schema β€” reverse engineers your database into DBIx::Class πŸ”„
  • diagram β€” creates an image schematic of your schema, so you can look at it, we love a visual 🎨

⭐ Command options

  • include / include/s (I, lib/s) β€” adds the listed paths to @INC
  • schema_class (S) β€” the DBIx::Class::Schema subclass you are migrating
  • target_dir (D) β€” where to put (or find) your migration files
  • sandbox_dir β€” specify an alternative path for your database sandbox
  • username (U) β€” the username, the name says it all, no blurb provided πŸ™ˆ
  • password (P) β€” the password, again, no blurb, it's literally just this πŸ’€
  • dsn β€” connection info to the database you are migrating
  • force_overwrite (O) β€” allows overwriting of existing migration files
  • to_version (V) β€” use the given migration version
  • database / database/s β€” the type of database we are preparing migrations for
  • fixture_set / fixture_set/s β€” controls the fixture sets used for dumping or populating
  • sandbox_class (T) β€” makes any of SqliteSandbox, MySQLSandbox, PostgresqlSandbox
  • dbic_fixture_class β€” names an alternative subclass of DBIx::Class::Fixtures
  • dbic_connect_attrs β€” passes custom args to DBIx::Class::Schema->connect
  • dbi_connect_attrs β€” passes custom args to DBI via DBIx::Class::Schema->connect
  • extra_schemaloader_args β€” passes custom args to DBIx::Class::Migration::SchemaLoader
  • dbic_fixtures_extra_args β€” passes custom args to DBIx::Class::Fixtures

✨ EXAMPLE ✨

here's one to screenshot and keep, bestie 🫢

dbic-migration status \
  --libs="lib" \
  --schema_class='MyApp::Schema' \
  --dsn='DBI:SQLite:myapp.db'

🌈 SEE ALSO 🌈

go off, read these next:

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

πŸ’œ AUTHOR πŸ’œ

see DBIx::Class::Migration for author information πŸ‘‘


see DBIx::Class::Migration for copyright and license information πŸ’–


and that's the whole page, bestie β€” perl v5.42.0, dated 2020-06-03, so this manual page is a lil vintage but she still ate πŸ’…βœ¨ bye mwah 🫢

πŸ“¦ where this page comes from