diff --git a/snooty.toml b/snooty.toml index 8fb07ce8..f292fd59 100644 --- a/snooty.toml +++ b/snooty.toml @@ -1,5 +1,6 @@ name = "csharp" title = "C#/.NET" +eol = true toc_landing_pages = [ "/fundamentals/connection", "/fundamentals/crud", @@ -18,6 +19,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" [constants] driver-long = "MongoDB .NET/C# Driver" driver-short = ".NET/C# Driver" +mdb-server = "MongoDB Server" lang-framework = ".NET/C#" framework = ".NET framework" framework-version = "4.8" @@ -36,3 +38,10 @@ string-data-type = "``string``" int-data-type = "``integer``" not-available = "N/A" analyzer = "MongoDB C# Analyzer" + +[[banners]] +targets = ["*"] +variant = "info" +value = """\ + This version of the documentation is archived and no longer supported. View the `current documentation `__ to learn how to `upgrade your version of the {+driver-short+} `__.\ + """ diff --git a/source/fundamentals/aggregation.txt b/source/fundamentals/aggregation.txt index 735210f7..879b37b8 100644 --- a/source/fundamentals/aggregation.txt +++ b/source/fundamentals/aggregation.txt @@ -84,7 +84,7 @@ performing aggregation operations: of 16 megabytes. - Pipeline stages have a memory limit of 100 megabytes by default. If required, you can exceed this limit by setting - the `AllowDiskUse <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.AggregateOptions.AllowDiskUse.html#MongoDB_Driver_AggregateOptions_AllowDiskUse>`__ + the `AllowDiskUse <{+api-root+}/MongoDB.Driver/MongoDB.Driver.AggregateOptions.AllowDiskUse.html#MongoDB_Driver_AggregateOptions_AllowDiskUse>`__ property of the ``AggregateOptions`` object that you pass to the ``Aggregate()`` method. - The :manual:`$graphLookup ` stage has @@ -212,10 +212,10 @@ API Documentation For more information about the aggregation operations discussed in this guide, see the following API documentation: -- `Aggregate() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.Aggregate.html>`__ -- `AggregateOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.AggregateOptions.html>`__ -- `Group() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.PipelineStageDefinitionBuilder.Group.html>`__ -- `Match() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.PipelineStageDefinitionBuilder.Match.html>`__ -- `Where() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.MongoQueryable.Where.html>`__ -- `GroupBy() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.MongoQueryable.GroupBy.html>`__ -- `Select() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.MongoQueryable.Select.html>`__ +- `Aggregate() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.Aggregate.html>`__ +- `AggregateOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.AggregateOptions.html>`__ +- `Group() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.PipelineStageDefinitionBuilder.Group.html>`__ +- `Match() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.PipelineStageDefinitionBuilder.Match.html>`__ +- `Where() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.MongoQueryable.Where.html>`__ +- `GroupBy() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.MongoQueryable.GroupBy.html>`__ +- `Select() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.MongoQueryable.Select.html>`__ diff --git a/source/fundamentals/crud/read-operations/change-streams.txt b/source/fundamentals/crud/read-operations/change-streams.txt index f346ea26..297bb35e 100644 --- a/source/fundamentals/crud/read-operations/change-streams.txt +++ b/source/fundamentals/crud/read-operations/change-streams.txt @@ -310,7 +310,7 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `Watch() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.Watch.html>`__ -- `WatchAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.WatchAsync.html>`__ -- `ChangeStreamOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ChangeStreamOptions.html>`__ -- `UpdateOne() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.UpdateOne.html>`__ \ No newline at end of file +- `Watch() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.Watch.html>`__ +- `WatchAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.WatchAsync.html>`__ +- `ChangeStreamOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ChangeStreamOptions.html>`__ +- `UpdateOne() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.UpdateOne.html>`__ \ No newline at end of file diff --git a/source/fundamentals/database-collection.txt b/source/fundamentals/database-collection.txt index 783d026d..735a4411 100644 --- a/source/fundamentals/database-collection.txt +++ b/source/fundamentals/database-collection.txt @@ -35,18 +35,18 @@ Access a Database ----------------- You can access a database by retrieving an `IMongoDatabase -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.html>`__ instance from your ``IMongoClient`` instance. You can use the returned ``IMongoDatabase`` instance to perform database-level operations and access collections that the database contains. To create an ``IMongoDatabase``, call the `GetDatabase() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.GetDatabase.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.GetDatabase.html>`__ method on an `IMongoClient -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.html>`__ instance, passing the database name as a parameter. You can also pass an optional `MongoDatabaseSettings -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoDatabaseSettings.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoDatabaseSettings.html>`__ as a parameter to customize how you access a database. If you pass the name of a nonexistent database to the ``GetDatabase()`` @@ -68,16 +68,16 @@ List Databases To see a list of your deployment's databases, call the asynchronous `ListDatabaseNamesAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabaseNamesAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabaseNamesAsync.html>`__ method or synchronous `ListDatabaseNames() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabaseNames.html>`__ method on +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabaseNames.html>`__ method on your ``IMongoClient`` instance. To see detailed information about each database, call the asynchronous `ListDatabasesAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabasesAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabasesAsync.html>`__ method or synchronous `ListDatabases() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabases.html>`__ method on +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabases.html>`__ method on your ``IMongoClient`` instance. These methods return fields describing the databases in the cluster, such as their sizes and whether they contain data. @@ -109,9 +109,9 @@ Drop a Database Dropping a database permanently deletes all the data in that database's collections. To drop a database, call the asynchronous `DropDatabaseAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.DropDatabaseAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.DropDatabaseAsync.html>`__ method or synchronous `DropDatabase() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.DropDatabase.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.DropDatabase.html>`__ method on your ``IMongoClient`` instance, passing the database name as the parameter. @@ -147,14 +147,14 @@ Access a Collection ------------------- You can access a collection by retrieving an `IMongoCollection -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.html>`__ instance from your database. You can use an ``IMongoCollection`` instance to perform data operations, create aggregations, and manage indexes. To retrieve an ``IMongoCollection``, call the `GetCollection() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.GetCollection.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.GetCollection.html>`__ method on an ``IMongoDatabase`` instance. You can also pass an optional `MongoCollectionSettings -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCollectionSettings.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCollectionSettings.html>`__ as a parameter to customize how you access a collection. If you pass the name of a nonexistent collection to this method, the @@ -206,14 +206,14 @@ Create a Collection You can explicitly create a collection by calling the asynchronous `CreateCollectionAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.CreateCollectionAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.CreateCollectionAsync.html>`__ method or synchronous `CreateCollection() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.CreateCollection.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.CreateCollection.html>`__ method on your ``IMongoDatabase`` instance. This method takes the collection name and an optional `CreateCollectionOptions -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CreateCollectionOptions.html>`__ type as +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.CreateCollectionOptions.html>`__ type as parameters. You can then access the created collection to perform data operations, create aggregations, and manage indexes. @@ -245,16 +245,16 @@ List Collections To see a list of collections in a database, call the asynchronous `ListCollectionNamesAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionNamesAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionNamesAsync.html>`__ method or synchronous `ListCollectionNames() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionNames.html>`__ method on +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionNames.html>`__ method on your ``IMongoDatabase`` instance. To see detailed information about each database, call the asynchronous `ListCollectionsAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionsAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionsAsync.html>`__ method or synchronous `ListCollections() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollections.html>`__ method on +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollections.html>`__ method on your ``IMongoDatabase`` instance. These methods return fields describing the collections in the database, such as their types and settings. @@ -287,9 +287,9 @@ Drop a Collection Dropping a collection permanently deletes all the data in that collection. To drop a collection, call the asynchronous `DropCollectionAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.DropCollectionAsync.html>`__ method or the +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.DropCollectionAsync.html>`__ method or the synchronous `DropCollection() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.DropCollection.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.DropCollection.html>`__ method on your ``IMongoCollection`` instance. The following code shows how to use the asynchronous diff --git a/source/fundamentals/indexes.txt b/source/fundamentals/indexes.txt index a2542b3c..727f39a3 100644 --- a/source/fundamentals/indexes.txt +++ b/source/fundamentals/indexes.txt @@ -215,7 +215,7 @@ documentation. The Atlas Search Index management methods run asynchronously. The driver methods can return before confirming that they ran successfully. To determine the current status of the indexes, call the - `IMongoSearchIndexManager.List() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Search.IMongoSearchIndexManager.List.html>`__ method. + `IMongoSearchIndexManager.List() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Search.IMongoSearchIndexManager.List.html>`__ method. The following sections contain links to tutorials that demonstrate how to create and interact with Atlas Search indexes. @@ -421,7 +421,7 @@ Server manual. List Indexes ------------ -You can use the `List() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoIndexManager-1.List.html>`__ +You can use the `List() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoIndexManager-1.List.html>`__ method to retrieve a list of indexes in your collection. The following example uses the ``List()`` method to list diff --git a/source/fundamentals/time-series.txt b/source/fundamentals/time-series.txt index b1b2e6c0..ee7c5e8a 100644 --- a/source/fundamentals/time-series.txt +++ b/source/fundamentals/time-series.txt @@ -108,8 +108,8 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `CreateCollection() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.CreateCollection.html>`__ -- `CreateCollectionOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CreateCollectionOptions.html>`__ -- `TimeSeriesOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.TimeSeriesOptions.html>`__ -- `ListCollections() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollections.html>`__ -- `ListCollectionsAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionsAsync.html>`__ +- `CreateCollection() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.CreateCollection.html>`__ +- `CreateCollectionOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CreateCollectionOptions.html>`__ +- `TimeSeriesOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.TimeSeriesOptions.html>`__ +- `ListCollections() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollections.html>`__ +- `ListCollectionsAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionsAsync.html>`__ diff --git a/source/fundamentals/transactions.txt b/source/fundamentals/transactions.txt index 08b44f64..ef2bfab5 100644 --- a/source/fundamentals/transactions.txt +++ b/source/fundamentals/transactions.txt @@ -218,10 +218,10 @@ API Documentation To learn more about any of the types or methods discussed in this guide, see the following API Documentation: -- `IClientSession <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.html>`__ -- `MongoClient <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ -- `StartTransaction() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.StartTransaction.html>`__ -- `AbortTransaction() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.AbortTransaction.html>`__ / `AbortTransactionAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.AbortTransactionAsync.html>`__ -- `CommitTransaction() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.CommitTransaction.html>`__ / `CommitTransactionAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.CommitTransactionAsync.html>`__ -- `WithTransaction() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.WithTransaction.html>`__ / `WithTransactionAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.WithTransactionAsync.html>`__ -- `TransactionOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.TransactionOptions.html>`__ +- `IClientSession <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.html>`__ +- `MongoClient <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ +- `StartTransaction() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.StartTransaction.html>`__ +- `AbortTransaction() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.AbortTransaction.html>`__ / `AbortTransactionAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.AbortTransactionAsync.html>`__ +- `CommitTransaction() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.CommitTransaction.html>`__ / `CommitTransactionAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.CommitTransactionAsync.html>`__ +- `WithTransaction() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.WithTransaction.html>`__ / `WithTransactionAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IClientSession.WithTransactionAsync.html>`__ +- `TransactionOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.TransactionOptions.html>`__ diff --git a/source/upgrade.txt b/source/upgrade.txt index cd277c05..de52ca5f 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -10,7 +10,6 @@ Upgrade Driver Versions :depth: 1 :class: singlecol - Overview -------- @@ -132,9 +131,4 @@ Version 2.14 Release Support Changes - The v2.14 driver drops support for MongoDB Server v3.4 and earlier. To use any driver from v2.14 and later, your MongoDB Server must be v3.6 or - later. To learn how to upgrade your MongoDB Server to v3.6, follow the - link that corresponds to your MongoDB deployment configuration: - - - :ref:`<3.6-upgrade-replica-set>` - - :ref:`<3.6-upgrade-standalone>` - - :ref:`<3.6-upgrade-sharded-cluster>` + later. \ No newline at end of file