WIKI-TO...SETUPDB(1)

📦
version 0.87 · 2 versions
, in fedora 43

💖 WIKI-TO...SETUPDB 💖

okay so bestie, this is wiki-toolkit-setupdb, straight outta the User Contributed Perl Documentation section (section 1, the command-y one, iykyk). It sets up a database storage backend for Wiki::Toolkit. that's the whole vibe. let's get into it 💅

✨ NAME ✨

wiki-toolkit-setupdb — set up a database storage backend for Wiki::Toolkit. literally its whole job, no notes 🎀

🌸 SYNOPSIS 🌸

the "don't touch my data, I'm just upgrading" route: sets up or updates the storage backend and leaves any existing data intact. this is the one you want when you're upgrading from old versions of Wiki::Toolkit to newer ones with more backend features. so useful. so iconic.

# 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'

the "nuke it and start fresh" route: clears out any existing data and sets up a brand new backend from scratch. scorched earth. main character energy.

# 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

🦋 DESCRIPTION 🦋

So this script takes three mandatory arguments (yes, mandatory, like, you actually have to give these, no skipping 🙈):

  • type — the database type. should be one of 'postgres', 'mysql' and 'sqlite'. those are the options, pick one 💫
  • name — the database name.
  • user — the user that connects to the database. heads up though: it must have permission to create and drop tables in the database. no permission, no tables, no wiki. periodt.

Then there are two optional arguments (these ones you can ghost if you want):

  • pass — the user's database password.
  • host — the hostname of the machine the database server is running on. omit it for local databases, it's giving "I live here anyway" 🏠

And 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 so real talk: --force-preclear will clear out existing data first. that's data. gone. be sure bestie 💀

👑 AUTHOR 👑

Kake Pugh (kake@earth.li). an absolute legend, we stan 🫶

     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, open source 💖

💜 SEE ALSO 💜

  • Wiki::Toolkit — the whole reason we're here, go read it, it's the moment ⭐

and that's the tea, bestie 🍓 this was page WIKI-TO...SETUPDB(1) from perl v5.42.0, dated 2025-07-25. go set up that backend, you got this 🧚✨

📦 where this page comes from