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
|
# Copyright (C) 2014-2017 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 Protocol
# MongoDB Wire protocol Insert message.
#
# This is a client request message that is sent to the server in order
# to insert documents within a namespace.
#
# The operation only has one flag +:continue_on_error+ which the user
# can use to instruct the database server to continue processing a bulk
# insertion if one happens to fail (e.g. due to duplicate IDs). This makes
# builk insert behave similarly to a seires of single inserts, except
# lastError will be set if any insert fails, not just the last one.
#
# If multiple errors occur, only the most recent will be reported by the
# getLastError mechanism.
#
# @api semipublic
class Insert < Message
# Creates a new Insert message
#
# @example Insert a user document
# Insert.new('xgen', 'users', [{:name => 'Tyler'}])
#
# @example Insert serveral user documents and continue on errors
# Insert.new('xgen', 'users', users, :flags => [:continue_on_error])
#
# @param database [String, Symbol] The database to insert into.
# @param collection [String, Symbol] The collection to insert into.
# @param documents [Array<Hash>] The documents to insert.
# @param options [Hash] Additional options for the insertion.
#
# @option options :flags [Array] The flags for the insertion message.
#
# Supported flags: +:continue_on_error+
def initialize(database, collection, documents, options = {})
@database = database
@namespace = "#{database}.#{collection}"
@documents = documents
@flags = options[:flags] || []
@upconverter = Upconverter.new(collection, documents, options)
@options = options
super
end
# Return the event payload for monitoring.
#
# @example Return the event payload.
# message.payload
#
# @return [ BSON::Document ] The event payload.
#
# @since 2.1.0
def payload
BSON::Document.new(
command_name: 'insert',
database_name: @database,
command: upconverter.command,
request_id: request_id
)
end
protected
attr_reader :upconverter
private
def validating_keys?
@options.fetch(:validating_keys, true)
end
# The operation code required to specify an Insert message.
# @return [Fixnum] the operation code.
#
# @since 2.5.0
OP_CODE = 2002
# Available flags for an Insert message.
FLAGS = [:continue_on_error]
# @!attribute
# @return [Array<Symbol>] The flags for this Insert message.
field :flags, BitVector.new(FLAGS)
# @!attribute
# @return [String] The namespace for this Insert message.
field :namespace, CString
# @!attribute
# @return [Array<Hash>] The documents to insert.
field :documents, Document, true
# Converts legacy insert messages to the appropriare OP_COMMAND style
# message.
#
# @since 2.1.0
class Upconverter
# Insert field constant.
#
# @since 2.1.0
INSERT = 'insert'.freeze
# Documents field constant.
#
# @since 2.1.0
DOCUMENTS = 'documents'.freeze
# Write concern field constant.
#
# @since 2.1.0
WRITE_CONCERN = 'writeConcern'.freeze
# @return [ String ] collection The name of the collection.
attr_reader :collection
# @return [ Array<BSON::Document> ] documents The documents to insert.
attr_reader :documents
# @return [ Hash ] options The options.
attr_reader :options
# Instantiate the upconverter.
#
# @example Instantiate the upconverter.
# Upconverter.new('users', documents)
#
# @param [ String ] collection The name of the collection.
# @param [ Array<BSON::Document> ] documents The documents.
# @param [ Hash ] options The options.
#
# @since 2.1.0
def initialize(collection, documents, options)
@collection = collection
@documents = documents
@options = options
end
# Get the upconverted command.
#
# @example Get the command.
# upconverter.command
#
# @return [ BSON::Document ] The upconverted command.
#
# @since 2.1.0
def command
document = BSON::Document.new
document.store(INSERT, collection)
document.store(DOCUMENTS, documents)
document.store(Message::ORDERED, options.fetch(:ordered, true))
document.merge!(WRITE_CONCERN => options[:write_concern].options) if options[:write_concern]
document
end
end
Registry.register(OP_CODE, self)
end
end
end
|
