/usr/lib/x86_64-linux-gnu/perl5/5.26/MongoDB/GridFSBucket.pm is in libmongodb-perl 1.8.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 | #
# Copyright 2009-2015 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
use strict;
use warnings;
package MongoDB::GridFSBucket;
# ABSTRACT: A file storage abstraction
use version;
our $VERSION = 'v1.8.1';
use Moo;
use MongoDB::GridFSBucket::DownloadStream;
use MongoDB::GridFSBucket::UploadStream;
use MongoDB::_Types qw(
ReadPreference
WriteConcern
ReadConcern
BSONCodec
NonNegNum
);
use Scalar::Util qw/reftype/;
use Types::Standard qw(
Bool
Int
Str
InstanceOf
);
use namespace::clean -except => 'meta';
#pod =attr database
#pod
#pod The L<MongoDB::Database> containing the GridFS bucket collections.
#pod
#pod =cut
has database => (
is => 'ro',
isa => InstanceOf ['MongoDB::Database'],
required => 1,
);
#pod =attr bucket_name
#pod
#pod The name of the GridFS bucket. Defaults to 'fs'. The underlying
#pod collections that are used to implement a GridFS bucket get this string as a
#pod prefix (e.g "fs.chunks").
#pod
#pod =cut
has bucket_name => (
is => 'ro',
isa => Str,
default => sub { 'fs' },
);
#pod =attr chunk_size_bytes
#pod
#pod The number of bytes per chunk. Defaults to 261120 (255kb).
#pod
#pod =cut
has chunk_size_bytes => (
is => 'ro',
isa => NonNegNum,
default => sub { 255 * 1024 },
);
#pod =attr write_concern
#pod
#pod A L<MongoDB::WriteConcern> object. It may be initialized with a hash
#pod reference that will be coerced into a new MongoDB::WriteConcern object.
#pod By default it will be inherited from a L<MongoDB::Database> object.
#pod
#pod =cut
has write_concern => (
is => 'ro',
isa => WriteConcern,
required => 1,
coerce => WriteConcern->coercion,
);
#pod =attr read_concern
#pod
#pod A L<MongoDB::ReadConcern> object. May be initialized with a hash
#pod reference or a string that will be coerced into the level of read
#pod concern.
#pod
#pod By default it will be inherited from a L<MongoDB::Database> object.
#pod
#pod =cut
has read_concern => (
is => 'ro',
isa => ReadConcern,
required => 1,
coerce => ReadConcern->coercion,
);
#pod =attr read_preference
#pod
#pod A L<MongoDB::ReadPreference> object. It may be initialized with a string
#pod corresponding to one of the valid read preference modes or a hash reference
#pod that will be coerced into a new MongoDB::ReadPreference object.
#pod By default it will be inherited from a L<MongoDB::Database> object.
#pod
#pod B<Note:> Because many GridFS operations require multiple independent reads from
#pod separate collections, use with secondaries is B<strongly discouraged> because
#pod reads could go to different secondaries, resulting in inconsistent data
#pod if all file and chunk documents have not replicated to all secondaries.
#pod
#pod =cut
has read_preference => (
is => 'ro',
isa => ReadPreference,
required => 1,
coerce => ReadPreference->coercion,
);
#pod =attr bson_codec
#pod
#pod An object that provides the C<encode_one> and C<decode_one> methods, such
#pod as from L<MongoDB::BSON>. It may be initialized with a hash reference that
#pod will be coerced into a new MongoDB::BSON object. By default it will be
#pod inherited from a L<MongoDB::Database> object.
#pod
#pod =cut
has bson_codec => (
is => 'ro',
isa => BSONCodec,
coerce => BSONCodec->coercion,
required => 1,
);
#pod =attr max_time_ms
#pod
#pod Specifies the maximum amount of time in milliseconds that the server should
#pod use for working on a query. By default it will be inherited from a
#pod L<MongoDB::Database> object.
#pod
#pod B<Note>: this will only be used for server versions 2.6 or greater, as that
#pod was when the C<$maxTimeMS> meta-operator was introduced.
#pod
#pod =cut
has max_time_ms => (
is => 'ro',
isa => NonNegNum,
required => 1,
);
# determines whether or not to attempt index creation
has _tried_indexing => (
is => 'rwp',
isa => Bool,
);
has _files => (
is => 'lazy',
isa => InstanceOf ['MongoDB::Collection'],
init_arg => undef,
);
sub _build__files {
my $self = shift;
my $coll = $self->database->get_collection(
$self->bucket_name . '.files',
{
read_preference => $self->read_preference,
write_concern => $self->write_concern,
read_concern => $self->read_concern,
max_time_ms => $self->max_time_ms,
bson_codec => $self->bson_codec,
}
);
return $coll;
}
has _chunks => (
is => 'lazy',
isa => InstanceOf ['MongoDB::Collection'],
init_arg => undef,
);
sub _build__chunks {
my $self = shift;
my $coll = $self->database->get_collection(
$self->bucket_name . '.chunks',
{
read_preference => $self->read_preference,
write_concern => $self->write_concern,
read_concern => $self->read_concern,
max_time_ms => $self->max_time_ms,
# XXX: Generate a new bson codec here to
# prevent users from changing it?
bson_codec => $self->bson_codec,
}
);
return $coll;
}
# index operations need primary server, regardless of bucket read prefs
sub _create_indexes {
my ($self) = @_;
$self->_set__tried_indexing(1);
my $pf = $self->_files->clone( read_preference => 'primary' );
return if $pf->count > 0;
my $pfi = $pf->indexes;
my $pci = $self->_chunks->clone( read_preference => 'primary' )->indexes;
if ( !grep { $_->{name} eq 'filename_1_uploadDate_1' } $pfi->list->all ) {
$pfi->create_one( [ filename => 1, uploadDate => 1 ], { unique => 1 } );
}
if ( !grep { $_->{name} eq 'files_id_1_n_1' } $pci->list->all ) {
$pci->create_one( [ files_id => 1, n => 1 ], { unique => 1 } );
}
return;
}
#pod =method find
#pod
#pod $result = $bucket->find($filter);
#pod $result = $bucket->find($filter, $options);
#pod
#pod $file_doc = $result->next;
#pod
#pod Executes a query on the file documents collection with a
#pod L<filter expression|MongoDB::Collection/Filter expression> and
#pod returns a L<MongoDB::QueryResult> object. It takes an optional hashref
#pod of options identical to L<MongoDB::Collection/find>.
#pod
#pod =cut
sub find {
my ( $self, $filter, $options ) = @_;
return $self->_files->find( $filter, $options )->result;
}
#pod =method find_one
#pod
#pod $file_doc = $bucket->find_one($filter, $projection);
#pod $file_doc = $bucket->find_one($filter, $projection, $options);
#pod
#pod Executes a query on the file documents collection with a
#pod L<filter expression|MongoDB::Collection/Filter expression> and
#pod returns the first document found, or C<undef> if no document is found.
#pod
#pod See L<MongoDB::Collection/find_one> for details about the
#pod C<$projection> and optional C<$options> fields.
#pod
#pod =cut
sub find_one {
my ( $self, $filter, $projection, $options ) = @_;
return $self->_files->find_one( $filter, $projection, $options );
}
#pod =method find_id
#pod
#pod $file_doc = $bucket->find_id( $id );
#pod $file_doc = $bucket->find_id( $id, $projection );
#pod $file_doc = $bucket->find_id( $id, $projection, $options );
#pod
#pod Executes a query with a L<filter expression|/Filter expression> of
#pod C<< { _id => $id } >> and returns a single document or C<undef> if no document
#pod is found.
#pod
#pod See L<MongoDB::Collection/find_one> for details about the
#pod C<$projection> and optional C<$options> fields.
#pod
#pod =cut
sub find_id {
my ( $self, $id, $projection, $options ) = @_;
return $self->_files->find_id( $id, $projection, $options );
}
#pod =method open_download_stream
#pod
#pod $stream = $bucket->open_download_stream($id);
#pod $line = $stream->readline;
#pod
#pod Returns a new L<MongoDB::GridFSBucket::DownloadStream> that can be used to
#pod download the file with the file document C<_id> matching C<$id>. This
#pod throws a L<MongoDB::GridFSError> if no such file exists.
#pod
#pod =cut
sub open_download_stream {
my ( $self, $id ) = @_;
MongoDB::UsageError->throw('No id provided to open_download_stream') unless $id;
my $file_doc = $self->_files->find_id($id);
MongoDB::GridFSError->throw("FileNotFound: no file found for id '$id'")
unless $file_doc;
my $result =
$file_doc->{'length'} > 0
? $self->_chunks->find( { files_id => $id }, { sort => { n => 1 } } )->result
: undef;
return MongoDB::GridFSBucket::DownloadStream->new(
{
id => $id,
file_doc => $file_doc,
_result => $result,
}
);
}
#pod =method open_upload_stream
#pod
#pod $stream = $bucket->open_upload_stream($filename);
#pod $stream = $bucket->open_upload_stream($filename, $options);
#pod
#pod $stream->print('data');
#pod $stream->close;
#pod $file_id = $stream->id
#pod
#pod Returns a new L<MongoDB::GridFSBucket::UploadStream> that can be used
#pod to upload a new file to a GridFS bucket.
#pod
#pod This method requires a filename to store in the C<filename> field of the
#pod file document. B<Note>: the filename is an arbitrary string; the method
#pod does not read from this filename locally.
#pod
#pod You can provide an optional hash reference of options that are passed to the
#pod L<MongoDB::GridFSBucket::UploadStream> constructor:
#pod
#pod =for :list
#pod * C<chunk_size_bytes> – the number of bytes per chunk. Defaults to the
#pod C<chunk_size_bytes> of the bucket object.
#pod * C<metadata> – a hash reference for storing arbitrary metadata about the
#pod file.
#pod
#pod =cut
sub open_upload_stream {
my ( $self, $filename, $options ) = @_;
MongoDB::UsageError->throw('No filename provided to open_upload_stream')
unless defined $filename && length $filename;
$self->_create_indexes unless $self->_tried_indexing;
return MongoDB::GridFSBucket::UploadStream->new(
{
chunk_size_bytes => $self->chunk_size_bytes,
( $options ? %$options : () ),
_bucket => $self,
filename => "$filename", # stringify path objects
}
);
}
#pod =method open_upload_stream_with_id
#pod
#pod $stream = $bucket->open_upload_stream_with_id($id, $filename);
#pod $stream = $bucket->open_upload_stream_with_id($id, $filename, $options);
#pod
#pod $stream->print('data');
#pod $stream->close;
#pod
#pod Returns a new L<MongoDB::GridFSBucket::UploadStream> that can be used to
#pod upload a new file to a GridFS bucket.
#pod
#pod This method uses C<$id> as the _id of the file being created, which must be
#pod unique.
#pod
#pod This method requires a filename to store in the C<filename> field of the
#pod file document. B<Note>: the filename is an arbitrary string; the method
#pod does not read from this filename locally.
#pod
#pod You can provide an optional hash reference of options, just like
#pod L</open_upload_stream>.
#pod
#pod =cut
sub open_upload_stream_with_id {
my ( $self, $id, $filename, $options ) = @_;
MongoDB::UsageError->throw('No id provided to open_upload_stream_with_id')
unless defined $id && length $id;
MongoDB::UsageError->throw('No filename provided to open_upload_stream_with_id')
unless defined $filename && length $filename;
$self->_create_indexes unless $self->_tried_indexing;
return MongoDB::GridFSBucket::UploadStream->new(
{
chunk_size_bytes => $self->chunk_size_bytes,
( $options ? %$options : () ),
_bucket => $self,
filename => "$filename", # stringify path objects
id => $id,
}
);
}
#pod =method download_to_stream
#pod
#pod $bucket->download_to_stream($id, $out_fh);
#pod
#pod Downloads the file matching C<$id> and writes it to the file handle C<$out_fh>.
#pod This throws a L<MongoDB::GridFSError> if no such file exists.
#pod
#pod =cut
sub download_to_stream {
my ( $self, $id, $target_fh ) = @_;
MongoDB::UsageError->throw('No id provided to download_to_stream')
unless defined $id;
MongoDB::UsageError->throw('No handle provided to download_to_stream')
unless defined $target_fh;
MongoDB::UsageError->throw(
'Invalid handle $target_fh provided to download_to_stream')
unless reftype $target_fh eq 'GLOB';
my $download_stream = $self->open_download_stream($id);
my $csb = $download_stream->file_doc->{chunkSize};
my $buffer;
while ( $download_stream->read( $buffer, $csb ) ) {
print {$target_fh} $buffer;
}
$download_stream->close;
return;
}
#pod =method upload_from_stream
#pod
#pod $file_id = $bucket->upload_from_stream($filename, $in_fh);
#pod $file_id = $bucket->upload_from_stream($filename, $in_fh, $options);
#pod
#pod Reads from a filehandle and uploads its contents to GridFS. It returns the
#pod C<_id> field stored in the file document.
#pod
#pod This method requires a filename to store in the C<filename> field of the
#pod file document. B<Note>: the filename is an arbitrary string; the method
#pod does not read from this filename locally.
#pod
#pod You can provide an optional hash reference of options, just like
#pod L</open_upload_stream>.
#pod
#pod =cut
sub upload_from_stream {
my ( $self, $filename, $source_fh, $options ) = @_;
MongoDB::UsageError->throw('No filename provided to upload_from_stream')
unless defined $filename && length $filename;
MongoDB::UsageError->throw('No handle provided to upload_from_stream')
unless defined $source_fh;
MongoDB::UsageError->throw(
'Invalid handle $source_fh provided to upload_from_stream')
unless reftype $source_fh eq 'GLOB';
my $upload_stream = $self->open_upload_stream( $filename, $options );
my $csb = $upload_stream->chunk_size_bytes;
my $buffer;
while ( read $source_fh, $buffer, $csb ) {
$upload_stream->print($buffer);
}
$upload_stream->close;
return $upload_stream->id;
}
#pod =method upload_from_stream_with_id
#pod
#pod $bucket->upload_from_stream_with_id($id, $filename, $in_fh);
#pod $bucket->upload_from_stream_with_id($id, $filename, $in_fh, $options);
#pod
#pod Reads from a filehandle and uploads its contents to GridFS.
#pod
#pod This method uses C<$id> as the _id of the file being created, which must be
#pod unique.
#pod
#pod This method requires a filename to store in the C<filename> field of the
#pod file document. B<Note>: the filename is an arbitrary string; the method
#pod does not read from this filename locally.
#pod
#pod You can provide an optional hash reference of options, just like
#pod L</open_upload_stream>.
#pod
#pod Unlike L</open_upload_stream>, this method returns nothing.
#pod
#pod =cut
sub upload_from_stream_with_id {
my ( $self, $id, $filename, $source_fh, $options ) = @_;
MongoDB::UsageError->throw('No id provided to upload_from_stream_with_id')
unless defined $id && length $id;
MongoDB::UsageError->throw('No filename provided to upload_from_stream_with_id')
unless defined $filename && length $filename;
MongoDB::UsageError->throw('No handle provided to upload_from_stream_with_id')
unless defined $source_fh;
MongoDB::UsageError->throw(
'Invalid handle $source_fh provided to upload_from_stream_with_id')
unless reftype $source_fh eq 'GLOB';
my $upload_stream = $self->open_upload_stream_with_id( $id, $filename, $options );
my $csb = $upload_stream->chunk_size_bytes;
my $buffer;
while ( read $source_fh, $buffer, $csb ) {
$upload_stream->print($buffer);
}
$upload_stream->close;
return;
}
#pod =method delete
#pod
#pod $bucket->delete($id);
#pod
#pod Deletes the file matching C<$id> from the bucket.
#pod This throws a L<MongoDB::GridFSError> if no such file exists.
#pod
#pod =cut
sub delete {
my ( $self, $id ) = @_;
$self->_create_indexes unless $self->_tried_indexing;
my $delete_result = $self->_files->delete_one( { _id => $id } );
# This should only ever be 0 or 1, checking for exactly 1 to be thorough
unless ( $delete_result->deleted_count == 1 ) {
MongoDB::GridFSError->throw("FileNotFound: no file found for id $id");
}
$self->_chunks->delete_many( { files_id => $id } );
return;
}
#pod =method drop
#pod
#pod $bucket->drop;
#pod
#pod Drops the underlying files documents and chunks collections for this bucket.
#pod
#pod =cut
sub drop {
my ($self) = @_;
$self->_files->drop;
$self->_chunks->drop;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
MongoDB::GridFSBucket - A file storage abstraction
=head1 VERSION
version v1.8.1
=head1 SYNOPSIS
$bucket = $database->gfs;
# upload a file
$stream = $bucket->open_upload_stream("foo.txt");
$stream->print( $data );
$stream->close;
# find and download a file
$result = $bucket-find({filename => "foo.txt"});
$file_id = $result->next->{_id};
$stream = $bucket->open_download_stream($file_id)
$data = do { local $/; $stream->readline() };
=head1 DESCRIPTION
This class models a GridFS file store in a MongoDB database and provides an
API for interacting with it.
Generally, you never construct one of these directly with C<new>. Instead,
you call C<gfs> (short for C<get_gridfsbucket>) on a L<MongoDB::Database>
object.
=head1 USAGE
=head2 Data model
A GridFS file is represented in MongoDB as a "file document" with
information like the file's name, length, MD5 hash, and any user-supplied
metadata. The actual contents are stored as a number of "chunks" of binary
data. (Think of the file document as a directory entry and the chunks like
blocks on disk.)
Valid file documents typically include the following fields:
=over 4
=item *
_id – a unique ID for this document, typically type BSON ObjectId.
=item *
length – the length of this stored file, in bytes
=item *
chunkSize – the size, in bytes, of each full data chunk of this file. This value is configurable per file.
=item *
uploadDate – the date and time this file was added to GridFS, stored as a BSON datetime value.
=item *
md5 – a hash of the contents of the stored file
=item *
filename – the name of this stored file; the combination of filename and uploadDate (millisecond resolution) must be unique
=item *
metadata – any additional application data the user wishes to store (optional)
=item *
contentType – DEPRECATED (store this in C<metadata> if you need it) (optional)
=item *
aliases – DEPRECATED (store this in C<metadata> if you need it) (optional)
=back
The C<find> method searches file documents using these fields. Given the
C<_id> from a document, a file can be downloaded using the download
methods.
=head2 API Overview
In addition to general methods like C<find>, C<delete> and C<drop>, there
are two ways to go about uploading and downloading:
=over 4
=item *
filehandle-like: you get an object that you can read/write from similar to a filehandle. You can even get a tied filehandle that you can hand off to other code that requires an actual Perl handle.
=item *
streaming: you provide a file handle to read from (upload) or print to (download) and data is streamed to (upload) or from (download) GridFS until EOF.
=back
=head2 Error handling
Unless otherwise explicitly documented, all methods throw exceptions if
an error occurs. The error types are documented in L<MongoDB::Error>.
=head1 ATTRIBUTES
=head2 database
The L<MongoDB::Database> containing the GridFS bucket collections.
=head2 bucket_name
The name of the GridFS bucket. Defaults to 'fs'. The underlying
collections that are used to implement a GridFS bucket get this string as a
prefix (e.g "fs.chunks").
=head2 chunk_size_bytes
The number of bytes per chunk. Defaults to 261120 (255kb).
=head2 write_concern
A L<MongoDB::WriteConcern> object. It may be initialized with a hash
reference that will be coerced into a new MongoDB::WriteConcern object.
By default it will be inherited from a L<MongoDB::Database> object.
=head2 read_concern
A L<MongoDB::ReadConcern> object. May be initialized with a hash
reference or a string that will be coerced into the level of read
concern.
By default it will be inherited from a L<MongoDB::Database> object.
=head2 read_preference
A L<MongoDB::ReadPreference> object. It may be initialized with a string
corresponding to one of the valid read preference modes or a hash reference
that will be coerced into a new MongoDB::ReadPreference object.
By default it will be inherited from a L<MongoDB::Database> object.
B<Note:> Because many GridFS operations require multiple independent reads from
separate collections, use with secondaries is B<strongly discouraged> because
reads could go to different secondaries, resulting in inconsistent data
if all file and chunk documents have not replicated to all secondaries.
=head2 bson_codec
An object that provides the C<encode_one> and C<decode_one> methods, such
as from L<MongoDB::BSON>. It may be initialized with a hash reference that
will be coerced into a new MongoDB::BSON object. By default it will be
inherited from a L<MongoDB::Database> object.
=head2 max_time_ms
Specifies the maximum amount of time in milliseconds that the server should
use for working on a query. By default it will be inherited from a
L<MongoDB::Database> object.
B<Note>: this will only be used for server versions 2.6 or greater, as that
was when the C<$maxTimeMS> meta-operator was introduced.
=head1 METHODS
=head2 find
$result = $bucket->find($filter);
$result = $bucket->find($filter, $options);
$file_doc = $result->next;
Executes a query on the file documents collection with a
L<filter expression|MongoDB::Collection/Filter expression> and
returns a L<MongoDB::QueryResult> object. It takes an optional hashref
of options identical to L<MongoDB::Collection/find>.
=head2 find_one
$file_doc = $bucket->find_one($filter, $projection);
$file_doc = $bucket->find_one($filter, $projection, $options);
Executes a query on the file documents collection with a
L<filter expression|MongoDB::Collection/Filter expression> and
returns the first document found, or C<undef> if no document is found.
See L<MongoDB::Collection/find_one> for details about the
C<$projection> and optional C<$options> fields.
=head2 find_id
$file_doc = $bucket->find_id( $id );
$file_doc = $bucket->find_id( $id, $projection );
$file_doc = $bucket->find_id( $id, $projection, $options );
Executes a query with a L<filter expression|/Filter expression> of
C<< { _id => $id } >> and returns a single document or C<undef> if no document
is found.
See L<MongoDB::Collection/find_one> for details about the
C<$projection> and optional C<$options> fields.
=head2 open_download_stream
$stream = $bucket->open_download_stream($id);
$line = $stream->readline;
Returns a new L<MongoDB::GridFSBucket::DownloadStream> that can be used to
download the file with the file document C<_id> matching C<$id>. This
throws a L<MongoDB::GridFSError> if no such file exists.
=head2 open_upload_stream
$stream = $bucket->open_upload_stream($filename);
$stream = $bucket->open_upload_stream($filename, $options);
$stream->print('data');
$stream->close;
$file_id = $stream->id
Returns a new L<MongoDB::GridFSBucket::UploadStream> that can be used
to upload a new file to a GridFS bucket.
This method requires a filename to store in the C<filename> field of the
file document. B<Note>: the filename is an arbitrary string; the method
does not read from this filename locally.
You can provide an optional hash reference of options that are passed to the
L<MongoDB::GridFSBucket::UploadStream> constructor:
=over 4
=item *
C<chunk_size_bytes> – the number of bytes per chunk. Defaults to the C<chunk_size_bytes> of the bucket object.
=item *
C<metadata> – a hash reference for storing arbitrary metadata about the file.
=back
=head2 open_upload_stream_with_id
$stream = $bucket->open_upload_stream_with_id($id, $filename);
$stream = $bucket->open_upload_stream_with_id($id, $filename, $options);
$stream->print('data');
$stream->close;
Returns a new L<MongoDB::GridFSBucket::UploadStream> that can be used to
upload a new file to a GridFS bucket.
This method uses C<$id> as the _id of the file being created, which must be
unique.
This method requires a filename to store in the C<filename> field of the
file document. B<Note>: the filename is an arbitrary string; the method
does not read from this filename locally.
You can provide an optional hash reference of options, just like
L</open_upload_stream>.
=head2 download_to_stream
$bucket->download_to_stream($id, $out_fh);
Downloads the file matching C<$id> and writes it to the file handle C<$out_fh>.
This throws a L<MongoDB::GridFSError> if no such file exists.
=head2 upload_from_stream
$file_id = $bucket->upload_from_stream($filename, $in_fh);
$file_id = $bucket->upload_from_stream($filename, $in_fh, $options);
Reads from a filehandle and uploads its contents to GridFS. It returns the
C<_id> field stored in the file document.
This method requires a filename to store in the C<filename> field of the
file document. B<Note>: the filename is an arbitrary string; the method
does not read from this filename locally.
You can provide an optional hash reference of options, just like
L</open_upload_stream>.
=head2 upload_from_stream_with_id
$bucket->upload_from_stream_with_id($id, $filename, $in_fh);
$bucket->upload_from_stream_with_id($id, $filename, $in_fh, $options);
Reads from a filehandle and uploads its contents to GridFS.
This method uses C<$id> as the _id of the file being created, which must be
unique.
This method requires a filename to store in the C<filename> field of the
file document. B<Note>: the filename is an arbitrary string; the method
does not read from this filename locally.
You can provide an optional hash reference of options, just like
L</open_upload_stream>.
Unlike L</open_upload_stream>, this method returns nothing.
=head2 delete
$bucket->delete($id);
Deletes the file matching C<$id> from the bucket.
This throws a L<MongoDB::GridFSError> if no such file exists.
=head2 drop
$bucket->drop;
Drops the underlying files documents and chunks collections for this bucket.
=head1 SEE ALSO
Core documentation on GridFS: L<http://dochub.mongodb.org/core/gridfs>.
=head1 AUTHORS
=over 4
=item *
David Golden <david@mongodb.com>
=item *
Rassi <rassi@mongodb.com>
=item *
Mike Friedman <friedo@friedo.com>
=item *
Kristina Chodorow <k.chodorow@gmail.com>
=item *
Florian Ragwitz <rafl@debian.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2018 by MongoDB, Inc.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
|