CSHARP-1706: Support collations.

Author: rstam

src/MongoDB.Driver.Core/Collation.cs

@@ -1,4 +1,4 @@
-/* Copyright 2015 MongoDB Inc.
+/* Copyright 2015-2016 MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -24,6 +24,7 @@ internal static class SupportedFeatures
         private static readonly SemanticVersion __versionSupportingAggregateCursorResult = new SemanticVersion(2, 6, 0);
         private static readonly SemanticVersion __versionSupportingAggregateOut = new SemanticVersion(2, 6, 0);
         private static readonly SemanticVersion __versionSupportingBypassDocumentValidation = new SemanticVersion(3, 1, 3);
+        private static readonly SemanticVersion __versionSupportingCollation = new SemanticVersion(3, 3, 11);
         private static readonly SemanticVersion __versionSupportingCreateIndexesCommand = new SemanticVersion(2, 7, 6);
         private static readonly SemanticVersion __versionSupportingCurrentOpCommand = new SemanticVersion(3, 1, 2);
         private static readonly SemanticVersion __versionSupportingFailPoints = new SemanticVersion(2, 4, 0);
@@ -98,6 +99,16 @@ public static bool IsBypassDocumentValidationSupported(SemanticVersion serverVer
             return serverVersion >= __versionSupportingBypassDocumentValidation;
         }
 
+        /// <summary>
+        /// Determines whether Collation is supported.
+        /// </summary>
+        /// <param name="serverVersion">The server version.</param>
+        /// <returns>True if Collation is supported.</returns>
+        public static bool IsCollationSupported(SemanticVersion serverVersion)
+        {
+            return serverVersion >= __versionSupportingCollation;
+        }
+
         /// <summary>
         /// Determines whether the CreateIndexes command is supported.
         /// </summary>

src/MongoDB.Driver.Core/Core/Misc/SupportedFeatures.cs

@@ -1,4 +1,4 @@
-/* Copyright 2013-2015 MongoDB Inc.
+/* Copyright 2013-2016 MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -33,6 +33,7 @@ public class AggregateExplainOperation : IReadOperation<BsonDocument>
     {
         // fields
         private bool? _allowDiskUse;
+        private Collation _collation;
         private CollectionNamespace _collectionNamespace;
         private TimeSpan? _maxTime;
         private MessageEncoderSettings _messageEncoderSettings;
@@ -65,6 +66,18 @@ public bool? AllowDiskUse
             set { _allowDiskUse = value; }
         }
 
+        /// <summary>
+        /// Gets or sets the collation.
+        /// </summary>
+        /// <value>
+        /// The collation.
+        /// </value>
+        public Collation Collation
+        {
+            get { return _collation; }
+            set { _collation = value; }
+        }
+
         /// <summary>
         /// Gets the collection namespace.
         /// </summary>
@@ -111,35 +124,51 @@ public IReadOnlyList<BsonDocument> Pipeline
         }
 
         // methods
-        internal BsonDocument CreateCommand()
+        internal BsonDocument CreateCommand(SemanticVersion serverVersion)
         {
+            if (_collation != null && !SupportedFeatures.IsCollationSupported(serverVersion))
+            {
+                throw new NotSupportedException($"Server version {serverVersion} does not support collations.");
+            }
+
             return new BsonDocument
             {
                 { "aggregate", _collectionNamespace.CollectionName },
                 { "explain", true },
                 { "pipeline", new BsonArray(_pipeline) },
                 { "allowDiskUse", () => _allowDiskUse.Value, _allowDiskUse.HasValue },
-                { "maxTimeMS", () => _maxTime.Value.TotalMilliseconds, _maxTime.HasValue }
+                { "maxTimeMS", () => _maxTime.Value.TotalMilliseconds, _maxTime.HasValue },
+                { "collation", () => _collation.ToBsonDocument(), _collation != null }
             };
         }
 
         /// <inheritdoc/>
         public BsonDocument Execute(IReadBinding binding, CancellationToken cancellationToken)
         {
-            var operation = CreateOperation();
-            return operation.Execute(binding, cancellationToken);
+            using (var channelSource = binding.GetReadChannelSource(cancellationToken))
+            using (var channel = channelSource.GetChannel(cancellationToken))
+            using (var channelBinding = new ChannelReadBinding(channelSource.Server, channel, binding.ReadPreference))
+            {
+                var operation = CreateOperation(channel.ConnectionDescription.ServerVersion);
+                return operation.Execute(channelBinding, cancellationToken);
+            }
         }
 
         /// <inheritdoc/>
-        public Task<BsonDocument> ExecuteAsync(IReadBinding binding, CancellationToken cancellationToken)
+        public async Task<BsonDocument> ExecuteAsync(IReadBinding binding, CancellationToken cancellationToken)
         {
-            var operation = CreateOperation();
-            return operation.ExecuteAsync(binding, cancellationToken);
+            using (var channelSource = await binding.GetReadChannelSourceAsync(cancellationToken).ConfigureAwait(false))
+            using (var channel = await channelSource.GetChannelAsync(cancellationToken).ConfigureAwait(false))
+            using (var channelBinding = new ChannelReadBinding(channelSource.Server, channel, binding.ReadPreference))
+            {
+                var operation = CreateOperation(channel.ConnectionDescription.ServerVersion);
+                return await operation.ExecuteAsync(channelBinding, cancellationToken).ConfigureAwait(false);
+            }
         }
 
-        private ReadCommandOperation<BsonDocument> CreateOperation()
+        private ReadCommandOperation<BsonDocument> CreateOperation(SemanticVersion serverVersion)
         {
-            var command = CreateCommand();
+            var command = CreateCommand(serverVersion);
             return new ReadCommandOperation<BsonDocument>(
                 _collectionNamespace.DatabaseNamespace,
                 command,

src/MongoDB.Driver.Core/Core/Operations/AggregateExplainOperation.cs

@@ -1,4 +1,4 @@
-/* Copyright 2013-2015 MongoDB Inc.
+/* Copyright 2013-2016 MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -38,6 +38,7 @@ public class AggregateOperation<TResult> : IReadOperation<IAsyncCursor<TResult>>
         // fields
         private bool? _allowDiskUse;
         private int? _batchSize;
+        private Collation _collation;
         private readonly CollectionNamespace _collectionNamespace;
         private TimeSpan? _maxTime;
         private readonly MessageEncoderSettings _messageEncoderSettings;
@@ -87,6 +88,15 @@ public int? BatchSize
             set { _batchSize = Ensure.IsNullOrGreaterThanOrEqualToZero(value, nameof(value)); }
         }
 
+        /// <summary>
+        /// Gets or sets the collation.
+        /// </summary>
+        public Collation Collation
+        {
+            get { return _collation; }
+            set { _collation = value; }
+        }
+
         /// <summary>
         /// Gets the collection namespace.
         /// </summary>
@@ -212,21 +222,27 @@ public IReadOperation<BsonDocument> ToExplainOperation(ExplainVerbosity verbosit
             return new AggregateExplainOperation(_collectionNamespace, _pipeline, _messageEncoderSettings)
             {
                 AllowDiskUse = _allowDiskUse,
+                Collation = _collation,
                 MaxTime = _maxTime
             };
         }
 
         internal BsonDocument CreateCommand(SemanticVersion serverVersion)
         {
             _readConcern.ThrowIfNotSupported(serverVersion);
+            if (_collation != null && !SupportedFeatures.IsCollationSupported(serverVersion))
+            {
+                throw new NotSupportedException($"Server version {serverVersion} does not support collations.");
+            }
 
             var command = new BsonDocument
             {
                 { "aggregate", _collectionNamespace.CollectionName },
                 { "pipeline", new BsonArray(_pipeline) },
                 { "allowDiskUse", () => _allowDiskUse.Value, _allowDiskUse.HasValue },
                 { "maxTimeMS", () => _maxTime.Value.TotalMilliseconds, _maxTime.HasValue },
-                { "readConcern", () => _readConcern.ToBsonDocument(), !_readConcern.IsServerDefault }
+                { "readConcern", () => _readConcern.ToBsonDocument(), !_readConcern.IsServerDefault },
+                { "collation", () => _collation.ToBsonDocument(), _collation != null }
             };
 
             if (SupportedFeatures.IsAggregateCursorResultSupported(serverVersion) && _useCursor.GetValueOrDefault(true))

src/MongoDB.Driver.Core/Core/Operations/AggregateOperation.cs

@@ -1,4 +1,4 @@
-/* Copyright 2013-2015 MongoDB Inc.
+/* Copyright 2013-2016 MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -34,6 +34,7 @@ public class AggregateToCollectionOperation : IWriteOperation<BsonDocument>
         // fields
         private bool? _allowDiskUse;
         private bool? _bypassDocumentValidation;
+        private Collation _collation;
         private readonly CollectionNamespace _collectionNamespace;
         private TimeSpan? _maxTime;
         private readonly MessageEncoderSettings _messageEncoderSettings;
@@ -80,6 +81,18 @@ public bool? BypassDocumentValidation
             set { _bypassDocumentValidation = value; }
         }
 
+        /// <summary>
+        /// Gets or sets the collation.
+        /// </summary>
+        /// <value>
+        /// The collation.
+        /// </value>
+        public Collation Collation
+        {
+            get { return _collation; }
+            set { _collation = value; }
+        }
+
         /// <summary>
         /// Gets the collection namespace.
         /// </summary>
@@ -156,13 +169,19 @@ public async Task<BsonDocument> ExecuteAsync(IWriteBinding binding, Cancellation
 
         internal BsonDocument CreateCommand(SemanticVersion serverVersion)
         {
+            if (_collation != null && !SupportedFeatures.IsCollationSupported(serverVersion))
+            {
+                throw new NotSupportedException($"Server version {serverVersion} does not support collations.");
+            }
+
             return new BsonDocument
             {
                 { "aggregate", _collectionNamespace.CollectionName },
                 { "pipeline", new BsonArray(_pipeline) },
                 { "allowDiskUse", () => _allowDiskUse.Value, _allowDiskUse.HasValue },
                 { "bypassDocumentValidation", () => _bypassDocumentValidation.Value, _bypassDocumentValidation.HasValue && SupportedFeatures.IsBypassDocumentValidationSupported(serverVersion) },
-                { "maxTimeMS", () => _maxTime.Value.TotalMilliseconds, _maxTime.HasValue }
+                { "maxTimeMS", () => _maxTime.Value.TotalMilliseconds, _maxTime.HasValue },
+                { "collation", () => _collation.ToBsonDocument(), _collation != null }
             };
         }
 

src/MongoDB.Driver.Core/Core/Operations/AggregateToCollectionOperation.cs

@@ -1,4 +1,4 @@
-/* Copyright 2010-2014 MongoDB Inc.
+/* Copyright 2010-2016 MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -13,10 +13,14 @@
 * limitations under the License.
 */
 
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using MongoDB.Bson.IO;
 using MongoDB.Bson.Serialization;
