Jason Felds > Games-Framework-RCP > Games::Framework::RCP::Setup

Download:
Games-Framework-RCP-0.04_01.tar.gz

Dependencies

Annotate this POD

Module Version: 0.12   Source  

NAME ^

Games::Framework::RCP::Setup - Get a connection and load quick defaults.

VERSION ^

0.12

SYNOPSIS ^

 use Games::Framework::RCP::Setup qw/login load_defaults/;
 my $schema = login($data_source, $username, $password, $options, $on_connect);
 load_defaults();
 
 # Do whatever you want with the schema.

DESCRIPTION ^

The Setup file contains the basics needed to connect and setup the database. It does not abstract away all of the functionality such as deploy(): it is up to the Game Master to actually deploy the database.

SUBROUTINES/METHODS ^

login

This function accepts the same parameters as the traditional DBI->connect. The advantage of using login over DBI->connect is that the schema object is returned right away.

get_schema

This function returns the current schema object.

load_defaults

This function loads the database with some initial data to help get a Game Master started on hosting.

load_custom

This function allows others to load table data quickly into the database without requiring access to other modules.

This may be removed in the future.

AUTHOR ^

Jason Felds, <wolfman.ncsu2000 at gmail.com>

BUGS AND LIMITATIONS ^

Please report any bugs or feature requests to bug-Games-Framework-RCP at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Games-Framework-RCP-Setup. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Games::Framework::RCP::Setup

You can also look for information at:

ACKNOWLEDGEMENTS ^

See Games::Framework::RCP for all acknowledgements.

LICENSE AND COPYRIGHT ^

Copyright 2009 Jason Felds, all rights reserved.

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

syntax highlighting: