%PDF- %PDF-
Direktori : /home/opti/optisoftcom-new/perl5/lib/perl5/MongoDB/ |
Current File : /home/opti/optisoftcom-new/perl5/lib/perl5/MongoDB/DeleteResult.pm |
# Copyright 2014 - present 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::DeleteResult; # ABSTRACT: MongoDB deletion result object use version; our $VERSION = 'v2.0.2'; use Moo; use MongoDB::_Constants; use MongoDB::_Types qw( Numish ); use namespace::clean; with $_ for qw( MongoDB::Role::_PrivateConstructor MongoDB::Role::_WriteResult ); #pod =attr deleted_count #pod #pod The number of documents that matched the filter. #pod #pod =cut has deleted_count => ( is => 'ro', default => 0, isa => Numish, ); 1; __END__ =pod =encoding UTF-8 =head1 NAME MongoDB::DeleteResult - MongoDB deletion result object =head1 VERSION version v2.0.2 =head1 SYNOPSIS my $result = $coll->delete_one( { _id => $oid } ); if ( $result->acknowledged ) { ... } =head1 DESCRIPTION This class encapsulates the results from a deletion operation. =head1 ATTRIBUTES =head2 deleted_count The number of documents that matched the filter. =head1 METHODS =head2 acknowledged Indicates whether this write result was acknowledged. Always true for this class. =head2 assert Throws an error if write errors or write concern errors occurred. Otherwise, returns the invocant. =head2 assert_no_write_error Throws a MongoDB::WriteError if write errors occurred. Otherwise, returns the invocant. =head2 assert_no_write_concern_error Throws a MongoDB::WriteConcernError if write concern errors occurred. Otherwise, returns the invocant. =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