+using MongoDB.Bson.Serialization.Serializers;
+using MongoDB.Driver.Core.Connections;
+using MongoDB.Driver.Core.Misc;
 using MongoDB.Driver.Core.WireProtocol.Messages.Encoders;
 
 namespace MongoDB.Driver.Core.Operations
@@ -49,9 +53,9 @@ protected override string RequestsElementName
         }
 
         // methods
-        protected override BatchSerializer CreateBatchSerializer(int maxBatchCount, int maxBatchLength, int maxDocumentSize, int maxWireDocumentSize)
+        protected override BatchSerializer CreateBatchSerializer(ConnectionDescription connectionDescription, int maxBatchCount, int maxBatchLength)
         {
-            return new DeleteBatchSerializer(maxBatchCount, maxBatchLength, maxDocumentSize, maxWireDocumentSize);
+            return new DeleteBatchSerializer(connectionDescription, maxBatchCount, maxBatchLength);
         }
 
         protected override BulkUnmixedWriteOperationEmulatorBase CreateEmulator()
@@ -69,21 +73,31 @@ protected override BulkUnmixedWriteOperationEmulatorBase CreateEmulator()
         private class DeleteBatchSerializer : BatchSerializer
         {
             // constructors
-            public DeleteBatchSerializer(int maxBatchCount, int maxBatchLength, int maxDocumentSize, int maxWireDocumentSize)
-                : base(maxBatchCount, maxBatchLength, maxDocumentSize, maxWireDocumentSize)
+            public DeleteBatchSerializer(ConnectionDescription connectionDescription, int maxBatchCount, int maxBatchLength)
+                : base(connectionDescription, maxBatchCount, maxBatchLength)
             {
             }
 
             // methods
             protected override void SerializeRequest(BsonSerializationContext context, WriteRequest request)
             {
                 var deleteRequest = (DeleteRequest)request;
+                if (deleteRequest.Collation != null && !SupportedFeatures.IsCollationSupported(ConnectionDescription.ServerVersion))
+                {
+                    throw new NotSupportedException($"Server version {ConnectionDescription.ServerVersion} does not support collations.");
+                }
+
                 var bsonWriter = (BsonBinaryWriter)context.Writer;
-                bsonWriter.PushMaxDocumentSize(MaxDocumentSize);
+                bsonWriter.PushMaxDocumentSize(ConnectionDescription.MaxDocumentSize);
                 bsonWriter.WriteStartDocument();
                 bsonWriter.WriteName("q");
                 BsonSerializer.Serialize(bsonWriter, deleteRequest.Filter);
                 bsonWriter.WriteInt32("limit", deleteRequest.Limit);
+                if (deleteRequest.Collation != null)
+                {
+                    bsonWriter.WriteName("collation");
+                    BsonDocumentSerializer.Instance.Serialize(context, deleteRequest.Collation.ToBsonDocument());
+                }
                 bsonWriter.WriteEndDocument();
                 bsonWriter.PopMaxDocumentSize();
             }

src/MongoDB.Driver.Core/Core/Operations/BulkDeleteOperation.cs

@@ -1,4 +1,4 @@
-/* Copyright 2010-2014 MongoDB Inc.
+/* Copyright 2010-2016 MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
 * limitations under the License.
 */
 
+using System;
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
@@ -37,6 +38,10 @@ public BulkDeleteOperationEmulator(
         protected override WriteConcernResult ExecuteProtocol(IChannelHandle channel, WriteRequest request, CancellationToken cancellationToken)
         {
             var deleteRequest = (DeleteRequest)request;
+            if (deleteRequest.Collation != null)
+            {
+                throw new NotSupportedException("OP_DELETE does not support collations.");
+            }
             var isMulti = deleteRequest.Limit == 0;
 
             return channel.Delete(
@@ -52,6 +57,10 @@ protected override Task<WriteConcernResult> ExecuteProtocolAsync(IChannelHandle
         {
             var deleteRequest = (DeleteRequest)request;
             var isMulti = deleteRequest.Limit == 0;
+            if (deleteRequest.Collation != null)
+            {
+                throw new NotSupportedException("OP_DELETE does not support collations.");
+            }
 
             return channel.DeleteAsync(
                CollectionNamespace,

src/MongoDB.Driver.Core/Core/Operations/BulkDeleteOperationEmulator.cs

@@ -1,4 +1,4 @@
-/* Copyright 2010-2014 MongoDB Inc.
+/* Copyright 2010-2016 MongoDB Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@
 using MongoDB.Bson.Serialization.Options;
 using MongoDB.Bson.Serialization.Serializers;
 using MongoDB.Driver.Core.Bindings;
+using MongoDB.Driver.Core.Connections;
 using MongoDB.Driver.Core.Misc;
 using MongoDB.Driver.Core.Operations.ElementNameValidators;
 using MongoDB.Driver.Core.WireProtocol.Messages.Encoders;
@@ -59,11 +60,11 @@ protected override string RequestsElementName
         }
 
         // methods
-        protected override BatchSerializer CreateBatchSerializer(int maxBatchCount, int maxBatchLength, int maxDocumentSize, int maxWireDocumentSize)
+        protected override BatchSerializer CreateBatchSerializer(ConnectionDescription connectionDescription, int maxBatchCount, int maxBatchLength)
         {
             var isSystemIndexesCollection = CollectionNamespace.Equals(CollectionNamespace.DatabaseNamespace.SystemIndexesCollection);
             var elementNameValidator = isSystemIndexesCollection ? (IElementNameValidator)NoOpElementNameValidator.Instance : CollectionElementNameValidator.Instance;
-            return new InsertBatchSerializer(maxBatchCount, maxBatchLength, maxDocumentSize, maxWireDocumentSize, elementNameValidator);
+            return new InsertBatchSerializer(connectionDescription, maxBatchCount, maxBatchLength, elementNameValidator);
         }
 
         protected override BulkUnmixedWriteOperationEmulatorBase CreateEmulator()
@@ -86,8 +87,8 @@ private class InsertBatchSerializer : BatchSerializer
             private IElementNameValidator _elementNameValidator;
 
             // constructors
-            public InsertBatchSerializer(int maxBatchCount, int maxBatchLength, int maxDocumentSize, int maxWireDocumentSize, IElementNameValidator elementNameValidator)
-                : base(maxBatchCount, maxBatchLength, maxDocumentSize, maxWireDocumentSize)
+            public InsertBatchSerializer(ConnectionDescription connectionDescription, int maxBatchCount, int maxBatchLength, IElementNameValidator elementNameValidator)
+                : base(connectionDescription, maxBatchCount, maxBatchLength)
             {
                 _elementNameValidator = elementNameValidator;
             }
@@ -108,7 +109,7 @@ protected override void SerializeRequest(BsonSerializationContext context, Write
                 var serializer = _cachedSerializer;
 
                 var bsonWriter = (BsonBinaryWriter)context.Writer;
-                bsonWriter.PushMaxDocumentSize(MaxDocumentSize);
+                bsonWriter.PushMaxDocumentSize(ConnectionDescription.MaxDocumentSize);
                 bsonWriter.PushElementNameValidator(_elementNameValidator);
                 try
                 {