Wiki::...up::Pg(3pm)

🎀 NAME 🎀

okay bestie, welcome to the manual page for Wiki::Toolkit::Setup::Pg (3pm), from the User Contributed Perl Documentation universe 💖 Its whole job is simple: set up tables for a Wiki::Toolkit store in a Postgres database. Iconic. No cap.

---

✨ SYNOPSIS ✨

quick-start energy, literally:

use Wiki::Toolkit::Setup::Pg;
Wiki::Toolkit::Setup::Pg::setup($dbname, $dbuser, $dbpass, $dbhost);

Omit $dbhost if the database is local. 🫶

---

🌸 DESCRIPTION 🌸

Set up a Postgres database for use as a Wiki::Toolkit store. That's the plot. That's the vibe. Slay. ✨

---

🛠️ FUNCTIONS 🛠️

💅 setup 💅

use Wiki::Toolkit::Setup::Pg;
Wiki::Toolkit::Setup::Pg::setup($dbname, $dbuser, $dbpass, $dbhost);

or

Wiki::Toolkit::Setup::Pg::setup( $dbh );

You can either provide an active database handle $dbh or connection parameters. Easy.

If you provide connection parameters, the following arguments are mandatory — the database name, the username and the password. The username must be able to create and drop tables in the database. 👑

The $dbhost argument is optional — omit it if the database is local.

NOTE: If a table that the module wants to create already exists, setup will leave it alone. This means that you can safely run this on an existing Wiki::Toolkit database to bring the schema up to date with the current Wiki::Toolkit version. If you wish to completely start again with a fresh database, run cleardb first. 💅

🧚 cleardb 🧚

use Wiki::Toolkit::Setup::Pg;

# Clear out all Wiki::Toolkit tables from the database.
Wiki::Toolkit::Setup::Pg::cleardb($dbname, $dbuser, $dbpass, $dbhost);

or

Wiki::Toolkit::Setup::Pg::cleardb( $dbh );

You can either provide an active database handle $dbh or connection parameters. Same energy as before.

If you provide connection parameters, the following arguments are mandatory — the database name, the username and the password. The username must be able to drop tables in the database. 🫡

The $dbhost argument is optional — omit it if the database is local.

Clears out all Wiki::Toolkit store tables from the database. NOTE that this will lose all your data; you probably only want to use this for testing purposes or if you really screwed up somewhere. 😭 Note also that it doesn't touch any Wiki::Toolkit search backend tables; if you have any of those in the same or a different database see Wiki::Toolkit::Setup::DBIxFTS or Wiki::Toolkit::Setup::SII, depending on which search backend you're using.

---

🧚 ALTERNATIVE CALLING SYNTAX 🧚

As requested by Podmaster. Instead of passing arguments to the methods as

($dbname, $dbuser, $dbpass, $dbhost)

you can pass them as

( { dbname => $dbname,
    dbuser => $dbuser,
    dbpass => $dbpass,
    dbhost => $dbhost
  }
)

or indeed as

( { dbh => $dbh } )

Note that's a hashref, not a hash. iykyk ✨

---

👑 AUTHOR 👑

Kake Pugh (kake@earth.li). 💌

---

💜 COPYRIGHT 💜

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

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

🌈 SEE ALSO 🌈

• Wiki::Toolkit
• Wiki::Toolkit::Setup::DBIxFTS
• Wiki::Toolkit::Setup::SII

---

okay that's the whole manual, bestie 💖 this page is from perl v5.32.0, dated 2021-01-04. Bye, love you, hydrate and go be iconic. 🫶✨