view release on metacpan or  search on metacpan

lib/Data/AnyXfer/Elastic/Import/Storage/Directory.pm  view on Meta::CPAN

Optional. The final target directory that data should be persisted to.

=item B<working_dir>

Optional. The temporary directory data should be written to as operations are performed
on this instance.

=item B<item_file_suffix>

Optional. A string that will be appended to the end of every item name transparently
when written to storage (will not be visible through the storage interface).

You can also use this for file extensions.

=item B<item_file_prefix>

Optional. A string that will be prepended to the start of every item name transparently
when written to storage (will not be visible through the storage interface).

=back

=head1 STORAGE INTERFACE

B<Please see L<Data::AnyXfer::Elastic::Import::Storage> for the
interface definition and information>.

=cut

lib/Data/AnyXfer/Elastic/Import/Storage/Directory.pm  view on Meta::CPAN

=head2 convert_item_name

    my $item =
        $self->convert_item_name('some_random_string_with_unknown_chars');

Converts an arbritrary string to a format safe to be used by this storage
backend as an item name.

This is not necessary on storage interface methods as this is handled
transparently for you.

=head3 CAVEATS

This convertion is most likely one-way (lossy). Because of the normalisation,
different strings can point to the same item,
e.g. 'some_string' and 'some-string' are considered the same item.

=cut

sub convert_item_name {