.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Catmandu::FileStore 3pm" .TH Catmandu::FileStore 3pm "2020-05-22" "perl v5.30.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Catmandu::FileStore \- Namespace for packages that can make files persistent .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& # From the command line \& \& # Export a list of all file containers \& $ catmandu export File::Simple \-\-root t/data to YAML \& \& # Export a list of all files in container \*(Aq1234\*(Aq \& $ catmandu export File::Simple \-\-root t/data \-\-bag 1234 to YAML \& \& # Add a file to the container \*(Aq1234\*(Aq \& $ catmandu stream /tmp/myfile.txt to File::Simple \-\-root t/data \-\-bag 1234 \-\-id myfile.txt \& \& # Download the file \*(Aqmyfile.txt\*(Aq from the container \*(Aq1234\*(Aq \& $ catmandu stream File::Simple \-\-root t/data \-\-bag 1234 \-\-id myfile.txt to /tmp/output.txt \& \& # Delete the file \*(Aqmyfile.txt\*(Aq from the container \*(Aq1234\*(Aq \& $ catmandu delete File::Simple \-\-root t/data \-\-bag 1234 \-\-id myfile.txt \& \& # From Perl \& use Catmandu; \& \& my $store = Catmandu\->store(\*(AqFile::Simple\*(Aq , root => \*(Aqt/data\*(Aq); \& \& # List all containers \& $store\->index\->each(sub { \& my $container = shift; \& \& print "%s\en" , $container\->{_id}; \& }); \& \& # Add a new container \& $store\->index\->add({ _id => \*(Aq1234\*(Aq }); \& \& # Get the container \& my $files = $store\->index\->files(\*(Aq1234\*(Aq); \& \& # Add a file to the container \& $files\->upload(IO::File\->new(\*(Aqget(\*(Aqfoobar.txt\*(Aq); \& \& # Stream the contents of a file \& $files\->stream(IO::File\->new(\*(Aq>foobar.txt\*(Aq), $file); \& \& # Delete a file \& $files\->delete(\*(Aqfoobar.txt\*(Aq); \& \& # Delete a container \& $store\->index\->delete(\*(Aq1234\*(Aq); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Each Catmandu::FileStore is a Catmandu::Store and inherits all its methods, .PP A Catmandu::FileStore is package to store and retrieve binary content in an filesystem, memory or a network. A \f(CW\*(C`Catmandu::FileStore\*(C'\fR contains one or more \&\f(CW\*(C`Catmandu::FileBag\*(C'\fR which is a kind of folder. .PP Each \f(CW\*(C`Catmandu::FileBag\*(C'\fR contains one or more files. .PP One special \f(CW\*(C`Catmandu::FileBag\*(C'\fR is the \f(CW\*(C`index\*(C'\fR and contains the listing of all \f(CW\*(C`Catmandu::FileBag\*(C'\fR in the \f(CW\*(C`Catmandu::FileStore\*(C'\fR. .SH "CONFIGURATION" .IX Header "CONFIGURATION" .IP "index_bag" 4 .IX Item "index_bag" The name of the index bag to use when no bag name is give. The index bag is a bag containing a listing of all \f(CW\*(C`Catmandu::FileBag\*(C'\fR\-s in the Store. .Sp .Vb 1 \& my $index = $store\->index; \& \& $index\->each(sub { \& my $bag = shift; \& \& printf "%s\en" , $bag\->{_id}; \& }); .Ve .IP "index_class" 4 .IX Item "index_class" The default class implementation to use for an index of \f(CW\*(C`Catmandu::FileBag\*(C'\fR\-s. By default this is the \f(CW\*(C`Catmandu::FileStore\*(C'\fR implementation with '::Index' added. .SH "METHODS" .IX Header "METHODS" .SS "bag($name)" .IX Subsection "bag($name)" Create or retieve a bag with name \f(CW$name\fR. Returns a Catmandu::FileBag. .SS "index" .IX Subsection "index" Returns the index Catmandu::FileBag for the Catmandu::FileStore. .PP .Vb 1 \& my $index = $store\->index; \& \& # Add a new file container \& $index\->add({ _id => \*(Aq1234\*(Aq}); \& \& # Anf use it... \& my $container = $store\->bag(\*(Aq1234\*(Aq); \& \& $container\->upload(IO::File\->new(\*(Aqdata.txt\*(Aq) , \*(Aqdata.txt\*(Aq); .Ve .SS "log" .IX Subsection "log" Return the current logger. Can be used when creating your own Stores. .PP E.g. .PP .Vb 1 \& package Catmandu::Store::Hash; \& \& ... \& \& sub generator { \& my ($self) = @_; \& \& $self\->log\->debug("generating record"); \& ... \& } .Ve .PP See also: Catmandu for activating the logger in your main code. .SH "AUTHOR" .IX Header "AUTHOR" Patrick Hochstenbach, \f(CW\*(C`\*(C'\fR .PP Nicolas Steenlant, \f(CW\*(C`\*(C'\fR .PP Nicolas Franck, \f(CW\*(C`\*(C'\fR .SH "SEE ALSO" .IX Header "SEE ALSO" Catmandu::Store::File::Simple, Catmandu::Store::File::Memory, Catmandu::FileBag .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" This program is free software; you can redistribute it and/or modify it under the terms of either: the \s-1GNU\s0 General Public License as published by the Free Software Foundation; or the Artistic License. .PP See for more information.