.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Wiki::Toolkit::Setup::SQLite 3pm"
.TH Wiki::Toolkit::Setup::SQLite 3pm "2016-12-31" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Wiki::Toolkit::Setup::SQLite \- Set up tables for a Wiki::Toolkit store in a SQLite database.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use Wiki::Toolkit::Setup::SQLite;
\&  Wiki::Toolkit::Setup::SQLite::setup( $dbfile );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Set up a SQLite database for use as a Wiki::Toolkit store.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "\fBsetup\fR" 4
.IX Item "setup"
.Vb 1
\&  use Wiki::Toolkit::Setup::SQLite;
\&
\&  Wiki::Toolkit::Setup::SQLite::setup( $filename );
.Ve
.Sp
or
.Sp
.Vb 1
\&  Wiki::Toolkit::Setup::SQLite::setup( $dbh );
.Ve
.Sp
Takes one argument \- \fBeither\fR the name of the file that the SQLite
database is stored in \fBor\fR an active database handle.
.Sp
\&\fB\s-1NOTE:\s0\fR If a table that the module wants to create already exists,
\&\f(CW\*(C`setup\*(C'\fR 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 \f(CW\*(C`cleardb\*(C'\fR first.
.Sp
An optional second argument may be passed specifying the schema version
to use; this is \fB\s-1ONLY\s0\fR intended to be used during unit testing and should
not normally be specified.
.IP "\fBcleardb\fR" 4
.IX Item "cleardb"
.Vb 1
\&  use Wiki::Toolkit::Setup::SQLite;
\&
\&  # Clear out all Wiki::Toolkit tables from the database.
\&  Wiki::Toolkit::Setup::SQLite::cleardb( $filename );
.Ve
.Sp
or
.Sp
.Vb 1
\&  Wiki::Toolkit::Setup::SQLite::cleardb( $dbh );
.Ve
.Sp
Takes one argument \- \fBeither\fR the name of the file that the SQLite
database is stored in \fBor\fR an active database handle.
.Sp
Clears out all Wiki::Toolkit store tables from the database. \fB\s-1NOTE\s0\fR
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.
.SH "ALTERNATIVE CALLING SYNTAX"
.IX Header "ALTERNATIVE CALLING SYNTAX"
As requested by Podmaster.  Instead of passing arguments to the methods as
.PP
.Vb 1
\&  ($filename)
.Ve
.PP
you can pass them as
.PP
.Vb 1
\&  ( { dbname => $filename } )
.Ve
.PP
or indeed
.PP
.Vb 1
\&  ( { dbh => $dbh } )
.Ve
.PP
Note that's a hashref, not a hash.
.SH "AUTHOR"
.IX Header "AUTHOR"
Kake Pugh (kake@earth.li).
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 2
\&     Copyright (C) 2002\-2004 Kake Pugh.  All Rights Reserved.
\&     Copyright (C) 2006\-2009 the Wiki::Toolkit team. All Rights Reserved.
.Ve
.PP
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Wiki::Toolkit, Wiki::Toolkit::Setup::DBIxFTS, Wiki::Toolkit::Setup::SII