--- nfo/perl/libs/Data/Storage.pm 2002/12/07 03:37:23 1.10 +++ nfo/perl/libs/Data/Storage.pm 2002/12/12 02:50:15 1.12 @@ -1,4 +1,4 @@ -# $Id: Storage.pm,v 1.10 2002/12/07 03:37:23 joko Exp $ +# $Id: Storage.pm,v 1.12 2002/12/12 02:50:15 joko Exp $ # # Copyright (c) 2002 Andreas Motl # @@ -7,6 +7,13 @@ ############################################ # # $Log: Storage.pm,v $ +# Revision 1.12 2002/12/12 02:50:15 joko +# + this now (unfortunately) needs DBI for some helper functions +# + TODO: these have to be refactored to another scope! (soon!) +# +# Revision 1.11 2002/12/11 06:53:19 joko +# + updated pod +# # Revision 1.10 2002/12/07 03:37:23 joko # + updated pod # @@ -53,7 +60,7 @@ =head1 NAME -Data::Storage - Interface for accessing various Storage implementations for Perl in an independent way + Data::Storage - Interface for accessing various Storage implementations for Perl in an independent way =head1 AIMS @@ -167,8 +174,8 @@ =head2 NOTE -This module heavily relies on DBI and Tangram, but adds a lot of additional bugs and quirks. -Please look at their documentation and/or this code for additional information. + This module heavily relies on DBI and Tangram, but adds a lot of additional bugs and quirks. + Please look at their documentation and/or this code for additional information. =head1 REQUIREMENTS @@ -196,6 +203,9 @@ use Data::Storage::Locator; use Data::Dumper; +# TODO: wipe out! +use DBI; + # TODO: actually implement level (integrate with Log::Dispatch) my $TRACELEVEL = 0; @@ -361,6 +371,19 @@ return $database_name; } +sub testAvailability { + my $self = shift; + my $status = $self->testDsn(); + $self->{locator}->{status}->{available} = $status; + return $status; +} + +sub isConnected { + my $self = shift; + # TODO: REVIEW! + return 1 if $self->{STORAGEHANDLE}; +} + sub testDsn { my $self = shift; my $dsn = $self->{locator}->{dbi}->{dsn}; @@ -378,14 +401,6 @@ } } -sub testAvailability { - my $self = shift; - my $status = $self->testDsn(); - $self->{locator}->{status}->{available} = $status; - return $status; -} - - sub dropDb { my $self = shift; my $dsn = $self->{locator}->{dbi}->{dsn}; @@ -413,40 +428,53 @@ return $ok; } -sub isConnected { - my $self = shift; - return 1 if $self->{STORAGEHANDLE}; -} - 1; __END__ =head1 DESCRIPTION -Data::Storage is a module for accessing various "data structures" stored inside -various "data containers". It sits on top of DBI and/or Tangram. +=head2 Data::Storage + Data::Storage is a module for accessing various "data structures / kinds of structured data" stored inside + various "data containers". + We tried to use the AdapterPattern (http://c2.com/cgi/wiki?AdapterPattern) to implement a wrapper-layer + around core CPAN modules (Tangram, DBI). + +=head2 Why? + + You will get a better code-structure (not bad for later maintenance) in growing Perl code projects, + especially when using multiple database connections at the same time. + You will be able to switch between different _kinds_ of implementations used for storing data. + Your code will use the very same API to access these storage layers. + ... implementation has to be changed for now + Maybe you will be able to switch "on-the-fly" without changing any bits in code in the future.... + ... but that's not the focus -=head1 AUTHORS / COPYRIGHT +=head2 What else? + + Having this, we were able to do implement a generic data synchronization module more easy, + please look at Data::Transfer. -The Data::Storage module is Copyright (c) 2002 Andreas Motl. -All rights reserved. -You may distribute it under the terms of either the GNU General Public -License or the Artistic License, as specified in the Perl README file. +=head1 AUTHORS / COPYRIGHT + + The Data::Storage module is Copyright (c) 2002 Andreas Motl. + All rights reserved. + You may distribute it under the terms of either the GNU General Public + License or the Artistic License, as specified in the Perl README file. =head1 ACKNOWLEDGEMENTS -Larry Wall for Perl, Tim Bunce for DBI, Jean-Louis Leroy for Tangram and Set::Object, -Sam Vilain for Class::Tangram, Jochen Wiedmann and Jeff Zucker for DBD::CSV and related, -Adam Spiers for MySQL::Diff and all contributors. + Larry Wall for Perl, Tim Bunce for DBI, Jean-Louis Leroy for Tangram and Set::Object, + Sam Vilain for Class::Tangram, Jochen Wiedmann and Jeff Zucker for DBD::CSV & Co., + Adam Spiers for MySQL::Diff and all contributors. =head1 SUPPORT / WARRANTY -Data::Storage is free software. IT COMES WITHOUT WARRANTY OF ANY KIND. + Data::Storage is free software. IT COMES WITHOUT WARRANTY OF ANY KIND. =head1 TODO