WIKI-TO...SETUPDB(1p)

✨ NAME ✨

wiki-toolkit-setupdb — bestie, this is the little script that sets up a database storage backend for Wiki::Toolkit. that's it, that's the job 💅

---

🎀 SYNOPSIS 🎀

okay so here's how you actually run it, copy-paste and all:

  # Set up or update the storage backend, leaving any existing data
  # intact. Useful for upgrading from old versions of Wiki::Toolkit to
  # newer ones with more backend features.

  wiki-toolkit-setupdb --type postgres
                       --name mywiki \
                       --user wiki  \
                       --pass wiki \
                       --host 'db.example.com'

  # Clear out any existing data and set up a fresh backend from scratch.

  wiki-toolkit-setupdb --type postgres
                       --name mywiki \
                       --user wiki  \
                       --pass wiki  \
                       --force-preclear

first one is the glow-up version — it keeps all your existing data and just brings the backend up to date. second one is the scorched-earth version 🔥 (more on that flag below, don't panic).

---

🌸 DESCRIPTION 🌸

so this script takes three mandatory arguments. mandatory. like, you cannot skip these, the script will simply not vibe with you:

• type — the database type, bestie. it should be one of 'postgres', 'mysql' and 'sqlite'. pick one. those are the options. that's the whole list.
• name — the database name. yep. the name of the database. iconic of it.
• user — the user that connects to the database. heads up though, this user must have permission to create and drop tables in the database 👑 no permission, no setup, it's giving locked out of your own house.

then there are two optional arguments, so like, you can bring them but you don't have to:

• pass — the user's database password. the secret little thing 🫶
• host — the hostname of the machine the database server is running on. and listen: omit this one for local databases. local? just leave it. she's right there. no need to announce it.

and finally, one optional flag:

• force-preclear — by default, this script will leave any existing data alone 🥰 it's polite like that. to force that to be cleared out first, pass the --force-preclear flag.

⚠️ okay real talk for one sec: --force-preclear means your existing data gets cleared out first. like, gone. that's literally what the name is telling you. if you have data you care about, do not pass this flag. the default behaviour is the safe one — it leaves existing data intact. periodt. 💀

---

💖 AUTHOR 💖

Kake Pugh (kake@earth.li). yes, that's the whole thing, we love a concise queen ✨

---

🦋 COPYRIGHT 🦋

     Copyright (C) 2002-2003 Kake Pugh.  All Rights Reserved.
     Copyright (C) 2006 the Wiki::Toolkit team. All Rights Reserved.

This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself. slay, free software, we stan 🌈

---

🌟 SEE ALSO 🌟

• Wiki::Toolkit — the main character. go read that one next, iykyk 💜

---

and that's the whole page, bestie 🎀 written up as part of the User Contributed Perl Documentation, sitting pretty at perl v5.32.0, dated 2021-01-04. go set up that database. you got this. 💅✨