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
|
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2014-2020 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.
module Mongo
module Operation
class ListCollections
# Defines custom behavior of results when using the
# listCollections command.
#
# @since 2.0.0
# @api semiprivate
class Result < Operation::Result
# Get the cursor id for the result.
#
# @example Get the cursor id.
# result.cursor_id
#
# @note Even though the wire protocol has a cursor_id field for all
# messages of type reply, it is always zero when using the
# listCollections command and must be retrieved from the cursor
# document itself.
#
# @return [ Integer ] The cursor id.
#
# @since 2.0.0
# @api private
def cursor_id
cursor_document ? cursor_document[CURSOR_ID] : super
end
# Get the namespace for the cursor.
#
# @example Get the namespace.
# result.namespace
#
# @return [ String ] The namespace.
#
# @since 2.0.0
# @api private
def namespace
cursor_document ? cursor_document[NAMESPACE] : super
end
# Get the documents for the listCollections result. It is the 'firstBatch'
# field in the 'cursor' field of the first document returned.
#
# @example Get the documents.
# result.documents
#
# @return [ Array<BSON::Document> ] The documents.
#
# @since 2.0.0
# @api public
def documents
cursor_document[FIRST_BATCH]
end
# Validate the result. In the case where an unauthorized client tries
# to run the command we need to generate the proper error.
#
# @example Validate the result.
# result.validate!
#
# @return [ Result ] Self if successful.
#
# @since 2.0.0
# @api private
def validate!
if successful?
self
else
raise operation_failure_class.new(
parser.message,
self,
code: parser.code,
code_name: parser.code_name,
labels: parser.labels,
wtimeout: parser.wtimeout,
document: parser.document,
server_message: parser.server_message,
)
end
end
private
def cursor_document
@cursor_document ||= first_document[CURSOR]
end
def first_document
@first_document ||= reply.documents[0]
end
end
end
end
end
|
