CSHARP-2023: Rename ChangeStreamOutput to ChangeStreamDocument.

Author: rstam

…ongoDB.Driver.Core/ChangeStreamOutput.cs …goDB.Driver.Core/ChangeStreamDocument.cssrc/MongoDB.Driver.Core/ChangeStreamOutput.cs renamed to src/MongoDB.Driver.Core/ChangeStreamDocument.cs src/MongoDB.Driver.Core/ChangeStreamOutput.cs renamed to src/MongoDB.Driver.Core/ChangeStreamDocument.cs

@@ -21,7 +21,7 @@ namespace MongoDB.Driver
     /// <summary>
     /// An output document from a $changeStream pipeline stage.
     /// </summary>
-    public sealed class ChangeStreamOutput<TDocument>
+    public sealed class ChangeStreamDocument<TDocument>
     {
         // private fields
         private readonly CollectionNamespace _collectionNamespace;
@@ -33,15 +33,15 @@ public sealed class ChangeStreamOutput<TDocument>
 
         // constructors
         /// <summary>
-        /// Initializes a new instance of the <see cref="ChangeStreamOutput{TDocument}" /> class.
+        /// Initializes a new instance of the <see cref="ChangeStreamDocument{TDocument}" /> class.
         /// </summary>
         /// <param name="resumeToken">The resume token.</param>
         /// <param name="operationType">Type of the operation.</param>
         /// <param name="collectionNamespace">Namespace of the collection.</param>
         /// <param name="documentKey">The document key.</param>
         /// <param name="updateDescription">The update description.</param>
         /// <param name="fullDocument">The full document.</param>
-        public ChangeStreamOutput(
+        public ChangeStreamDocument(
             BsonDocument resumeToken,
             ChangeStreamOperationType operationType,
             CollectionNamespace collectionNamespace,

…ver.Core/ChangeStreamOutputSerializer.cs …r.Core/ChangeStreamDocumentSerializer.cssrc/MongoDB.Driver.Core/ChangeStreamOutputSerializer.cs renamed to src/MongoDB.Driver.Core/ChangeStreamDocumentSerializer.cs src/MongoDB.Driver.Core/ChangeStreamOutputSerializer.cs renamed to src/MongoDB.Driver.Core/ChangeStreamDocumentSerializer.cs

@@ -24,10 +24,10 @@ namespace MongoDB.Driver
 {
 
     /// <summary>
-    /// A serializer for ChangeStreamOutput instances.
+    /// A serializer for ChangeStreamDocument instances.
     /// </summary>
     /// <typeparam name="TDocument">The type of the document.</typeparam>
-    public class ChangeStreamOutputSerializer<TDocument> : SealedClassSerializerBase<ChangeStreamOutput<TDocument>>
+    public class ChangeStreamDocumentSerializer<TDocument> : SealedClassSerializerBase<ChangeStreamDocument<TDocument>>
     {
         #region static
         // private static fields
@@ -40,18 +40,18 @@ public class ChangeStreamOutputSerializer<TDocument> : SealedClassSerializerBase
 
         // constructors
         /// <summary>
-        /// Initializes a new instance of the <see cref="ChangeStreamOutputSerializer{TDocument}"/> class.
+        /// Initializes a new instance of the <see cref="ChangeStreamDocumentSerializer{TDocument}"/> class.
         /// </summary>
         /// <param name="documentSerializer">The document serializer.</param>
-        public ChangeStreamOutputSerializer(
+        public ChangeStreamDocumentSerializer(
             IBsonSerializer<TDocument> documentSerializer)
         {
             _documentSerializer = Ensure.IsNotNull(documentSerializer, nameof(documentSerializer));
         }
 
         // public methods
         /// <inheritdoc />
-        protected override ChangeStreamOutput<TDocument> DeserializeValue(BsonDeserializationContext context, BsonDeserializationArgs args)
+        protected override ChangeStreamDocument<TDocument> DeserializeValue(BsonDeserializationContext context, BsonDeserializationArgs args)
         {
             var reader = context.Reader;
 
@@ -106,7 +106,7 @@ protected override ChangeStreamOutput<TDocument> DeserializeValue(BsonDeserializ
             }
             reader.ReadEndDocument();
 
-            return new ChangeStreamOutput<TDocument>(
+            return new ChangeStreamDocument<TDocument>(
                 resumeToken,
                 operationType.Value,
                 collectionNamespace,
@@ -116,7 +116,7 @@ protected override ChangeStreamOutput<TDocument> DeserializeValue(BsonDeserializ
         }
 
         /// <inheritdoc />
-        protected override void SerializeValue(BsonSerializationContext context, BsonSerializationArgs args, ChangeStreamOutput<TDocument> value)
+        protected override void SerializeValue(BsonSerializationContext context, BsonSerializationArgs args, ChangeStreamDocument<TDocument> value)
         {
             var writer = context.Writer;
             writer.WriteStartDocument();

src/MongoDB.Driver.Core/ChangeStreamFullDocumentOptions.cs

@@ -25,7 +25,9 @@ public enum ChangeStreamFullDocumentOption
         /// </summary>
         Default = 0,
         /// <summary>
-        /// Lookup the full document and return it.
+        /// The change stream for partial updates will include both a delta describing the
+        /// changes to the document as well as a copy of the entire document that was
+        /// changed from some time after the change occurred.
         /// </summary>
         UpdateLookup
     }

src/MongoDB.Driver.Core/ChangeStreamUpdateDescription.cs

@@ -19,7 +19,7 @@
 namespace MongoDB.Driver
 {
     /// <summary>
-    /// An UpdateDescription in a ChangeStreamOutput instance.
+    /// An UpdateDescription in a ChangeStreamDocument instance.
     /// </summary>
     public sealed class ChangeStreamUpdateDescription
     {

src/MongoDB.Driver.Core/MongoDB.Driver.Core.csproj

@@ -54,8 +54,8 @@
     <Compile Include="ChangeStreamFullDocumentOptions.cs" />
     <Compile Include="ChangeStreamOperationType.cs" />
     <Compile Include="ChangeStreamOperationTypeSerializer.cs" />
-    <Compile Include="ChangeStreamOutput.cs" />
-    <Compile Include="ChangeStreamOutputSerializer.cs" />
+    <Compile Include="ChangeStreamDocument.cs" />
+    <Compile Include="ChangeStreamDocumentSerializer.cs" />
     <Compile Include="ChangeStreamUpdateDescription.cs" />
     <Compile Include="ChangeStreamUpdateDescriptionSerializer.cs" />
     <Compile Include="Collation.cs" />

src/MongoDB.Driver/AggregateFluent.cs

@@ -98,7 +98,7 @@ public override IAggregateFluent<TNewResult> BucketAuto<TValue, TNewResult>(
             return WithPipeline(_pipeline.BucketAuto(groupBy, buckets, output, options));
         }
 
-        public override IAggregateFluent<ChangeStreamOutput<TResult>> ChangeStream(ChangeStreamStageOptions options = null)
+        public override IAggregateFluent<ChangeStreamDocument<TResult>> ChangeStream(ChangeStreamStageOptions options = null)
         {
             return WithPipeline(_pipeline.ChangeStream(options));
         }

src/MongoDB.Driver/AggregateFluentBase.cs

@@ -86,7 +86,7 @@ public virtual IAggregateFluent<TNewResult> BucketAuto<TValue, TNewResult>(
         }
 
         /// <inheritdoc />
-        public virtual IAggregateFluent<ChangeStreamOutput<TResult>> ChangeStream(ChangeStreamStageOptions options = null)
+        public virtual IAggregateFluent<ChangeStreamDocument<TResult>> ChangeStream(ChangeStreamStageOptions options = null)
         {
             throw new NotImplementedException(); // implemented by subclasses
         }

src/MongoDB.Driver/IAggregateFluent.cs

@@ -129,7 +129,7 @@ IAggregateFluent<TNewResult> BucketAuto<TValue, TNewResult>(
         /// </summary>
         /// <param name="options">The options.</param>
         /// <returns>The fluent aggregate interface.</returns>
-        IAggregateFluent<ChangeStreamOutput<TResult>> ChangeStream(ChangeStreamStageOptions options = null);
+        IAggregateFluent<ChangeStreamDocument<TResult>> ChangeStream(ChangeStreamStageOptions options = null);
 
         /// <summary>
         /// Appends a count stage to the pipeline.

src/MongoDB.Driver/IMongoCollection.cs

@@ -481,7 +481,7 @@ public interface IMongoCollection<TDocument>
         /// A change stream.
         /// </returns>
         IAsyncCursor<TResult> Watch<TResult>(
-            PipelineDefinition<ChangeStreamOutput<TDocument>, TResult> pipeline,
+            PipelineDefinition<ChangeStreamDocument<TDocument>, TResult> pipeline,
             ChangeStreamOptions options = null,
             CancellationToken cancellationToken = default(CancellationToken));
 
@@ -496,7 +496,7 @@ IAsyncCursor<TResult> Watch<TResult>(
         /// A change stream.
         /// </returns>
         Task<IAsyncCursor<TResult>> WatchAsync<TResult>(
-            PipelineDefinition<ChangeStreamOutput<TDocument>, TResult> pipeline,
+            PipelineDefinition<ChangeStreamDocument<TDocument>, TResult> pipeline,
             ChangeStreamOptions options = null,
             CancellationToken cancellationToken = default(CancellationToken));
 

src/MongoDB.Driver/IMongoCollectionExtensions.cs

@@ -1032,12 +1032,12 @@ public static IFindFluent<TDocument, TDocument> Find<TDocument>(this IMongoColle
         /// <returns>
         /// A change stream.
         /// </returns>
-        public static IAsyncCursor<ChangeStreamOutput<TDocument>> Watch<TDocument>(
+        public static IAsyncCursor<ChangeStreamDocument<TDocument>> Watch<TDocument>(
             this IMongoCollection<TDocument> collection,
             ChangeStreamOptions options = null,
             CancellationToken cancellationToken = default(CancellationToken))
         {
-            var emptyPipeline = new EmptyPipelineDefinition<ChangeStreamOutput<TDocument>>();
+            var emptyPipeline = new EmptyPipelineDefinition<ChangeStreamDocument<TDocument>>();
             return collection.Watch(emptyPipeline, options, cancellationToken);
         }
 
@@ -1051,12 +1051,12 @@ public static IAsyncCursor<ChangeStreamOutput<TDocument>> Watch<TDocument>(
         /// <returns>
         /// A change stream.
         /// </returns>
-        public static Task<IAsyncCursor<ChangeStreamOutput<TDocument>>> WatchAsync<TDocument>(
+        public static Task<IAsyncCursor<ChangeStreamDocument<TDocument>>> WatchAsync<TDocument>(
             this IMongoCollection<TDocument> collection,
             ChangeStreamOptions options = null,
             CancellationToken cancellationToken = default(CancellationToken))
         {
-            var emptyPipeline = new EmptyPipelineDefinition<ChangeStreamOutput<TDocument>>();
+            var emptyPipeline = new EmptyPipelineDefinition<ChangeStreamDocument<TDocument>>();
             return collection.WatchAsync(emptyPipeline, options, cancellationToken);
         }
     }