Skip to content

Commit 8aec7ab

Browse files
authored
CSHARP-5323: Mark API as obsolete: Operations + Bindings (#1492)
1 parent 0a450d5 commit 8aec7ab

File tree

67 files changed

+93
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+93
-1
lines changed

src/MongoDB.Driver.Core/Core/Bindings/ChannelReadBinding.cs

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ namespace MongoDB.Driver.Core.Bindings
2525
/// <summary>
2626
/// Represents a read binding that is bound to a channel.
2727
/// </summary>
28+
[Obsolete("This class will be made internal in a later release.")]
2829
public sealed class ChannelReadBinding : IReadBinding
2930
{
3031
// fields

src/MongoDB.Driver.Core/Core/Bindings/ChannelReadWriteBinding.cs

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ namespace MongoDB.Driver.Core.Bindings
2525
/// <summary>
2626
/// Represents a read-write binding that is bound to a channel.
2727
/// </summary>
28+
[Obsolete("This class will be made internal in a later release.")]
2829
public sealed class ChannelReadWriteBinding : IReadWriteBinding
2930
{
3031
// fields

src/MongoDB.Driver.Core/Core/Bindings/ChannelSourceReadWriteBinding.cs

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ namespace MongoDB.Driver.Core.Bindings
2525
/// <summary>
2626
/// Represents a read-write binding to a channel source.
2727
/// </summary>
28+
[Obsolete("This class will be made internal in a later release.")]
2829
public sealed class ChannelSourceReadWriteBinding : IReadWriteBinding
2930
{
3031
// fields

src/MongoDB.Driver.Core/Core/Bindings/IBinding.cs

+8
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ namespace MongoDB.Driver.Core.Bindings
2525
/// Represents a read or write binding associated with a session.
2626
/// </summary>
2727
/// <seealso cref="System.IDisposable" />
28+
[Obsolete("This interface will be made internal in a later release.")]
2829
public interface IBinding : IDisposable
2930
{
3031
/// <summary>
@@ -39,6 +40,7 @@ public interface IBinding : IDisposable
3940
/// <summary>
4041
/// Represents a binding that determines which channel source gets used for read operations.
4142
/// </summary>
43+
[Obsolete("This interface will be made internal in a later release.")]
4244
public interface IReadBinding : IBinding
4345
{
4446
/// <summary>
@@ -83,6 +85,7 @@ public interface IReadBinding : IBinding
8385
/// <summary>
8486
/// Represents a binding that determines which channel source gets used for write operations.
8587
/// </summary>
88+
[Obsolete("This interface will be made internal in a later release.")]
8689
public interface IWriteBinding : IBinding
8790
{
8891
/// <summary>
@@ -153,13 +156,15 @@ public interface IWriteBinding : IBinding
153156
/// <summary>
154157
/// Represents a binding that can be used for both read and write operations.
155158
/// </summary>
159+
[Obsolete("This interface will be made internal in a later release.")]
156160
public interface IReadWriteBinding : IReadBinding, IWriteBinding
157161
{
158162
}
159163

160164
/// <summary>
161165
/// Represents a handle to a read binding.
162166
/// </summary>
167+
[Obsolete("This interface will be made internal in a later release.")]
163168
public interface IReadBindingHandle : IReadBinding
164169
{
165170
/// <summary>
@@ -172,6 +177,7 @@ public interface IReadBindingHandle : IReadBinding
172177
/// <summary>
173178
/// Represents a handle to a write binding.
174179
/// </summary>
180+
[Obsolete("This interface will be made internal in a later release.")]
175181
public interface IWriteBindingHandle : IWriteBinding
176182
{
177183
/// <summary>
@@ -184,6 +190,7 @@ public interface IWriteBindingHandle : IWriteBinding
184190
/// <summary>
185191
/// Represents a handle to a read-write binding.
186192
/// </summary>
193+
[Obsolete("This interface will be made internal in a later release.")]
187194
public interface IReadWriteBindingHandle : IReadWriteBinding, IReadBindingHandle, IWriteBindingHandle
188195
{
189196
/// <summary>
@@ -196,6 +203,7 @@ public interface IReadWriteBindingHandle : IReadWriteBinding, IReadBindingHandle
196203
/// <summary>
197204
/// Represents the criteria for using a secondary for operations that may use a secondary.
198205
/// </summary>
206+
[Obsolete("This interface will be made internal in a later release.")]
199207
public interface IMayUseSecondaryCriteria
200208
{
201209
/// <summary>

src/MongoDB.Driver.Core/Core/Bindings/ReadBindingHandle.cs

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ namespace MongoDB.Driver.Core.Bindings
2525
/// <summary>
2626
/// Represents a handle to a read binding.
2727
/// </summary>
28+
[Obsolete("This class will be made internal in a later release.")]
2829
public sealed class ReadBindingHandle : IReadBindingHandle
2930
{
3031
// fields

src/MongoDB.Driver.Core/Core/Bindings/ReadPreferenceBinding.cs

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ namespace MongoDB.Driver.Core.Bindings
2727
/// <summary>
2828
/// Represents a read binding to a cluster using a ReadPreference to select the server.
2929
/// </summary>
30+
[Obsolete("This class will be made internal in a later release.")]
3031
public sealed class ReadPreferenceBinding : IReadBinding
3132
{
3233
// fields

src/MongoDB.Driver.Core/Core/Bindings/ReadWriteBindingHandle.cs

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ namespace MongoDB.Driver.Core.Bindings
2525
/// <summary>
2626
/// Represents a handle to a read-write binding.
2727
/// </summary>
28+
[Obsolete("This class will be made internal in a later release.")]
2829
public sealed class ReadWriteBindingHandle : IReadWriteBindingHandle
2930
{
3031
// fields

src/MongoDB.Driver.Core/Core/Bindings/SingleServerReadBinding.cs

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ namespace MongoDB.Driver.Core.Bindings
2525
/// <summary>
2626
/// Represents a read binding to a single server;
2727
/// </summary>
28+
[Obsolete("This class will be made internal in a later release.")]
2829
public sealed class SingleServerReadBinding : IReadBinding
2930
{
3031
// private constants

src/MongoDB.Driver.Core/Core/Bindings/SingleServerReadWriteBinding.cs

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ namespace MongoDB.Driver.Core.Bindings
2525
/// <summary>
2626
/// Represents a read/write binding to a single server.
2727
/// </summary>
28+
[Obsolete("This class will be made internal in a later release.")]
2829
public sealed class SingleServerReadWriteBinding : IReadWriteBinding
2930
{
3031
// fields

src/MongoDB.Driver.Core/Core/Bindings/WritableServerBinding.cs

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ namespace MongoDB.Driver.Core.Bindings
2727
/// <summary>
2828
/// Represents a write binding to a writable server.
2929
/// </summary>
30+
[Obsolete("This class will be made internal in a later release.")]
3031
public sealed class WritableServerBinding : IReadWriteBinding
3132
{
3233
// fields

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

-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
* limitations under the License.
1414
*/
1515

16-
using System;
1716
using System.Collections.Generic;
1817
using System.Linq;
1918

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

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ namespace MongoDB.Driver.Core.Operations
3030
/// <summary>
3131
/// Represents an aggregate explain operations.
3232
/// </summary>
33+
[Obsolete("This class will be removed in a later release.")]
3334
public class AggregateExplainOperation : IReadOperation<BsonDocument>
3435
{
3536
// fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ namespace MongoDB.Driver.Core.Operations
3434
/// Represents an aggregate operation.
3535
/// </summary>
3636
/// <typeparam name="TResult">The type of the result values.</typeparam>
37+
[Obsolete("This class will be made internal in a later release.")]
3738
public class AggregateOperation<TResult> : IReadOperation<IAsyncCursor<TResult>>, IExecutableInRetryableReadContext<IAsyncCursor<TResult>>
3839
{
3940
// fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ namespace MongoDB.Driver.Core.Operations
3232
/// <summary>
3333
/// Represents an aggregate operation that writes the results to an output collection.
3434
/// </summary>
35+
[Obsolete("This class will be made internal in a later release.")]
3536
public class AggregateToCollectionOperation : IWriteOperation<BsonDocument>
3637
{
3738
// fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ namespace MongoDB.Driver.Core.Operations
3030
/// <summary>
3131
/// Represents a mixed write bulk operation.
3232
/// </summary>
33+
[Obsolete("This class will be made internal in a later release.")]
3334
public class BulkMixedWriteOperation : IWriteOperation<BulkWriteOperationResult>
3435
{
3536
// fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ namespace MongoDB.Driver.Core.Operations
2222
/// Represents the result of a bulk write operation.
2323
/// </summary>
2424
[Serializable]
25+
[Obsolete("This class will be made internal in a later release.")]
2526
public abstract class BulkWriteOperationResult
2627
{
2728
// fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ namespace MongoDB.Driver.Core.Operations
2323
/// Represents the information about one Upsert.
2424
/// </summary>
2525
[Serializable]
26+
[Obsolete("This class will be made internal in a later release.")]
2627
public class BulkWriteOperationUpsert
2728
{
2829
// fields

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

+2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ namespace MongoDB.Driver.Core.Operations
3131
/// A change stream operation.
3232
/// </summary>
3333
/// <typeparam name="TResult">The type of the result.</typeparam>
34+
[Obsolete("This interface will be made internal in a later release.")]
3435
public interface IChangeStreamOperation<TResult> : IReadOperation<IChangeStreamCursor<TResult>>
3536
{
3637
// properties
@@ -88,6 +89,7 @@ public interface IChangeStreamOperation<TResult> : IReadOperation<IChangeStreamC
8889
/// A change stream operation.
8990
/// </summary>
9091
/// <typeparam name="TResult">The type of the result values.</typeparam>
92+
[Obsolete("This class will be made internal in a later release.")]
9193
public class ChangeStreamOperation<TResult> : IChangeStreamOperation<TResult>
9294
{
9395
// private fields

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

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* limitations under the License.
1414
*/
1515

16+
using System;
1617
using System.Threading;
1718
using System.Threading.Tasks;
1819
using MongoDB.Bson;
@@ -29,6 +30,7 @@ namespace MongoDB.Driver.Core.Operations
2930
/// Represents the base class for a command operation.
3031
/// </summary>
3132
/// <typeparam name="TCommandResult">The type of the command result.</typeparam>
33+
[Obsolete("This class will be made internal in a later release.")]
3234
public abstract class CommandOperationBase<TCommandResult>
3335
{
3436
// fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ namespace MongoDB.Driver.Core.Operations
3030
/// Represents a count documents operation.
3131
/// For a fast estimate of the total documents in a collection see <see cref="CountOperation"/>.
3232
/// </summary>
33+
[Obsolete("This class will be made internal in a later release.")]
3334
public class CountDocumentsOperation : IReadOperation<long>
3435
{
3536
// private fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ namespace MongoDB.Driver.Core.Operations
2929
/// <summary>
3030
/// Represents a count operation.
3131
/// </summary>
32+
[Obsolete("This class will be made internal in a later release.")]
3233
public class CountOperation : IReadOperation<long>, IExecutableInRetryableReadContext<long>
3334
{
3435
// fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ namespace MongoDB.Driver.Core.Operations
3030
/// <summary>
3131
/// Represents a create collection operation.
3232
/// </summary>
33+
[Obsolete("This class will be made internal in a later release.")]
3334
public class CreateCollectionOperation : IWriteOperation<BsonDocument>
3435
{
3536
#region static

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

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ namespace MongoDB.Driver.Core.Operations
3131
/// <summary>
3232
/// Represents a create indexes operation.
3333
/// </summary>
34+
[Obsolete("This class will be made internal in a later release.")]
3435
public class CreateIndexesOperation : IWriteOperation<BsonDocument>
3536
{
3637
// fields

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

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* limitations under the License.
1414
*/
1515

16+
using System;
1617
using MongoDB.Bson;
1718
using MongoDB.Driver.Core.Misc;
1819

@@ -21,6 +22,7 @@ namespace MongoDB.Driver.Core.Operations
2122
/// <summary>
2223
/// Represents a create search index request.
2324
/// </summary>
25+
[Obsolete("This class will be made internal in a later release.")]
2426
public sealed class CreateSearchIndexRequest
2527
{
2628
/// <summary>Gets the index name.</summary>

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

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* limitations under the License.
1414
*/
1515

16+
using System;
1617
using System.Collections.Generic;
1718
using System.Linq;
1819
using System.Threading;
@@ -29,6 +30,7 @@ namespace MongoDB.Driver.Core.Operations
2930
/// <summary>
3031
/// Represents a create view operation.
3132
/// </summary>
33+
[Obsolete("This class will be made internal in a later release.")]
3234
public class CreateViewOperation : IWriteOperation<BsonDocument>
3335
{
3436
// private fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ namespace MongoDB.Driver.Core.Operations
2626
/// <summary>
2727
/// Represents a database exists operation.
2828
/// </summary>
29+
[Obsolete("This class will be made internal in a later release.")]
2930
public class DatabaseExistsOperation : IReadOperation<bool>
3031
{
3132
// fields

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

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* limitations under the License.
1414
*/
1515

16+
using System;
1617
using System.Threading;
1718
using System.Threading.Tasks;
1819
using MongoDB.Driver.Core.Bindings;
@@ -25,6 +26,7 @@ namespace MongoDB.Driver.Core.Operations
2526
/// <summary>
2627
/// Represents a delete operation using the delete opcode.
2728
/// </summary>
29+
[Obsolete("This class will be made internal in a later release.")]
2830
public class DeleteOpcodeOperation : IWriteOperation<WriteConcernResult>, IExecutableInRetryableWriteContext<WriteConcernResult>
2931
{
3032
// fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ namespace MongoDB.Driver.Core.Operations
3232
/// Represents a distinct operation.
3333
/// </summary>
3434
/// <typeparam name="TValue">The type of the value.</typeparam>
35+
[Obsolete("This class will be made internal in a later release.")]
3536
public class DistinctOperation<TValue> : IReadOperation<IAsyncCursor<TValue>>
3637
{
3738
// fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ namespace MongoDB.Driver.Core.Operations
3030
/// <summary>
3131
/// Represents a drop collection operation.
3232
/// </summary>
33+
[Obsolete("This class will be made internal in a later release.")]
3334
public class DropCollectionOperation : IWriteOperation<BsonDocument>
3435
{
3536
#region static

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

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ namespace MongoDB.Driver.Core.Operations
2828
/// <summary>
2929
/// Represents a drop database operation.
3030
/// </summary>
31+
[Obsolete("This class will be made internal in a later release.")]
3132
public class DropDatabaseOperation : IWriteOperation<BsonDocument>
3233
{
3334
// fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ namespace MongoDB.Driver.Core.Operations
2828
/// <summary>
2929
/// Represents a drop index operation.
3030
/// </summary>
31+
[Obsolete("This class will be made internal in a later release.")]
3132
public class DropIndexOperation : IWriteOperation<BsonDocument>
3233
{
3334
// fields

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

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* limitations under the License.
1414
*/
1515

16+
using System;
1617
using System.Threading;
1718
using System.Threading.Tasks;
1819
using MongoDB.Bson;
@@ -27,6 +28,7 @@ namespace MongoDB.Driver.Core.Operations
2728
/// <summary>
2829
/// Represents a drop index operation.
2930
/// </summary>
31+
[Obsolete("This class will be made internal in a later release.")]
3032
internal sealed class DropSearchIndexOperation : IWriteOperation<BsonDocument>
3133
{
3234
// fields

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

+3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ namespace MongoDB.Driver.Core.Operations
2727
/// <summary>
2828
/// Abstract base class for AbortTransactionOperation and CommitTransactionOperation.
2929
/// </summary>
30+
[Obsolete("This class will be made internal in a later release.")]
3031
public abstract class EndTransactionOperation : IReadOperation<BsonDocument>
3132
{
3233
// private fields
@@ -143,6 +144,7 @@ private IReadOperation<BsonDocument> CreateOperation()
143144
/// <summary>
144145
/// The abort transaction operation.
145146
/// </summary>
147+
[Obsolete("This class will be made internal in a later release.")]
146148
public sealed class AbortTransactionOperation : EndTransactionOperation
147149
{
148150
// public constructors
@@ -173,6 +175,7 @@ public AbortTransactionOperation(WriteConcern writeConcern)
173175
/// <summary>
174176
/// The commit transaction operation.
175177
/// </summary>
178+
[Obsolete("This class will be made internal in a later release.")]
176179
public sealed class CommitTransactionOperation : EndTransactionOperation
177180
{
178181
// private fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ namespace MongoDB.Driver.Core.Operations
2727
/// <summary>
2828
/// Represents an estimated document count operation.
2929
/// </summary>
30+
[Obsolete("This class will be made internal in a later release.")]
3031
public class EstimatedDocumentCountOperation : IReadOperation<long>
3132
{
3233
// private fields

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

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ namespace MongoDB.Driver.Core.Operations
2929
/// <summary>
3030
/// Represents an eval operation.
3131
/// </summary>
32+
[Obsolete("This class will be made internal in a later release.")]
3233
public class EvalOperation : IWriteOperation<BsonValue>
3334
{
3435
// fields

0 commit comments

Comments
 (0)