From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

MONGODB / MongoDB-v1.1.0-TRIAL / lib / MongoDB / DeleteResult.pm 

            

              
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

              
#
#  Copyright 2014 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.
#
package MongoDB::DeleteResult;
# ABSTRACT: MongoDB deletion result object
use version;
our $VERSION = 'v1.1.0'; # TRIAL
use Moo;
use MongoDB::_Constants;
use Types::Standard qw(
    Num
);
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 => Num,
);
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
MongoDB::DeleteResult - MongoDB deletion result object
=head1 VERSION
version v1.1.0
=head1 SYNOPSIS
    my $result = $coll->delete( { _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 *
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) 2015 by MongoDB, Inc..
This is free software, licensed under:
  The Apache License, Version 2.0, January 2004
=cut