NAME

CDB::TinyCDB::Wrapper - A wrapper around CDB::TinyCDB to try and make updating its files a little more transparent

VERSION

Version 0.03

SYNOPSIS

Quick summary of what the module does.

Perhaps a little code snippet.

    use CDB::TinyCDB::Wrapper;
    my $db = CDB::TinyCDB::Wrapper->new();
    ...

SUBROUTINES/METHODS

new

abandon

Indicates that whatever alterations were made should be thrown away when the file is closed.

close

Closes the CDB file, rebuilding the file reflecting any changes that were made.

del

Delete the key from the DB.

exists

Checks whether the key exists in the db

each

Iterates through the DB, returning tuples of ($key, $value) each time it's called.

_reset_each

Iterates through the DB, returning tuples of ($key, $value) each time it's called.

get

Retrieves the specified key from the DB. Returns 'undef' if the key doesn't exist.

keys

Retrieves the list of keys from the DB.

set

Sets the specified key to the specified value in the DB.

DESTROY

Called when the object is deleted or goes out of scope, it closes the file. This is just here for compatibility with versions < 0.3---all new development should explicitly call close, or risk potential issues if the data doesn't get GC'd immediately.

AUTHOR

Michael Alan Dorman, <mdorman at ironicdesign.com>

BUGS

Please report any bugs or feature requests to bug-cdb-tinycdb-overlay at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CDB-TinyCDB-Wrapper. 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 CDB::TinyCDB::Wrapper

You can also look for information at:

ACKNOWLEDGEMENTS

CDB::TinyCDB, without which this module would have no reason to exist

LICENSE AND COPYRIGHT

Copyright 2010 Michael Alan Dorman.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.