DBICADMIN(1p)

💖 DBICADMIN 💖

okay bestie, gather round, because today we're talking about dbicadmin — the utility for administrating DBIx::Class schemata. yes, that's really what it's called, and yes it's lowkey iconic. this is a perl manual page from the User Contributed Perl Documentation section, so you know it's giving real ones only. 💅

---

✨ SYNOPSIS ✨

the vibe is:

dbicadmin: [-I] [long options...]

and here's what that actually looks like when you're doing the thing 🫶

deploy a schema to a database

dbicadmin --schema=MyApp::Schema \
  --connect='["dbi:SQLite:my.db", "", ""]' \
  --deploy

update an existing record

dbicadmin --schema=MyApp::Schema --class=Employee \
  --connect='["dbi:SQLite:my.db", "", ""]' \
  --op=update --set='{ "name": "New_Employee" }'

see? not scary. we move. 🦋

---

🌸 OPTIONS 🌸

🎀 Actions

these are the what do you want to do buttons, bestie. pick your fighter.

• --create — create version diffs. heads up though: it needs preversion. no preversion, no diff, periodt.
• --upgrade — upgrade the database so it matches the current schema. glow-up but for your tables. ✨
• --install — install the schema version tables into a database that already exists.
• --deploy — deploy the schema to the database. the big one. main character energy. 👑
• --select — select data from the schema.
• --insert — insert data into the schema.
• --update — update data in the schema.
• --delete — delete data from the schema. (rip to that row fr 💀)
• --op — the compatibility option: literally all of the actions above can be handed over as --op=<action>. so instead of --update you can say --op=update and it's the same thing. iykyk.
• --help — display this help. the classic. when in doubt, ask for help, bestie. 💖

🧚 Arguments

the details. the lore. the little knobs and dials.

• --config-file or --config — supply the config file, which gets parsed by Config::Any.
• --connect-info — supply the connect info as trailing options, like this: --connect-info dsn=<dsn> user=<user> password=<pass>
• --connect — supply the connect info as a JSON-encoded structure, e.g. --connect=["dsn","user","pass"]
• --schema-class — the class of the schema you want to load.
• --config-stanza — where in the config to find the connection_info. supply it in the form MyApp::Model::DB.
• --resultset or --resultset-class or --class — the resultset to operate on for data manipulation. three names, one icon. 🌈
• --sql-dir — the directory where sql diffs will be created.
• --sql-type — the RDBMs flavour you wish to use. pick your flavour bestie 🍓
• --version — supply a version install.
• --preversion — the previous version to diff against. (remember --create wants this one!)
• --set — JSON data used to perform data operations.
• --attrs — JSON string to be used for the second argument for search.
• --where — JSON string to be used for the where clause of search.
• --force — be forceful with some operations. 😤 use with care, she's loud.
• --trace — turn on DBIx::Class trace output. for when you need to see everything.
• --quiet — be less verbose. shhh. 🤫
• -I — same as perl's -I, prepended to current @INC.

---

💜 AUTHORS 💜

see "AUTHORS" in DBIx::Class. the originators. the founders. we stan. 🫶

---

⭐ LICENSE ⭐

you may distribute this code under the same terms as Perl itself. slay, honestly.

---

💌 real talk bestie: this page came from perl v5.40.0, dated 2025-02-01, and it's filed under DBICADMIN(1p). go forth and administer those schemata. no cap. ✨🎀💖