David Cantrell > Data-Transactional-1.02 > Tie::Hash::Transactional

Download:
Data-Transactional-1.02.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Tie::Hash::Transactional - A hash with checkpoints and rollbacks

STATUS ^

This module is deprecated. Please use Data::Transactional instead.

SYNOPSIS ^

  use Tie::Hash::Transactional

  tie my %transact_hash, 'Tie::Hash::Transactional';
  %transact_hash = (
    good => 'perl',
    bad  => 'java',
    ugly => 'tcl'
  );

  tied(%transact_hash)->checkpoint();
  $transact_hash{indifferent} = 'C';

  # hmmm ... must avoid controversial sample code, so ...
  tied(%transact_hash)->rollback();

DESCRIPTION ^

This module implements a hash with RDBMS-like transactions. You can checkpoint the hash (that is, you can save its current state), and you can rollback the hash (restore it to the previous saved state). You can checkpoint and rollback multiple times, as checkpointed states are saved on a stack.

When tieing, a single named parameter is accepted. If you pass a true value for the nowarn parameter, the module will not emit warnings about it being deprecated.

METHODS ^

The following methods are available. Call them thus:

tied(%my_hash)->methodname();

checkpoint

Saves the current state of the hash onto the stack, so that it can be retrieved later.

commit

Discards all saved states from the stack. Why bother? Well, if your transactional hash contains a lot of data, then if you have a load of checkpoints on the stack, then it's going to consume a vast amount of memory - each state on the stack is just a copy of the hash as it was when you checkpointed. Once you are sure that your hash contains the data you want it to contain, and you no longer need any of the previous states, you can free a lot of memory of commiting.

rollback

Retrieve the last saved state from the stack. Any changes you have made since the last checkpoint are discarded. It is a fatal error to rollback with nothing on the stack.

BUGS ^

No support for anything other than scalars in the hash. You can store and retrieve references to data structures, but changes to their contents will not be transactional.

AUTHOR ^

David Cantrell <david@cantrell.org.uk>

COPYRIGHT ^

Copyright 2001, 2004 David Cantrell.

This module is licensed under the same terms as perl itself.

SEE ALSO ^

Tie::Hash(3)

syntax highlighting: