.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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::Store::File::Multi 3pm"
.TH Catmandu::Store::File::Multi 3pm "2022-12-10" "perl v5.36.0" "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::Store::File::Multi \- A store that adds files to multiple stores
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    # On the Command line
\&
\&    # Configure the File::Multi store with a catmandu.yml file
\&    $ cat catmandu.yml
\&    \-\-\-
\&    store:
\&      files1:
\&       package: File::Simple
\&       options:
\&          root: /data1/files
\&      files1:
\&       package: File::Simple
\&       options:
\&          root: /data1/files_copy
\&      multi:
\&       package: File::Multi
\&       options:
\&           stores:
\&               \- files1
\&               \- files2
\&    ...
\&
\&    # List all the folder in the multi store as YAML
\&    $ catmandu export multi to YAML
\&
\&    # Add a file to the multi store with ID 7890 and stored name data.dat
\&    $ catmandu stream /tmp/data.dat to multi \-\-bag 7890 \-\-id data.dat
\&
\&    # Download a file from the multi store
\&    $ catmandu stream multi \-\-bag 7890 \-\-id data.dat
\&
\&    # In Perl
\&    use Catmandu;
\&
\&    my $store = Catmandu\->store(\*(AqFile::Multi\*(Aq , stores [
\&        Catmandu\->store(\*(AqSimple\*(Aq, root => \*(Aq/data1/files\*(Aq) ,
\&        Catmandu\->store(\*(AqSimple\*(Aq, root => \*(Aq/data1/files_copy\*(Aq) ,
\&    ]);
\&
\&    my $index = $store\->index;
\&
\&    $store\->index\->each(sub {
\&        my $item = shift;
\&        printf "%s\en" , $item\->{_id};
\&    });
\&
\&    # Add a folder to the multi store
\&    my $item = $store\->add({ _id => \*(Aq1234\*(Aq);
\&
\&    # Retrieve the folder bag
\&    my $files = $store\->files(1234);
\&
\&    # Listing of all files
\&    $files\->each(sub {
\&        my $file = shift;
\&
\&        my $name         = $file\->_id;
\&        my $size         = $file\->size;
\&        my $content_type = $file\->content_type;
\&        my $created      = $file\->created;
\&        my $modified     = $file\->modified;
\&
\&        $file\->stream(IO::File\->new(">/tmp/$name"), file);
\&    });
\&
\&    # Add a new file
\&    $files\->upload(IO::File\->new("</tmp/data.dat"),"data.dat");
\&
\&    # Retrieve a file
\&    my $file = $files\->get(\*(Aqdata.dat\*(Aq);
\&
\&    # Stream the file to an IO::Handle
\&    $container\->stream(IO::File\->new(">/tmp/data.dat"),$file);
\&
\&    # This will delete the folder and files
\&    $index\->delete(\*(Aq1234\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Catmandu::Store::File::Multi is a combination of many Catmandu::FileStore\-s
as one access point. The Multi store inherits all the methods
from Catmandu::FileStore.
.PP
By default, the Multi store tries to update records in all configured backend
stores. Importing, exporting, delete and drop will be executed against
all backend stores when possible.
.SH "METHODS"
.IX Header "METHODS"
.SS "new(stores => [...])"
.IX Subsection "new(stores => [...])"
Create a new Catmandu::Store::File::Multi. The \f(CW\*(C`stores\*(C'\fR configuration parameter contains an array of references to
Catmandu::FileStore\-s based on their name in a configuration file or instances.
.SH "INHERITED METHODS"
.IX Header "INHERITED METHODS"
This Catmandu::FileStore implements:
.IP "Catmandu::FileStore" 3
.IX Item "Catmandu::FileStore"
.PD 0
.IP "Catmandu::Droppable" 3
.IX Item "Catmandu::Droppable"
.PD
.PP
The index Catmandu::Bag in this Catmandu::Store implements:
.IP "Catmandu::Bag" 3
.IX Item "Catmandu::Bag"
.PD 0
.IP "Catmandu::FileBag::Index" 3
.IX Item "Catmandu::FileBag::Index"
.IP "Catmandu::Droppable" 3
.IX Item "Catmandu::Droppable"
.PD
.PP
The file Catmandu::Bag in this Catmandu::Store implements:
.IP "Catmandu::Bag" 3
.IX Item "Catmandu::Bag"
.PD 0
.IP "Catmandu::FileBag" 3
.IX Item "Catmandu::FileBag"
.IP "Catmandu::Droppable" 3
.IX Item "Catmandu::Droppable"
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catmandu::Store::File::Multi::Index,
Catmandu::Store::File::Multi::Bag,
Catmandu::Store::Multi ,
Catmandu::Plugin::SideCar