forked from mongodb/mongo-csharp-driver
/
Release Notes v1.2.txt
386 lines (318 loc) · 16.8 KB
/
Release Notes v1.2.txt
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
C# Driver Version 1.2 Release Notes
===================================
This release of the C# driver has significant changes to it, but most are low level and the few breaking changes should affect
very few users. As mentioned below, you must recompile your application to use this version of the C# driver, because some
of the changes are non-breaking at the source code level but breaking at the binary level.
Highlights
better support for replica set status monitoring and failover
faster connection to replica sets (might not have to wait for all members to respond)
more efficient handling of connections (to avoid Disconnect/Connect storms)
new Disconnecting MongoServerState (analagous to Connecting and used when Disconnect is called)
new Unknown MongoServerState (a temporary state used after an error to trigger verification of the server state)
better concurrency support and several deadlock fixes
JsonReader support for more variations of the Date constructor (with or without "new")
JsonReader support for HexData constructor as an alternative to BinData
JsonReader support for RegExp constructor format for regular expresssions
JsonReader support for UUID, CSUUID, JUUID and PYUUID constructors (and GUID synonyms)
JsonWriter now more accurately handles ShellVersion
additional minor changes to be more PowerShell friendly
BsonSerializer can now deserialize to an interface
fewer ambiguities when resolving overloaded method calls
Breaking changes (mostly internal and/or low level)
some changes are compatible at the source code level but not at the binary level so you need to recompile your application
BsonBaseReader class removed (if you derived from BsonBaseReader derive from BsonReader instead).
BsonBaseWriter class removed (if you derived from BsonBaseWriter derive from BsonWriter instead)
GuidRepresentation property removed from BsonReaders and BsonWriters (it's in the settings)
some 32-bit parameters and properties/return values have been changed to 64-bit
Eval with nolock now requires using EvalFlags instead
PopFirst and PopLast fixed (breaking if you were working around the bug by calling the opposite method)
JIRA Issues addressed
---------------------
The list of JIRA issues addressed in this driver release can be found at https://jira.mongodb.org/secure/IssueNavigator.jspa?mode=hide&requestId=11022
BSON Library changes
--------------------
BsonBaseReader.cs
removed class
moved functionality up to BsonReader
BsonBaseWriter.cs
removed class
moved functionality up to BsonWriter
BsonBinaryReader.cs
changed base class from BsonBaseReader to BsonReader
removed GuidRepresentation property (it's in the settings)
ReadBinaryData now supports all GuidRepresentations
ReadDateTime has workaround to support old (incorrect) representation for DateTimeMaxValue
BsonBinaryReaderSettings
now derived from BsonReaderSettings
added FixOldDateTimeMaxValueOnInput property
moved GuidRepresentation property to new base class
moved Freeze and IsFrozen to base class
BsonBinaryWriter.cs
changed base class from BsonBaseWriter to BsonWriter
removed GuidRepresentation property (it's in the settings)
WriteBinaryData now supports all GuidRepresentations
BsonBinaryWriterSettings
now derived from BsonWriterSettings
moved GuidRepresentation to base class
moved Freeze and IsFrozen to base class
BsonDocumentReader.cs
changed base class from BsonBaseReader to BsonReader
removed GuidRepresentation property (it's in the settings)
ReadBinaryData now supports all GuidRepresentations
BsonDocumentReaderSettings.cs
now derived from BsonReaderSettings
moved GuidRepresentation to base class
moved Freeze and IsFrozen to base class
BsonDocumentWriter.cs
changed base class from BsonBaseWriter to BsonWriter
removed GuidRepresentation property (it's in the settings)
changed WriteName to call base method
BsonDocumentWriterSettings.cs
now derived from BsonWriterSettings
moved GuidRepresentation to base class
moved Freeze and IsFrozen to base class
BsonReader.cs
absorbed functionality moved up from removed BsonBaseReader class
implements CurrentBsonType property (no longer abstract)
implements Settings property (no longer abstract)
implements State property (no longer abstract)
implements Dispose (no longer abstract)
implements FindElement (no longer abstract)
implements FindStringElement (no longer abstract)
added guidRepresentation out parameter to ReadBinaryData
implements all ReadXyz overloads with a string name parameter (no longer abstract)
implements ReadName (no longer abstract)
BsonReaderSettings.cs
new abstract class
added GuidRepresentation property
added IsFrozen property
added Freeze method
BsonWriter.cs
absorbed functionality moved up from removed BsonBaseWriter class
added CheckElementNames property
added CheckUpdateDocument property
added Settings property
implements State property (no longer abstract)
removed GuidRepresentation property (it's in the settings)
implements Dispose (no longer abstract)
implements all WriteXyz overloads with a string name parameter (no longer abstract)
implements WriteName (no longer abstract)
added CheckElementName to verify that element names are valid
BsonWriterSettings.cs
new abstract class
added GuidRepresentation property
added IsFrozen property
added Freeze method
JsonReader.cs
now derived from BsonReaderSettings
removed GuidRepresentation property (it's in the settings)
added GuidRepresentation out parameter to ReadBinaryData
ReadDateTime has workaround to fix old (incorrect) representation for DateTimeMaxValue
Date constructor without "new" now returns string value (weird, but that's how JavaScript is defined)
supports HexData constructor (with and without "new")
supports RegExp constructor (with and without "new")
supports UUID, CSUUID, JUUID, PYUUID constructors (with and without "new")
supports GUID, CSGUID, JGUID, PYGUID as synonyms on Windows
Date constructor now supports all JavaScript defined variations
Date constructor now parses some JavaScript date time strings (next release will support more)
BinData and HexData constructor formats now take GuidRepresentation into account
JsonReaderSettings.cs
now derived from BsonReaderSettings
moved GuidRepresentation to base class
moved Freeze and IsFrozen to base class
JsonScanner.cs
supports new regex options 'x' and 's'
JsonWriter.cs
now derived from BsonWriter
removed GuidRepresentation property (it's in the settings)
WriteBinaryData now supports all GuidRepresentations
WriteDateTime only uses new ISODate representation if ShellVersion supports it
WriteDateTime now always uses the "new" keyword with the Date constructor
WriteInt64 only uses NumberLong representation if ShellVersion supports it
JsonyWriterSettings
now derived from BsonWriterSettings
moved GuidRepresentation to base class
moved Freeze and IsFrozen to base class
added ShellVersion property (used with Shell output mode to target a particular shell version)
BsonArray.cs
added constructor allowing caller to set initial capacity
replaced IEnumerable<object> overloads with IEnumerable to be PowerShell friendly
added Capacity property
BsonDocument.cs
need to have both Dictionary<string, object> and IDictionary<string, object> overloads to avoid ambiguities
Added params BsonElement[] overload of Add method
BsonDocumentWrapper.cs
added isUpdateDocument field
added isUpdateDocument parameter to constructor and Create method
Serialize now uses isUpdateDocument to set BsonWriter CheckUpdateDocument
BsonTypeMapper.cs
removed support for mapping BsonDocument to BsonArray (not really a justifiable mapping)
added support for mapping IEnumerable to BsonArray
BsonValue.cs
added AsBsonValue property
ReadFrom now delegates guidRepresentation handling to BsonReader
XyzSerializer.cs
all serializers have new actualType parameter to Deserialize (though not all will use it)
ArraySerializer.cs
when serializing an array with nominal type object wrap it in a document with a discriminator so it can be deserialized
BsonBaseSerializer.cs
switched which Deserialize method is implemented in the base class (so subclasses need to adjust)
DictionaryGenericSerializer.cs
Serialize automatically chooses representation depending on whether keys are valid element names
DictionarySerializer.cs
Serialize automatically chooses representation depending on whether keys are valid element names
NetPrimitiveSerializer.cs
added support for serializing System.Drawing.Size
ObjectSerializer.cs
now implements IBsonSerializer directly and is not derived from BsonBaseSerializer
BsonClassMap.cs
added IsFrozen property
changed locking scheme to use ReaderWriterLockSlim to increase concurrency (specially important for LookupClassMap)
improved error messages for conflicting element names to better identify origin of conflict
BsonClassMapSerializer.cs
improved error messages for missing or unmatched element names
BsonDefaultSerializer.cs
changed locking scheme to use ReaderWriterLockSlim to increase concurrency (specially important for LookupActualType)
fixed deadlock in EnsureKnownTypesAreRegistered
BsonSerializer.cs
changed locking scheme to use ReaderWriterLockSlim to increase concurrency (specially important for LookupSerializer)
Deserialize now supports deserializing to nominal type that is an interface
Driver changes
--------------
CollectionOptionsBuilder.cs
SetMaxDocuments parameter is now long instead of int
QueryBuilder.cs
added new overload of All method with IEnumerable<BsonValue> parameter
added new overload of In method with IEnumerable<BsonValue> parameter
added new overload of NotIn method with IEnumerable<BsonValue> parameter
UpdateBuilder.cs
added new overload of AddToSetEach method with BsonArray parameter
added new Combine method
added new overload of PullAll method with BsonArray parameter
added new overload of PushAll method with BsonArray parameter
fixed PopFirst and PopLast (which were both doing the opposite of what they were supposed to)
CollectionStatsResult.cs
added IsCapped property
added MaxDocuments property
GetLastErrorResult.cs
DocumentsAffectedProperty is now long instead of int
MapReduceResult.cs
EmitCount is now long instead of int
OutputCount is now long instead of int
InputCount is now long instead of int
CollectionOptionsDocument.cs
CommandDocument.cs
FieldsDocument.cs
GeoNearOptionsDocument.cs
GroupByDocument.cs
IndexKeysDocument.cs
IndexOptionsDocument.cs
MapReduceOptionsDocument.cs
QueryDocument.cs
ScopeDocument.cs
SortByDocument.cs
UpdateDocument.cs
added new constructors with Dictionary<string, object> parameter
ConnectWaitFor.cs
new enum used when connecting to replica sets to support connecting faster before all members have responded
EvalFlags.cs
new flags used with Eval to specify NoLock option
MongoCollection.cs
Count is now long instead of int
FindAndModify now checks update document for valid field names
added new overloads of Insert method with MongoInsertOptions parameter
added new overloads of InsertBatch method with MongoInsertOptions parameter
Insert, InsertBatch, Save and Update now throw ArgumentNullException if called with a null document
replaced overload of InsertBatch with IEnumerable<object> parameter with one with IEnumerable parameter
implemented IsCapped
added overload of Save method with MongoInsertOptions parameter
added InsertBatch methods to MongoCollection<TDefaultDocument>
added Save methods to MongoCollection<TDefaultDocument>
MongoCursor.cs
Count is now long instead of int
Size is now long instead of int
MongoDatabase.cs
changed implementation of Eval with nolock parameter to Eval with flags to fix overload ambiguity
added overload of RenameCollection with dropTarget parameter
added overload of RequestStart with slaveOk parameter
MongoInsertOptions.cs
new class
added CheckElementNames property
added SafeMode property
MongoServer.cs
changed locking design to avoid deadlocks
added connectionAttempt field (so delayed responses to aborted connection attempts can be ignored)
added primary field (so we don't have to scan instances whenever we need the primary)
added SequentialId property to use when logging
create MongoServerInstances when MongoServer is created (can change later if seed list is incomplete)
added RequestConnection property (name is awkard... Request is an adjective in this method, not a verb)
added overload of Connect with ConnectWaitFor parameter
Connect now returns immediately if waitFor condition is already met
Disconnect now sets the state to the new Disconnecting state while disconnecting
rearchitected replica set connection implementation
Ping now pings all members when connected to a replica set
added overload of RequestStart with slaveOk parameter
added VerifyState method
ChooseServerInstance now first attempts to choose an instance quickly from the currently available instances
ChooseServerInstance now only calls Connect or VerifyUnknownStates when it can't find a suitable instance
changed implementation of InstanceStateChanged to handle new Disconnecting state
MongoServerInstance.cs
added locking for thread safety
only create one instance of MongoConnectionPool for the lifetime of the MongoServerInstance
call the clear method of MongoConnectionPool when needed instead of creating a new instance of MongoConnectionPool
added SequentialId property to use when logging
added Ping method
added VerifyState method
VerifyState sets BuildInfo to null if the buildInfo command fails due to auth (due to a change in the 2.0 server)
MongoServerState.cs
removed None state
added ConnectedToSubset state (used with replica sets)
added Disconnecting state
added Unknown state
MongoQueryException.cs
added QueryResult property
MongoGridFS.cs
Download now supports downloading with slaveOk true
EnsureIndexes now does nothing if not connected to a primary
EnsureIndexes now sets the unique option to true on the "files_id, n" index
MongoGridFSFileInfo.cs
Length property is now long instead of int
MongoGridFSStream.cs
fixed bug in OpenCreate that prevented using a custom file Id
DirectConnector.cs
changed Connect so when trying more than address it changes the address of an existing MongoServerInstance of instead of creating a new instance
MongoConnection.cs
MongoConnectionState enum is now public
removed Damaged MongoConnectionState (connection is just closed instead)
class is now public (but only property gets are public)
added GenerationId property
added RequestId property
changed HandleException to not call Disconnect (was causing Connect/Disconnect storms)
HandleException now sets server instance state to Unknown on error (instead of calling Disconnect)
MongoConnectionPool.cs
added GenerationId property
Timer now started as soon as connection pool is created (solves race conditions starting and stopping the timer)
TimerCallback now returns immediately when MongoServer is Disconnected
TimerCallback now quits immediately if previous Timer callback has not finished
TimerCallback now calls VerifyState to detect when a replica set member comes back online
TimerCallback doesn't let unhandled exceptions happen
connections are now closed synchronously instead of on a background thread (because connections could be opened faster than they were being closed)
minimum connection pool size is now checked by the timer and not just at connect time
EnsureMinConnectionPoolSizeWorkItem now knows to abandon its efforts if the GenerationId changes
EnsureMinConnectionPoolSizeWorkItem doesn't let unhandled exception happen
MongoInsertMessage.cs
Added checkElementNames field
AddDocument now sets CheckElementNames on BsonWriter
MongoUpdateMessage.cs
WriteBody now sets CheckUpdateDocument on BsonWriter
ReplicaSetConnector.cs
added connectionAttempt field
added ConnectWaitFor parameter to Connect method
Connect will exit early as soon as ConnectWaitFor condition is met
improved connect error messages
ProcessResponse now ignores delayed responses if Disconnected or connectionAttempt has changed
Environments tested on
----------------------
Visual Studio 2010 on Windows 7 x64 against MongoDB 1.8.3, 2.0.0
Visual Studio 2008 on Windows 7 x64 against MongoDB 1.8.3, 2.0.0
MonoDevelop 2.6 (with Mono 2.10) on Windows 7 x64, OS X Snow Leopard against MongoDB 1.8.3, 2.0.0