ALEMBIC(1)

πŸ“¦ version 1.7.5, in centos-stream 9

πŸ’… ALEMBIC(1) β€” the girl's guide to alembic

okay so this is the manual page for alembic version 1.7.5, and it lives in the User Commands section of the manual (that's the 1 in the corner, iykyk). bestie, this is the whole thing, nothing skipped, let's go πŸ¦‹


✨ NAME ✨

alembic β€” literally the manual page for alembic 1.7.5. that's the vibe. periodt.


🌸 DESCRIPTION 🌸

here's how you call it, exactly like this:

-c [-h] [--version] [-c CONFIG] [-n NAME] [-x X] [--raiseerr]

              {branches,current,downgrade,edit,heads,history,init,list_templates,merge,revision,show,stamp,upgrade}
              ...

so cute, so structured. πŸ’–

πŸŽ€ positional arguments:

  • {branches,current,downgrade,edit,heads,history,init,list_templates,merge,revision,show,stamp,upgrade} β€” your whole menu of moves, one of these is the thing you actually want to do:
  • branches β€” shows you the current branch points. like a lil map of where the timelines split πŸ‘‘
  • current β€” displays the current revision for a database. your "you are here" sticker πŸ“
  • downgrade β€” reverts to a previous version. going backwards, no cap, sometimes necessary 😭
  • edit β€” edits revision script(s) using $EDITOR. it opens your editor, whoever your $EDITOR is, iconic behaviour ✨
  • heads β€” shows the current available heads in the script directory. so you know what's out there 🧚
  • history β€” lists changeset scripts in chronological order. the lore, in order 🌈
  • init β€” initializes a new scripts directory. the actual beginning of everything πŸŽ€
  • list_templates β€” lists the available templates. window-shopping but productive πŸ›οΈ
  • merge β€” merges two revisions together, and creates a new migration file while it's at it. main character energy πŸ”₯
  • revision β€” creates a new revision file. fresh file, fresh start ⭐
  • show β€” shows the revision(s) denoted by the given symbol. πŸ’…
  • stamp β€” "stamps" the revision table with the given revision, and doesn't run any migrations. it's marking, not moving β€” do not confuse these 😀
  • upgrade β€” upgrades to a later version. onwards and upwards bestie πŸ¦‹

πŸ’œ optional arguments:

  • -h, --help β€” shows this help message and exits. the classic escape hatch πŸ™ˆ
  • --version β€” shows the program's version number and exits. for when you need receipts 🧾
  • -c CONFIG, --config CONFIG β€” alternate config file; defaults to the value of the ALEMBIC_CONFIG environment variable, or to "alembic.ini". yes, that's the default order of business, don't @ me πŸ’€
  • -n NAME, --name NAME β€” name of the section in the .ini file to use for the Alembic config. picking your section, very demure πŸŽ€
  • -x X β€” additional arguments consumed by custom env.py scripts, e.g. -x setting1=somesetting -x setting2=somesetting. pass it along, let the custom scripts have their little treats πŸ“
  • --raiseerr β€” raises a full stack trace on error. when you want the whole dramatic story 😭πŸ”₯
ngl, that's the entire page β€” every flag, every command, every default, all accounted for. nothing left on read πŸ’–

and that's a wrap, bestie 🫢 this page is alembic 1.7.5, dated June 2022, and it answers to the name ALEMBIC(1). slay, go migrate something responsibly πŸ‘‘βœ¨

πŸ“¦ where this page comes from