Dominic Hargreaves > Wiki-Toolkit-0.82 > Wiki::Toolkit::Setup::SQLite

Download:
Wiki-Toolkit-0.82.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Module Version: 0.10   Source   Latest Release: Wiki-Toolkit-0.84

NAME ^

Wiki::Toolkit::Setup::SQLite - Set up tables for a Wiki::Toolkit store in a SQLite database.

SYNOPSIS ^

  use Wiki::Toolkit::Setup::SQLite;
  Wiki::Toolkit::Setup::SQLite::setup( $dbfile );

DESCRIPTION ^

Set up a SQLite database for use as a Wiki::Toolkit store.

FUNCTIONS ^

setup
  use Wiki::Toolkit::Setup::SQLite;

  Wiki::Toolkit::Setup::SQLite::setup( $filename );

or

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

Takes one argument - either the name of the file that the SQLite database is stored in or an active database handle.

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.

An optional second argument may be passed specifying the schema version to use; this is ONLY intended to be used during unit testing and should not normally be specified.

cleardb
  use Wiki::Toolkit::Setup::SQLite;

  # Clear out all Wiki::Toolkit tables from the database.
  Wiki::Toolkit::Setup::SQLite::cleardb( $filename );

or

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

Takes one argument - either the name of the file that the SQLite database is stored in or an active database handle.

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

  ($filename)

you can pass them as

  ( { dbname => $filename } )

or indeed

  ( { dbh => $dbh } )

Note that's a hashref, not a hash.

AUTHOR ^

Kake Pugh (kake@earth.li).

COPYRIGHT ^

     Copyright (C) 2002-2004 Kake Pugh.  All Rights Reserved.
     Copyright (C) 2006-2009 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

syntax highlighting: