View on
MetaCPAN
Stephen Quinney > BuzzSaw-0.12.0 > BuzzSaw::DB::Schema

Download:
BuzzSaw-0.12.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: v0.12.0   Source  

NAME ^

BuzzSaw::DB::Schema - The BuzzSaw database schema class

VERSION ^

This documentation refers to BuzzSaw::DB::Schema version 0.12.0

SYNOPSIS ^

   use BuzzSaw::DB::Schema;

   my $schema
        = BuzzSaw::DB::Schema->connect( $dsn, $user, $pass, \%opts );

DESCRIPTION ^

This module provides access to the DBIx::Class layer which is used to provide an interface to the BuzzSaw database.

The BuzzSaw project provides a suite of tools for processing log file entries. Entries in files are parsed and filtered into a set of events of interest which are stored in a database. A report generation framework is also available which makes it easy to generate regular reports regarding the events discovered.

SUBROUTINES/METHODS ^

This class has one method:

connect( $dsn, $user, $pass, \%options )

This takes the DBI Data Source Name (DSN) and, optionally, a username and password to be used for connecting to the database. It can also take a reference to a hash of options which control how the DBI layer functions. A schema object is returned, see DBIx::Class::Schema for details of the available methods for this object.

CONFIGURATION AND ENVIRONMENT ^

This class is not normally loaded directly, instead the BuzzSaw::DB module has support for retrieving the database configuration parameters from a configuration file, see that module for details.

DEPENDENCIES ^

This module requires DBIx::Class, you will also need a DBI driver module such as DBD::Pg.

SEE ALSO ^

BuzzSaw, BuzzSaw::DB

PLATFORMS ^

This is the list of platforms on which we have tested this software. We expect this software to work on any Unix-like platform which is supported by Perl.

ScientificLinux6

BUGS AND LIMITATIONS ^

Please report any bugs or problems (or praise!) to bugs@lcfg.org, feedback and patches are also always very welcome.

AUTHOR ^

    Stephen Quinney <squinney@inf.ed.ac.uk>

LICENSE AND COPYRIGHT ^

    Copyright (C) 2012 University of Edinburgh. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the terms of the GPL, version 2 or later.

syntax highlighting: