NAME

String::Lookup::FlatFile - flush String::Lookup to flat files

SYNOPSIS

use String::Lookup;

tie my %lookup, 'String::Lookup',

  # standard persistent storage parameters
  storage => 'FlatFile', # store in a flate file
  tag     => $tag,       # name of flat file for this lookup hash
  fork    => 1,          # fork for each flush, default: no

  # parameters specific to 'FlatFile'
  dir     => $dir,       # directory in which flat files are stored

  # other parameters for String::Lookup
  ...
;

VERSION

This documentation describes version 0.01.

DESCRIPTION

This module is a class for providing persistent storage for lookup hashes, as provided by String::Lookup.

Please see the METHODS IN STORAGE MODULE section in String::Lookup for documentation on which methods this storage class provides.

ADDITIONAL PARAMETERS

The following additional parameters are provided by this storage class:

dir

tie my %lookup, 'String::Lookup',
  dir     => $dir,       # directory in which flat files are stored
;

Indicate the directory in which the lookup hash will be stored in flat files. Defaults to the content of the STRING_LOOKUP_FLATFILE_DIR environment variable. Must be specified either directly or indirectly with the environment variable.

REQUIRED MODULES

(none)

AUTHOR

Elizabeth Mattijsen

COPYRIGHT

Copyright (c) 2012 Elizabeth Mattijsen <liz@dijkmat.nl>. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.