diff --git a/snooty.toml b/snooty.toml index dd4bad46..2a4ccd5c 100644 --- a/snooty.toml +++ b/snooty.toml @@ -37,8 +37,7 @@ last-version-2-number = "2.30" version = "v{+version-number+}" example = "https://raw.githubusercontent.com/mongodb/docs-csharp/{+docs-branch+}/source/includes/code-examples" stable-api = "Stable API" -api-root = "https://mongodb.github.io/mongo-csharp-driver/{+version-number+}/html" -new-api-root = "https://mongodb.github.io/mongo-csharp-driver/{+version-number+}.0/api" +api-root = "https://mongodb.github.io/mongo-csharp-driver/{+version-number+}.0/api" bool-data-type = "``boolean``" string-data-type = "``string``" int-data-type = "``integer``" diff --git a/source/aggregation.txt b/source/aggregation.txt index 5fd99c22..d7e7b00f 100644 --- a/source/aggregation.txt +++ b/source/aggregation.txt @@ -100,7 +100,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. Troubleshooting diff --git a/source/aggregation/linq.txt b/source/aggregation/linq.txt index 94be8a2c..08ef82fe 100644 --- a/source/aggregation/linq.txt +++ b/source/aggregation/linq.txt @@ -655,7 +655,7 @@ documents from the ``restaurants`` collection where the ``RestaurantName`` field The preceding example returns a list of ``LookupResult`` objects that each contain a joined document. To learn more about the ``LookupResult`` class, see the `LookupResult API documentation -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.LookupResult-2.html>`__. +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.LookupResult-2.html>`__. You can also use a ``Lookup()`` method overload to specify additional criteria for the join. The following example joins documents from the ``restaurants`` @@ -672,7 +672,7 @@ field in the ``restaurants`` collection and the ``ReviewText`` field in the .Where(review => review.ReviewText.Contains(restaurant.Name))); To view a full list of overloads for the ``Lookup()`` method, see the `Lookup -API documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.MongoQueryable.Lookup.html>`__. +API documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.MongoQueryable.Lookup.html>`__. GroupJoin() +++++++++++ @@ -1216,6 +1216,6 @@ API Documentation For a complete list of supported LINQ methods, see the following API documentation: -- `LINQ <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.html>`__ +- `LINQ <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.html>`__ - `MongoQueryable - <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.MongoQueryable.html>`__ + <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.MongoQueryable.html>`__ diff --git a/source/aggregation/stages.txt b/source/aggregation/stages.txt index df593041..0cdc6965 100644 --- a/source/aggregation/stages.txt +++ b/source/aggregation/stages.txt @@ -355,9 +355,9 @@ To learn more about creating pipeline stages, see For more information about the methods and classes used on this page, 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>`__ -- `EmptyPipelineDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.EmptyPipelineDefinition-1.-ctor.html>`__ -- `BsonDocument <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__ +- `Aggregate() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.Aggregate.html>`__ +- `AggregateOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.AggregateOptions.html>`__ +- `EmptyPipelineDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.EmptyPipelineDefinition-1.-ctor.html>`__ +- `BsonDocument <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__ - `PipelineDefinitionBuilder.AppendStage() - <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.PipelineDefinitionBuilder.AppendStage.html>`__ + <{+api-root+}/MongoDB.Driver/MongoDB.Driver.PipelineDefinitionBuilder.AppendStage.html>`__ diff --git a/source/atlas-search.txt b/source/atlas-search.txt index 13900a77..5d248357 100644 --- a/source/atlas-search.txt +++ b/source/atlas-search.txt @@ -818,13 +818,13 @@ The ``SearchOptions`` class contains the following properties: * - ``CountOptions`` - | The options for counting the search results. - | **Data type**: `SearchCountOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Search.SearchCountOptions.html>`__ + | **Data type**: `SearchCountOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Search.SearchCountOptions.html>`__ | **Default**: ``null`` * - ``Highlight`` - | The options for displaying search terms in their original context. - | **Data type**: `SearchHighlightOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Search.SearchHighlightOptions-1.html>`__ + | **Data type**: `SearchHighlightOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Search.SearchHighlightOptions-1.html>`__ | **Default**: ``null`` * - ``IndexName`` @@ -865,13 +865,13 @@ The ``SearchOptions`` class contains the following properties: * - ``Sort`` - | The sorting criteria to apply to the results. - | **Data type**: `SortDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.SortDefinition-1.html>`__ + | **Data type**: `SortDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.SortDefinition-1.html>`__ | **Default**: ``null`` * - ``Tracking`` - | The options for tracking search terms. - | **Data type**: `SearchTrackingOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Search.SearchTrackingOptions.html>`__ + | **Data type**: `SearchTrackingOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Search.SearchTrackingOptions.html>`__ | **Default**: ``null`` SearchAfter Example diff --git a/source/atlas-vector-search.txt b/source/atlas-vector-search.txt index 0d9bb208..ddd620b0 100644 --- a/source/atlas-vector-search.txt +++ b/source/atlas-vector-search.txt @@ -261,14 +261,14 @@ API Documentation To learn more about any of the functions or types discussed in this guide, see the following API Documentation: -- `BinaryVectorFloat32 <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BinaryVectorFloat32.html>`__ -- `BinaryVectorInt8 <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BinaryVectorInt8.html>`__ -- `BinaryVectorPackedBit <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BinaryVectorPackedBit.html>`__ -- `QueryVector <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.QueryVector.html>`__ -- `ToQueryVector() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BinaryVectorDriverExtensions.ToQueryVector.html>`__ -- `IAggregateFluentExtensions.VectorSearch() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAggregateFluentExtensions.VectorSearch.html>`__ +- `BinaryVectorFloat32 <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BinaryVectorFloat32.html>`__ +- `BinaryVectorInt8 <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BinaryVectorInt8.html>`__ +- `BinaryVectorPackedBit <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BinaryVectorPackedBit.html>`__ +- `QueryVector <{+api-root+}/MongoDB.Driver/MongoDB.Driver.QueryVector.html>`__ +- `ToQueryVector() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BinaryVectorDriverExtensions.ToQueryVector.html>`__ +- `IAggregateFluentExtensions.VectorSearch() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IAggregateFluentExtensions.VectorSearch.html>`__ - `Aggregate() - <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Aggregate.html>`__ -- `MongoQueryable.VectorSearch() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.MongoQueryable.VectorSearch.html>`__ + <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Aggregate.html>`__ +- `MongoQueryable.VectorSearch() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Linq.MongoQueryable.VectorSearch.html>`__ - `PipelineStageDefinitionBuilder.VectorSearch() - <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.PipelineStageDefinitionBuilder.VectorSearch.html>`__ + <{+api-root+}/MongoDB.Driver/MongoDB.Driver.PipelineStageDefinitionBuilder.VectorSearch.html>`__ diff --git a/source/connect/connection-options.txt b/source/connect/connection-options.txt index 2eedf30e..27215cc5 100644 --- a/source/connect/connection-options.txt +++ b/source/connect/connection-options.txt @@ -1091,11 +1091,11 @@ Miscellaneous Options .. tip:: Freeze Settings You can freeze the settings on a ``MongoClientSettings`` object by calling its - `Freeze() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.Freeze.html>`__ + `Freeze() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.Freeze.html>`__ method. This prevents any further changes to the settings. Alternatively, you can call the `FrozenCopy() - <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.FrozenCopy.html>`__ + <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.FrozenCopy.html>`__ method to create a new ``MongoClientSettings`` object with the current settings frozen. LibraryInfo @@ -1349,22 +1349,22 @@ Additional Information For more information about the types used on this page, see the following API documentation: -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ -- `MongoUrl <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoUrl.html>`__ -- `MongoUrlBuilder <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoUrlBuilder.html>`__ -- `AutoEncryptionOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.AutoEncryptionOptions.html>`__ -- `ClusterDescriptionChangedEvent <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Events.ClusterDescriptionChangedEvent.html>`__ -- `ClusterOpenedEvent <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Events.ClusterOpenedEvent.html>`__ -- `CollectionNamespace <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollectionNamespace.html>`__ -- `CompressorConfiguration <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.CompressorConfiguration.html>`__ -- `CompressorType <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Compression.CompressorType.html>`__ -- `ConnectionStringScheme <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.ConnectionStringScheme.html>`__ -- `ExpressionTranslationOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ExpressionTranslationOptions.html>`__ -- `LoggingSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.LoggingSettings.html>`__ -- `MongoCredential <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Credential.html>`__ -- `MongoServerAddress <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoServerAddress.html>`__ -- `ReadConcern <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReadConcern.html>`__ -- `ReadConcernLevel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReadConcernLevel.html>`__ -- `ReadPreference <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReadPreference.html>`__ -- `ServerApi <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ServerApi.html>`__ -- `WriteConcern <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.WriteConcern.html>`__ \ No newline at end of file +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `MongoUrl <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoUrl.html>`__ +- `MongoUrlBuilder <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoUrlBuilder.html>`__ +- `AutoEncryptionOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.AutoEncryptionOptions.html>`__ +- `ClusterDescriptionChangedEvent <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Events.ClusterDescriptionChangedEvent.html>`__ +- `ClusterOpenedEvent <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Events.ClusterOpenedEvent.html>`__ +- `CollectionNamespace <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CollectionNamespace.html>`__ +- `CompressorConfiguration <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.CompressorConfiguration.html>`__ +- `CompressorType <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Compression.CompressorType.html>`__ +- `ConnectionStringScheme <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.ConnectionStringScheme.html>`__ +- `ExpressionTranslationOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ExpressionTranslationOptions.html>`__ +- `LoggingSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.LoggingSettings.html>`__ +- `MongoCredential <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Credential.html>`__ +- `MongoServerAddress <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoServerAddress.html>`__ +- `ReadConcern <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReadConcern.html>`__ +- `ReadConcernLevel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReadConcernLevel.html>`__ +- `ReadPreference <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReadPreference.html>`__ +- `ServerApi <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ServerApi.html>`__ +- `WriteConcern <{+api-root+}/MongoDB.Driver/MongoDB.Driver.WriteConcern.html>`__ \ No newline at end of file diff --git a/source/connect/connection-options/connection-pools.txt b/source/connect/connection-options/connection-pools.txt index e2d7d3d0..d8c4c2fe 100644 --- a/source/connect/connection-options/connection-pools.txt +++ b/source/connect/connection-options/connection-pools.txt @@ -147,5 +147,5 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `MongoClient <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `MongoClient <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ diff --git a/source/connect/connection-options/network-compression.txt b/source/connect/connection-options/network-compression.txt index 79ac774c..36c95d6f 100644 --- a/source/connect/connection-options/network-compression.txt +++ b/source/connect/connection-options/network-compression.txt @@ -55,7 +55,7 @@ specify the algorithms you want to use in one of the following ways: :tabid: mongoclientsettings To enable compression by using - `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__, + `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__, set the ``Compressors`` property of your ``MongoClientSettings`` object to a ``List`` of one or more ``CompressorConfiguration`` objects. Each ``CompressorConfiguration`` object in the ``List`` represents an algorithm you diff --git a/source/connect/connection-options/server-selection.txt b/source/connect/connection-options/server-selection.txt index fc750f3d..255e6044 100644 --- a/source/connect/connection-options/server-selection.txt +++ b/source/connect/connection-options/server-selection.txt @@ -109,7 +109,7 @@ class to select a server at random before the standard server selection logic ru :dedent: To learn more about the different server selector classes, see the -`ServerSelectors API documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Clusters.ServerSelectors.html>`__. +`ServerSelectors API documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Clusters.ServerSelectors.html>`__. Implementing Custom Server Selection Logic ------------------------------------------ @@ -158,7 +158,7 @@ in your connection URI: | still be eligible for server selection. Specifying ``-1`` means no maximum. | See :ref:`read preference ` for more information. | - | **Data Type**: `ReadPreference <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReadPreference.html>`__ + | **Data Type**: `ReadPreference <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReadPreference.html>`__ | **Default**: ``ReadPreference.Primary`` | **Connection URI Example**: @@ -187,9 +187,9 @@ API Documentation To learn more about the classes and methods used in this guide, see the following API documentation: -- `MongoClient <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ -- `ClusterConfigurator <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.ClusterConfigurator.html>`__ -- `ServerSelectors <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Clusters.ServerSelectors.html>`__ -- `IServerSelector <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Clusters.ServerSelectors.IServerSelector.html>`__ -- `SelectServer() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Clusters.ServerSelectors.IServerSelector.SelectServers.html>`__ +- `MongoClient <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `ClusterConfigurator <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.ClusterConfigurator.html>`__ +- `ServerSelectors <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Clusters.ServerSelectors.html>`__ +- `IServerSelector <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Clusters.ServerSelectors.IServerSelector.html>`__ +- `SelectServer() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Clusters.ServerSelectors.IServerSelector.SelectServers.html>`__ diff --git a/source/connect/connection-options/stable-api.txt b/source/connect/connection-options/stable-api.txt index e51768bb..912002bb 100644 --- a/source/connect/connection-options/stable-api.txt +++ b/source/connect/connection-options/stable-api.txt @@ -118,8 +118,8 @@ API Documentation For more information on using the {+stable-api+} with the {+driver-long+}, see the following API documentation: -- `MongoClient <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ -- `ServerApiVersion <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ServerApiVersion.html>`__ -- `ServerApi <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ServerApi.html>`__ +- `MongoClient <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `ServerApiVersion <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ServerApiVersion.html>`__ +- `ServerApi <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ServerApi.html>`__ diff --git a/source/connect/connection-targets.txt b/source/connect/connection-targets.txt index fa97f8fe..4b06019b 100644 --- a/source/connect/connection-targets.txt +++ b/source/connect/connection-targets.txt @@ -174,5 +174,5 @@ API Documentation To learn more about the types discussed in this guide, see the following API documentation: -- `MongoClient <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `MongoClient <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ diff --git a/source/connect/mongoclient.txt b/source/connect/mongoclient.txt index e4ef8697..7bf6ba66 100644 --- a/source/connect/mongoclient.txt +++ b/source/connect/mongoclient.txt @@ -114,5 +114,5 @@ API Documentation To learn more about creating a ``MongoClient`` object with the {+driver-short+}, see the following API documentation: -- `MongoClient <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `MongoClient <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ diff --git a/source/crud/bulk-write.txt b/source/crud/bulk-write.txt index ff3fc766..339b4a29 100644 --- a/source/crud/bulk-write.txt +++ b/source/crud/bulk-write.txt @@ -444,7 +444,7 @@ following parameters: * - ``collectionNamespace`` - | The database and collection to insert the BSON document into. | - | **Data Type:** {+string-data-type+} or `CollectionNamespace <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollectionNamespace.html>`__ + | **Data Type:** {+string-data-type+} or `CollectionNamespace <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CollectionNamespace.html>`__ * - ``document`` - | The document to insert into the collection. @@ -479,27 +479,27 @@ parameters: * - ``collectionNamespace`` - | The database and collection to insert the BSON document into. | - | **Data Type:** {+string-data-type+} or `CollectionNamespace <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollectionNamespace.html>`__ + | **Data Type:** {+string-data-type+} or `CollectionNamespace <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CollectionNamespace.html>`__ * - ``filter`` - | The **query filter** that specifies the criteria used to match documents in your collection. The ``UpdateOne`` operation updates *only the first document* that matches the query filter. | - | **Data Type:** `FilterDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ + | **Data Type:** `FilterDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ * - ``update`` - | The update operation you want to perform. For more information about update operations, see :manual:`Field Update Operators ` in the {+mdb-server+} manual. | - | **Data Type:** `UpdateDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinition-1.html>`__ + | **Data Type:** `UpdateDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinition-1.html>`__ * - ``collation`` - | *Optional.* The language collation to use when sorting results. See the :ref:`` section of this page for more information. | - | **Data Type:** `Collation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Collation.html>`__ + | **Data Type:** `Collation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Collation.html>`__ | **Default:** ``null`` * - ``hint`` @@ -507,7 +507,7 @@ parameters: See the :manual:`{+mdb-server+} manual` for more information. | - | **Data Type:** `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ + | **Data Type:** `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ | **Default:** ``null`` * - ``isUpsert`` @@ -573,14 +573,14 @@ constructor accepts the following parameters: * - ``collectionNamespace`` - | The database and collection to insert the BSON document into. | - | **Data Type:** {+string-data-type+} or `CollectionNamespace <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollectionNamespace.html>`__ + | **Data Type:** {+string-data-type+} or `CollectionNamespace <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CollectionNamespace.html>`__ * - ``filter`` - | The **query filter** that specifies the criteria used to match documents in your collection. The ``UpdateOne`` operation updates *only the first document* that matches the query filter. | - | **Data Type:** `FilterDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ + | **Data Type:** `FilterDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ * - ``replacement`` - | The replacement document, which specifies the fields and values to insert in the @@ -592,7 +592,7 @@ constructor accepts the following parameters: - | *Optional.* The language collation to use when sorting results. See the :ref:`` section of this page for more information. | - | **Data Type:** `Collation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Collation.html>`__ + | **Data Type:** `Collation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Collation.html>`__ | **Default:** ``null`` * - ``hint`` @@ -600,7 +600,7 @@ constructor accepts the following parameters: See the :manual:`{+mdb-server+} manual` for more information. | - | **Data Type:** `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ + | **Data Type:** `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ | **Default:** ``null`` * - ``isUpsert`` @@ -640,20 +640,20 @@ parameters: * - ``collectionNamespace`` - | The database and collection to insert the BSON document into. | - | **Data Type:** {+string-data-type+} or `CollectionNamespace <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollectionNamespace.html>`__ + | **Data Type:** {+string-data-type+} or `CollectionNamespace <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CollectionNamespace.html>`__ * - ``filter`` - | The **query filter** that specifies the criteria used to match documents in your collection. The ``DeleteOne`` operation deletes *only the first document* that matches the query filter. | - | **Data Type:** `FilterDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ + | **Data Type:** `FilterDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ * - ``collation`` - | *Optional.* The language collation to use when sorting results. See the :ref:`` section of this page for more information. | - | **Data Type:** `Collation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Collation.html>`__ + | **Data Type:** `Collation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Collation.html>`__ | **Default:** ``null`` * - ``hint`` @@ -661,7 +661,7 @@ parameters: See the :manual:`{+mdb-server+} manual` for more information. | - | **Data Type:** `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ + | **Data Type:** `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ | **Default:** ``null`` In the following code example, the ``BulkWriteDeleteOneModel`` objects @@ -886,7 +886,7 @@ A ``ClientBulkWriteException`` object contains the following properties: * - ``connectionId`` - | The connection identifier. | - | **Data Type:** `ConnectionId <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Connections.ConnectionId.html>`__ + | **Data Type:** `ConnectionId <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Connections.ConnectionId.html>`__ * - ``message`` - | The error message. | @@ -894,15 +894,15 @@ A ``ClientBulkWriteException`` object contains the following properties: * - ``writeErrors`` - | A dictionary of errors that occurred during the bulk write operation. | - | **Data Type:** IReadOnlyDictionary`__> + | **Data Type:** IReadOnlyDictionary`__> * - ``partialResult`` - | The results of any successful operations performed before the exception was thrown. | - | **Data Type:** `ClientBulkWriteResult <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ClientBulkWriteResult.html>`__ + | **Data Type:** `ClientBulkWriteResult <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ClientBulkWriteResult.html>`__ * - ``writeConcernErrors`` - | Write concern errors that occurred during execution of the bulk write operation. | - | **Data Type:** IReadOnlyList<`MongoWriteConcernException <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoWriteConcernException.html>`__> + | **Data Type:** IReadOnlyList<`MongoWriteConcernException <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoWriteConcernException.html>`__> * - ``innerException`` - | The inner exception. | @@ -933,31 +933,31 @@ guide, see the following API documentation: - Collection Bulk Write - - `BulkWrite() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.BulkWrite.html>`__ - - `BulkWriteAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.BulkWriteAsync.html>`__ - - `BulkWriteOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteOptions.-ctor.html>`__ - - `BulkWriteResult <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteResult.html>`__ - - `InsertOneModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.InsertOneModel-1.html>`__ - - `UpdateOneModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateOneModel-1.html>`__ - - `UpdateManyModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateManyModel-1.html>`__ - - `ReplaceOneModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReplaceOneModel-1.html>`__ - - `DeleteOneModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.DeleteOneModel-1.html>`__ - - `DeleteManyModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.DeleteManyModel-1.html>`__ - - `BulkWriteError <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteError.html>`__ + - `BulkWrite() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.BulkWrite.html>`__ + - `BulkWriteAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.BulkWriteAsync.html>`__ + - `BulkWriteOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteOptions.-ctor.html>`__ + - `BulkWriteResult <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteResult.html>`__ + - `InsertOneModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.InsertOneModel-1.html>`__ + - `UpdateOneModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateOneModel-1.html>`__ + - `UpdateManyModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateManyModel-1.html>`__ + - `ReplaceOneModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReplaceOneModel-1.html>`__ + - `DeleteOneModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.DeleteOneModel-1.html>`__ + - `DeleteManyModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.DeleteManyModel-1.html>`__ + - `BulkWriteError <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteError.html>`__ - Client Bulk Write - - `BulkWrite() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.BulkWrite.html>`__ - - `BulkWriteAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.BulkWriteAsync.html>`__ - - `ClientBulkWriteOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ClientBulkWriteOptions.html>`__ - - `ClientBulkWriteResult <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ClientBulkWriteResult.html>`__ - - `BulkWriteInsertOneModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteInsertOneModel-1.html>`__ - - `BulkWriteUpdateOneModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteUpdateOneModel-1.html>`__ - - `BulkWriteUpdateManyModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteUpdateManyModel-1.html>`__ - - `BulkWriteReplaceOneModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteReplaceOneModel-1.html>`__ - - `BulkWriteDeleteOneModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteDeleteOneModel-1.html>`__ - - `BulkWriteDeleteManyModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteDeleteManyModel-1.html>`__ - - `BulkWriteInsertOneResult <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteInsertOneResult.html>`__ - - `BulkWriteUpdateResult <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteUpdateResult.html>`__ - - `BulkWriteDeleteResult <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteDeleteResult.html>`__ - - `ClientBulkWriteException <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ClientBulkWriteException.html>`__ + - `BulkWrite() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.BulkWrite.html>`__ + - `BulkWriteAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.BulkWriteAsync.html>`__ + - `ClientBulkWriteOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ClientBulkWriteOptions.html>`__ + - `ClientBulkWriteResult <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ClientBulkWriteResult.html>`__ + - `BulkWriteInsertOneModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteInsertOneModel-1.html>`__ + - `BulkWriteUpdateOneModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteUpdateOneModel-1.html>`__ + - `BulkWriteUpdateManyModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteUpdateManyModel-1.html>`__ + - `BulkWriteReplaceOneModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteReplaceOneModel-1.html>`__ + - `BulkWriteDeleteOneModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteDeleteOneModel-1.html>`__ + - `BulkWriteDeleteManyModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteDeleteManyModel-1.html>`__ + - `BulkWriteInsertOneResult <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteInsertOneResult.html>`__ + - `BulkWriteUpdateResult <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteUpdateResult.html>`__ + - `BulkWriteDeleteResult <{+api-root+}/MongoDB.Driver/MongoDB.Driver.BulkWriteDeleteResult.html>`__ + - `ClientBulkWriteException <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ClientBulkWriteException.html>`__ diff --git a/source/crud/configure.txt b/source/crud/configure.txt index bcaa7ddc..80a7ba35 100644 --- a/source/crud/configure.txt +++ b/source/crud/configure.txt @@ -238,9 +238,9 @@ API Documentation To learn more about any of the types discussed in this guide, see the following API documentation: -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ -- `MongoDatabaseSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoDatabaseSettings.html>`__ -- `MongoCollectionSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCollectionSettings.html>`__ -- `WriteConcern <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.WriteConcern.html>`__ -- `ReadConcern <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReadConcern.html>`__ -- `ReadPreference <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReadPreference.html>`__ \ No newline at end of file +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `MongoDatabaseSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoDatabaseSettings.html>`__ +- `MongoCollectionSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCollectionSettings.html>`__ +- `WriteConcern <{+api-root+}/MongoDB.Driver/MongoDB.Driver.WriteConcern.html>`__ +- `ReadConcern <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReadConcern.html>`__ +- `ReadPreference <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReadPreference.html>`__ \ No newline at end of file diff --git a/source/crud/delete.txt b/source/crud/delete.txt index d006f1fe..c4d78013 100644 --- a/source/crud/delete.txt +++ b/source/crud/delete.txt @@ -232,9 +232,9 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API Documentation: -- `DeleteOne() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteOne.html>`__ -- `DeleteOneAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteOneAsync.html>`__ -- `DeleteMany() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteMany.html>`__ -- `DeleteManyAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteManyAsync.html>`__ -- `DeleteOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.DeleteOptions.html>`__ -- `DeleteResult <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.DeleteResult.html>`__ \ No newline at end of file +- `DeleteOne() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteOne.html>`__ +- `DeleteOneAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteOneAsync.html>`__ +- `DeleteMany() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteMany.html>`__ +- `DeleteManyAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteManyAsync.html>`__ +- `DeleteOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.DeleteOptions.html>`__ +- `DeleteResult <{+api-root+}/MongoDB.Driver/MongoDB.Driver.DeleteResult.html>`__ \ No newline at end of file diff --git a/source/crud/gridfs.txt b/source/crud/gridfs.txt index 3e12fa98..2e61aa1a 100644 --- a/source/crud/gridfs.txt +++ b/source/crud/gridfs.txt @@ -117,19 +117,19 @@ the ``GridFSBucket()`` constructor. The following table describes the properties - The read concern to use for bucket operations. The default value is the database's read concern. - **Data type**: `ReadConcern <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReadConcern.html>`__ + **Data type**: `ReadConcern <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReadConcern.html>`__ * - ``ReadPreference`` - The read preference to use for bucket operations. The default value is the database's read preference. - **Data type**: `ReadPreference <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReadPreference.html>`__ + **Data type**: `ReadPreference <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReadPreference.html>`__ * - ``WriteConcern`` - The write concern to use for bucket operations. The default value is the database's write concern. - **Data type**: `WriteConcern <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.WriteConcern.html>`__ + **Data type**: `WriteConcern <{+api-root+}/MongoDB.Driver/MongoDB.Driver.WriteConcern.html>`__ The following example creates a bucket named ``"myCustomBucket"`` by passing an instance of the ``GridFSBucketOptions`` class to the ``GridFSBucket()`` constructor: @@ -176,7 +176,7 @@ stream for a given file name. These methods accept the following parameters: - *Optional.* An instance of the ``GridFSUploadOptions`` class that specifies the configuration for the upload stream. The default value is ``null``. - **Data type**: `GridFSUploadOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSUploadOptions.html>`__ + **Data type**: `GridFSUploadOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSUploadOptions.html>`__ * - ``cancellationToken`` - *Optional.* A token that you can use to cancel the operation. @@ -245,7 +245,7 @@ method. The ``GridFSUploadOptions`` class contains the following properties: The default value is ``null``. - **Data type**: `BsonDocument <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__ + **Data type**: `BsonDocument <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__ The following example performs the same steps as the preceding example, but also uses the ``ChunkSizeBytes`` option to specify the size of each chunk. Select the @@ -301,7 +301,7 @@ contents of a stream to a new GridFS file. These methods accept the following pa - *Optional.* An instance of the ``GridFSUploadOptions`` class that specifies the configuration for the upload stream. The default value is ``null``. - **Data type**: `GridFSUploadOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSUploadOptions.html>`__ + **Data type**: `GridFSUploadOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSUploadOptions.html>`__ * - ``cancellationToken`` - *Optional.* A token that you can use to cancel the operation. @@ -369,12 +369,12 @@ download stream. These methods accept the following parameters: * - ``id`` - The ``_id`` value of the file to download. - **Data type**: `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ + **Data type**: `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ * - ``options`` - *Optional.* An instance of the ``GridFSDownloadOptions`` class that specifies the configuration for the download stream. The default value is ``null``. - **Data type**: `GridFSDownloadOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSDownloadOptions.html>`__ + **Data type**: `GridFSDownloadOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSDownloadOptions.html>`__ * - ``cancellationToken`` - *Optional.* A token that you can use to cancel the operation. @@ -472,7 +472,7 @@ contents of a GridFS file to an existing stream. These methods accept the follow * - ``id`` - The ``_id`` value of the file to download. - **Data type**: `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ + **Data type**: `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ * - ``destination`` - The stream that the {+driver-short+} downloads the GridFS file to. This property's value must be an object that implements the ``Stream`` class. @@ -482,7 +482,7 @@ contents of a GridFS file to an existing stream. These methods accept the follow - *Optional.* An instance of the ``GridFSDownloadOptions`` class that specifies the configuration for the download stream. The default value is ``null``. - **Data type**: `GridFSDownloadOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSDownloadOptions.html>`__ + **Data type**: `GridFSDownloadOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSDownloadOptions.html>`__ * - ``cancellationToken`` - *Optional.* A token that you can use to cancel the operation. @@ -540,7 +540,7 @@ on your ``GridFSBucket`` instance. These methods accept the following parameters **Data type**: ``FilterDefinition``. For more information, see the API documentation for the - `Find() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.Find.html>`__ + `Find() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.Find.html>`__ method. * - ``source`` @@ -552,7 +552,7 @@ on your ``GridFSBucket`` instance. These methods accept the following parameters - *Optional.* An instance of the ``GridFSFindOptions`` class that specifies the configuration for the find operation. The default value is ``null``. - **Data type**: `GridFSFindOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSFindOptions.html>`__ + **Data type**: `GridFSFindOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSFindOptions.html>`__ * - ``cancellationToken`` - *Optional.* A token that you can use to cancel the operation. @@ -628,7 +628,7 @@ To customize the find operation, pass an instance of the **Data type**: ``SortDefinition``. For more information, see the API documentation for the - `Sort <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSFindOptions.Sort.html>`__ + `Sort <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSFindOptions.Sort.html>`__ property. .. _csharp-gridfs-delete-files: @@ -651,7 +651,7 @@ The ``Delete`` and ``DeleteAsync()`` methods accept the following parameters: * - ``id`` - The ``_id`` of the file to delete. - **Data type**: `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ + **Data type**: `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ * - ``cancellationToken`` - *Optional.* A token that you can use to cancel the operation. @@ -700,25 +700,25 @@ API Documentation To learn more about the classes used on this page, see the following API documentation: -- `GridFSBucket <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.html>`__ -- `GridFSBucketOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucketOptions.html>`__ -- `GridFSDownloadOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSDownloadOptions.html>`__ -- `GridFSFindOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSFindOptions.html>`__ -- `GridFSUploadOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSUploadOptions.html>`__ -- `GridFSFileInfo <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSFileInfo.html>`__ +- `GridFSBucket <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.html>`__ +- `GridFSBucketOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucketOptions.html>`__ +- `GridFSDownloadOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSDownloadOptions.html>`__ +- `GridFSFindOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSFindOptions.html>`__ +- `GridFSUploadOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSUploadOptions.html>`__ +- `GridFSFileInfo <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSFileInfo.html>`__ To learn more about the methods in the ``GridFSBucket`` class used on this page, see the following API documentation: -- `OpenUploadStream() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.OpenUploadStream.html>`__ -- `OpenUploadStreamAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.OpenUploadStreamAsync.html>`__ -- `UploadFromStream() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.UploadFromStream.html>`__ -- `UploadFromStreamAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.UploadFromStreamAsync.html>`__ -- `OpenDownloadStream() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.OpenDownloadStream.html>`__ -- `OpenDownloadStreamAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.OpenDownloadStreamAsync.html>`__ -- `DownloadToStream() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.DownloadToStream.html>`__ -- `DownloadToStreamAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.DownloadToStreamAsync.html>`__ -- `Find() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.Find.html>`__ -- `FindAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.FindAsync.html>`__ -- `Delete() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.Delete.html>`__ -- `DeleteAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.DeleteAsync.html>`__ \ No newline at end of file +- `OpenUploadStream() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.OpenUploadStream.html>`__ +- `OpenUploadStreamAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.OpenUploadStreamAsync.html>`__ +- `UploadFromStream() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.UploadFromStream.html>`__ +- `UploadFromStreamAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.UploadFromStreamAsync.html>`__ +- `OpenDownloadStream() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.OpenDownloadStream.html>`__ +- `OpenDownloadStreamAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.OpenDownloadStreamAsync.html>`__ +- `DownloadToStream() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.DownloadToStream.html>`__ +- `DownloadToStreamAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.DownloadToStreamAsync.html>`__ +- `Find() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.Find.html>`__ +- `FindAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.FindAsync.html>`__ +- `Delete() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.Delete.html>`__ +- `DeleteAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GridFS.GridFSBucket.DeleteAsync.html>`__ \ No newline at end of file diff --git a/source/crud/insert.txt b/source/crud/insert.txt index d6daf656..bfbed843 100644 --- a/source/crud/insert.txt +++ b/source/crud/insert.txt @@ -294,12 +294,12 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API Documentation: -- `InsertOne() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertOne.html>`__ -- `InsertOneAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertOneAsync.html>`__ -- `InsertMany() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertMany.html>`__ -- `InsertManyAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertManyAsync.html>`__ -- `InsertOneOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.InsertOneOptions.html>`__ -- `InsertManyOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.InsertManyOptions.html>`__ +- `InsertOne() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertOne.html>`__ +- `InsertOneAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertOneAsync.html>`__ +- `InsertMany() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertMany.html>`__ +- `InsertManyAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertManyAsync.html>`__ +- `InsertOneOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.InsertOneOptions.html>`__ +- `InsertManyOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.InsertManyOptions.html>`__ .. _csharp-insert-instruqt-lab: diff --git a/source/crud/query/count.txt b/source/crud/query/count.txt index 76e8b486..00e73560 100644 --- a/source/crud/query/count.txt +++ b/source/crud/query/count.txt @@ -247,7 +247,7 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API Documentation: -- `CountDocuments() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.CountDocuments.html>`__ -- `CountOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CountOptions.html>`__ -- `EstimatedDocumentCount() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.EstimatedDocumentCount.html>`__ -- `EstimatedDocumentCountOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.EstimatedDocumentCountOptions.html>`__ +- `CountDocuments() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.CountDocuments.html>`__ +- `CountOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CountOptions.html>`__ +- `EstimatedDocumentCount() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.EstimatedDocumentCount.html>`__ +- `EstimatedDocumentCountOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.EstimatedDocumentCountOptions.html>`__ diff --git a/source/crud/query/cursors.txt b/source/crud/query/cursors.txt index a3307199..3742365f 100644 --- a/source/crud/query/cursors.txt +++ b/source/crud/query/cursors.txt @@ -172,8 +172,8 @@ API Documentation To learn more about the methods and classes used in this guide, see the following API documentation: -- `FindSync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.FindSync.html>`__ -- `FindAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.FindAsync.html>`__ -- `Find() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Find.html>`__ -- `IAsyncCursor <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursor-1.html>`__ -- `FindOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FindOptions.html>`__ +- `FindSync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.FindSync.html>`__ +- `FindAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.FindAsync.html>`__ +- `Find() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Find.html>`__ +- `IAsyncCursor <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursor-1.html>`__ +- `FindOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.FindOptions.html>`__ diff --git a/source/crud/query/distinct.txt b/source/crud/query/distinct.txt index 640f38b5..2525e6ef 100644 --- a/source/crud/query/distinct.txt +++ b/source/crud/query/distinct.txt @@ -183,7 +183,7 @@ describes the properties you can set on a ``DistinctOptions`` instance: - | Sets the collation to use for the operation. See the :ref:`` section of this page for more information. | Default: ``null`` - | **Data type**: `Collation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.DistinctOptions.Collation.html>`__ + | **Data type**: `Collation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.DistinctOptions.Collation.html>`__ * - ``MaxTime`` - | Sets the maximum amount of time that the operation can run. @@ -191,7 +191,7 @@ describes the properties you can set on a ``DistinctOptions`` instance: * - ``Comment`` - | Attaches a comment to the operation. - | **Data type**: `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ or ``string`` + | **Data type**: `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ or ``string`` The following example retrieves the distinct values of the ``name`` field for all documents that have a ``borough`` field value of ``"Bronx"`` and a @@ -264,6 +264,6 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `Distinct() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.Distinct.html>`__ -- `DistinctAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DistinctAsync.html>`__ -- `DistinctOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.DistinctOptions.html>`__ \ No newline at end of file +- `Distinct() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.Distinct.html>`__ +- `DistinctAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DistinctAsync.html>`__ +- `DistinctOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.DistinctOptions.html>`__ \ No newline at end of file diff --git a/source/crud/query/find.txt b/source/crud/query/find.txt index de2005fb..d7e1e1a5 100644 --- a/source/crud/query/find.txt +++ b/source/crud/query/find.txt @@ -228,7 +228,7 @@ You can configure the commonly used options with the following methods: - | Sets the maximum execution time on the server for this operation. To see a full list of available options, see -`FindOptions Properties <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FindOptions.html>`__. +`FindOptions Properties <{+api-root+}/MongoDB.Driver/MongoDB.Driver.FindOptions.html>`__. .. _csharp-find-collation: @@ -300,14 +300,14 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API Documentation: -- `Find() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Find.html>`__ -- `FirstOrDefault() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluentExtensions.FirstOrDefault.html>`__ -- `FirstOrDefaultAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSourceExtensions.FirstOrDefaultAsync.html>`__ -- `FindOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FindOptions.html>`__ -- `ToList() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSourceExtensions.ToList.html>`__ -- `ToListAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSourceExtensions.FirstOrDefaultAsync.html>`__ -- `ToCursor() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSource-1.ToCursor.html>`__ -- `ToCursorAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSource-1.ToCursorAsync.html>`__ +- `Find() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Find.html>`__ +- `FirstOrDefault() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluentExtensions.FirstOrDefault.html>`__ +- `FirstOrDefaultAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSourceExtensions.FirstOrDefaultAsync.html>`__ +- `FindOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.FindOptions.html>`__ +- `ToList() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSourceExtensions.ToList.html>`__ +- `ToListAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSourceExtensions.FirstOrDefaultAsync.html>`__ +- `ToCursor() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSource-1.ToCursor.html>`__ +- `ToCursorAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursorSource-1.ToCursorAsync.html>`__ .. _csharp-retrieve-instruqt-lab: diff --git a/source/crud/query/project.txt b/source/crud/query/project.txt index 72f1ca2b..be82b6fd 100644 --- a/source/crud/query/project.txt +++ b/source/crud/query/project.txt @@ -352,7 +352,7 @@ The following code example projects each document's search score in a field name } To learn more about search scores, see -:atlas:`Score the Documents in the Returned Documents `. +:atlas:`Score the Documents in the Results `. MetaSearchScoreDetails ~~~~~~~~~~~~~~~~~~~~~~ @@ -397,7 +397,7 @@ details in a field named ``searchScoreDetails``: } To learn more about search score details, see -:atlas:`Return the Score Details ` +:atlas:`Return the Score Details ` in the Atlas documentation. MetaSearchSequenceToken @@ -464,7 +464,7 @@ For a code example that uses the ``MetaVectorSearchScore()`` method, see :ref:`Atlas Vector Search `. To learn more about Atlas Vector Search scores, see -:atlas:`Score the Documents in the Returned Documents ` +:atlas:`Score the Documents in the Results ` in the Atlas documentation. SearchMeta @@ -493,18 +493,18 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `Projection <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Builders-1.Projection.html>`_ -- `ProjectionDefinitionBuilder <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.html>`__ -- `ElemMatch() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.ElemMatch.html>`__ -- `Exclude() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.Exclude.html>`__ -- `Expression() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.Expression.html>`__ -- `Include() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.Include.html>`__ -- `Meta() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.Meta.html>`__ -- `MetaSearchHighlights <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.MetaSearchHighlights.html>`__ -- `MetaSearchScore() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.MetaSearchScore.html>`__ -- `MetaSearchScoreDetails() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.MetaSearchScoreDetails.html>`__ -- `MetaSearchSequenceToken() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.MetaSearchSequenceToken.html>`__ -- `MetaTextScore() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.MetaTextScore.html>`__ -- `MetaVectorSearchScore() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.MetaVectorSearchScore.html>`__ -- `SearchMeta() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.SearchMeta.html>`__ -- `Slice() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.Slice.html>`__ \ No newline at end of file +- `Projection <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Builders-1.Projection.html>`_ +- `ProjectionDefinitionBuilder <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.html>`__ +- `ElemMatch() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.ElemMatch.html>`__ +- `Exclude() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.Exclude.html>`__ +- `Expression() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.Expression.html>`__ +- `Include() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.Include.html>`__ +- `Meta() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.Meta.html>`__ +- `MetaSearchHighlights <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.MetaSearchHighlights.html>`__ +- `MetaSearchScore() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.MetaSearchScore.html>`__ +- `MetaSearchScoreDetails() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.MetaSearchScoreDetails.html>`__ +- `MetaSearchSequenceToken() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.MetaSearchSequenceToken.html>`__ +- `MetaTextScore() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.MetaTextScore.html>`__ +- `MetaVectorSearchScore() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.MetaVectorSearchScore.html>`__ +- `SearchMeta() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.SearchMeta.html>`__ +- `Slice() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.Slice.html>`__ \ No newline at end of file diff --git a/source/crud/query/query-filter.txt b/source/crud/query/query-filter.txt index fd936a88..07ce6b10 100644 --- a/source/crud/query/query-filter.txt +++ b/source/crud/query/query-filter.txt @@ -537,7 +537,7 @@ geospatial operations and the equivalent {+mdb-server+} operators: * - ``GeoIntersects()`` - Matches documents whose geospatial data intersects with a specified - `GeoJsonObject <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.GeoJsonObjectModel.GeoJsonObject-1.html>`__. + `GeoJsonObject <{+api-root+}/MongoDB.Driver/MongoDB.Driver.GeoJsonObjectModel.GeoJsonObject-1.html>`__. - :manual:`$geoIntersects ` * - ``GeoWithin()`` @@ -629,5 +629,5 @@ Additional Information For more information about any of the driver methods on this page, see the API documentation for the -`FilterDefinitionBuilder <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinitionBuilder-1.html>`__ +`FilterDefinitionBuilder <{+api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinitionBuilder-1.html>`__ class. \ No newline at end of file diff --git a/source/crud/query/specify-documents.txt b/source/crud/query/specify-documents.txt index 3b660182..807091ac 100644 --- a/source/crud/query/specify-documents.txt +++ b/source/crud/query/specify-documents.txt @@ -214,8 +214,8 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `Find() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Find.html>`_ -- `IFindFluent <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluent-2.html>`_ -- `Limit() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluent-2.Limit.html>`_ -- `Sort() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluent-2.Sort.html>`_ -- `Skip() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluent-2.Skip.html>`_ \ No newline at end of file +- `Find() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Find.html>`_ +- `IFindFluent <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluent-2.html>`_ +- `Limit() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluent-2.Limit.html>`_ +- `Sort() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluent-2.Sort.html>`_ +- `Skip() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluent-2.Skip.html>`_ \ No newline at end of file diff --git a/source/crud/replace.txt b/source/crud/replace.txt index f1e91c7f..dc01ebce 100644 --- a/source/crud/replace.txt +++ b/source/crud/replace.txt @@ -52,7 +52,7 @@ method. These methods accept the following parameters: query filters, see the :manual:`{+mdb-server+} manual `. - **Data Type:** `FilterDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ + **Data Type:** `FilterDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ * - ``replacement`` - A *replacement* document, which specifies the fields and values to insert in the new @@ -65,7 +65,7 @@ method. These methods accept the following parameters: - *Optional.* An instance of the ``ReplaceOptions`` class that specifies the configuration for the replace operation. The default value is ``null``. - **Data Type:** `ReplaceOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReplaceOptions.html>`__ + **Data Type:** `ReplaceOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReplaceOptions.html>`__ * - ``cancellationToken`` - *Optional.* A token that you can use to cancel the operation. @@ -159,21 +159,21 @@ The ``ReplaceOptions`` class contains the following properties: results. See the :ref:`` section of this page for more information. - **Data Type:** `Collation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Collation.html>`__ + **Data Type:** `Collation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Collation.html>`__ * - ``Comment`` - Gets or sets the user-provided comment for the operation. See :manual:`the {+mdb-server+} manual` for more information. - **Data Type:** `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ + **Data Type:** `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ * - ``Hint`` - Gets or sets the index to use to scan for documents. See :manual:`the {+mdb-server+} manual` for more information. - **Data Type:** `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ + **Data Type:** `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ * - ``IsUpsert`` - Specifies whether the replace operation performs an upsert operation if no @@ -205,7 +205,7 @@ The ``ReplaceOptions`` class contains the following properties: See :manual:`the {+mdb-server+} manual ` for more information. - **Data Type:** `BsonDocument <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__ + **Data Type:** `BsonDocument <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__ The following example performs the same steps as the preceding example, but also uses the ``BypassDocumentValidation`` option to bypass any schema validation requirements. @@ -281,7 +281,7 @@ The ``ReplaceOneResult`` class contains the following properties: - The ID of the document that was upserted in the database, if the driver performed an upsert. - **Data Type:** `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ + **Data Type:** `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ Additional Information ---------------------- @@ -298,8 +298,8 @@ API Documentation To learn more about any of the methods and classes used on this page, see the following API documentation: -* `ReplaceOne() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.ReplaceOne.html>`__ -* `ReplaceOneAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.ReplaceOneAsync.html>`__ -* `ReplaceOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReplaceOptions.html>`__ +* `ReplaceOne() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.ReplaceOne.html>`__ +* `ReplaceOneAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.ReplaceOneAsync.html>`__ +* `ReplaceOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReplaceOptions.html>`__ * `ReplaceOneResult - <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReplaceOneResult.html>`__ + <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReplaceOneResult.html>`__ diff --git a/source/crud/transactions.txt b/source/crud/transactions.txt index 40990745..3d589a80 100644 --- a/source/crud/transactions.txt +++ b/source/crud/transactions.txt @@ -88,7 +88,7 @@ describes the properties that you can set on a ``ClientSessionOptions`` object: - | Specifies the default transaction options for the session. This includes the maximum commit time, read concern, read preference, and write concern. | - | **Data Type**: `TransactionOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.TransactionOptions.html>`__ + | **Data Type**: `TransactionOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.TransactionOptions.html>`__ | **Default**: ``null`` * - ``Snapshot`` @@ -321,11 +321,11 @@ 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>`__ -- `CausalConsistency <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ClientSessionOptions.CausalConsistency.html>`__ \ No newline at end of file +- `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>`__ +- `CausalConsistency <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ClientSessionOptions.CausalConsistency.html>`__ \ No newline at end of file diff --git a/source/crud/update-many.txt b/source/crud/update-many.txt index 4fca9692..b61f3f78 100644 --- a/source/crud/update-many.txt +++ b/source/crud/update-many.txt @@ -64,11 +64,11 @@ Update Many .. replacement:: sync-api-link - `UpdateMany() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateMany.html>`__ + `UpdateMany() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateMany.html>`__ .. replacement:: async-api-link - `UpdateManyAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateManyAsync.html>`__ + `UpdateManyAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateManyAsync.html>`__ .. replacement:: instruqt-lab-component diff --git a/source/crud/update-one.txt b/source/crud/update-one.txt index 6d3a4c2c..976ed06b 100644 --- a/source/crud/update-one.txt +++ b/source/crud/update-one.txt @@ -64,11 +64,11 @@ Update One .. replacement:: sync-api-link - `UpdateOne() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateOne.html>`__ + `UpdateOne() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateOne.html>`__ .. replacement:: async-api-link - `UpdateOneAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateOneAsync.html>`__ + `UpdateOneAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateOneAsync.html>`__ .. replacement:: instruqt-lab-component diff --git a/source/databases-collections.txt b/source/databases-collections.txt index a9bab87d..1f5fcaf4 100644 --- a/source/databases-collections.txt +++ b/source/databases-collections.txt @@ -37,18 +37,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()`` @@ -69,15 +69,15 @@ List Databases -------------- To see a list of your deployment's databases, call the synchronous `ListDatabaseNames() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabaseNames.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabaseNames.html>`__ method or asynchronous `ListDatabaseNamesAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabaseNamesAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabaseNamesAsync.html>`__ method on your ``IMongoClient`` instance. To see detailed information about each database, call the synchronous `ListDatabases() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabases.html>`__ method or +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabases.html>`__ method or asynchronous `ListDatabasesAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabasesAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.ListDatabasesAsync.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. @@ -108,9 +108,9 @@ Drop a Database Dropping a database permanently deletes all the data in that database's collections. To drop a database, call the synchronous `DropDatabase() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.DropDatabase.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.DropDatabase.html>`__ method or asynchronous `DropDatabaseAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.DropDatabaseAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoClient.DropDatabaseAsync.html>`__ method on your ``IMongoClient`` instance, passing the database name as the parameter. @@ -145,14 +145,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 @@ -203,14 +203,14 @@ Create a Collection ------------------- You can explicitly create a collection by calling the synchronous `CreateCollection() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.CreateCollection.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.CreateCollection.html>`__ method or asynchronous `CreateCollectionAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.CreateCollectionAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.CreateCollectionAsync.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. @@ -241,15 +241,15 @@ List Collections ---------------- To see a list of collections in a database, call the synchronous `ListCollectionNames() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionNames.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionNames.html>`__ method or asynchronous `ListCollectionNamesAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionNamesAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionNamesAsync.html>`__ method on your ``IMongoDatabase`` instance. To see detailed information about each database, call the synchronous `ListCollections() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollections.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollections.html>`__ method or asynchronous `ListCollectionsAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionsAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.ListCollectionsAsync.html>`__ method on your ``IMongoDatabase`` instance. These methods return fields describing the collections in the database, such as their types and settings. @@ -282,9 +282,9 @@ Drop a Collection Dropping a collection permanently deletes all the data in that collection. To drop a collection, call the synchronous `DropCollection() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.DropCollection.html>`__ or +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.DropCollection.html>`__ or the asynchronous `DropCollectionAsync() -<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.DropCollectionAsync.html>`__ +<{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.DropCollectionAsync.html>`__ method on your ``IMongoCollection`` instance. The following code shows how to use the synchronous ``DropCollection()`` method or the asynchronous diff --git a/source/document-formats/bson.txt b/source/document-formats/bson.txt index 5525c0e5..74d858f9 100644 --- a/source/document-formats/bson.txt +++ b/source/document-formats/bson.txt @@ -243,9 +243,9 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `BsonDocument <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__ -- `BsonElement <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonElement.html>`__ -- `BsonBinaryReader <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.IO.BsonBinaryReader.html>`__ -- `BsonBinaryWriter <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.IO.BsonBinaryWriter.html>`__ -- `IBsonReader <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.IO.IBsonReader.html>`__ -- `IBsonWriter <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.IO.IBsonWriter.html>`__ \ No newline at end of file +- `BsonDocument <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__ +- `BsonElement <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonElement.html>`__ +- `BsonBinaryReader <{+api-root+}/MongoDB.Bson/MongoDB.Bson.IO.BsonBinaryReader.html>`__ +- `BsonBinaryWriter <{+api-root+}/MongoDB.Bson/MongoDB.Bson.IO.BsonBinaryWriter.html>`__ +- `IBsonReader <{+api-root+}/MongoDB.Bson/MongoDB.Bson.IO.IBsonReader.html>`__ +- `IBsonWriter <{+api-root+}/MongoDB.Bson/MongoDB.Bson.IO.IBsonWriter.html>`__ \ No newline at end of file diff --git a/source/document-formats/extended-json.txt b/source/document-formats/extended-json.txt index 010910ff..2bdcb30e 100644 --- a/source/document-formats/extended-json.txt +++ b/source/document-formats/extended-json.txt @@ -81,10 +81,10 @@ API Documentation To learn more about the methods and classes you can use to work with JSON documents, see the following API documentation: -- `BsonDocument <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__ -- `BsonSerializer <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.BsonSerializer.html>`__ -- `ToJson() <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonExtensionMethods.ToJson.html>`__ -- `JsonWriter <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.IO.JsonWriter.html>`__ -- `JsonReader <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.IO.JsonReader.html>`__ -- `JsonWriterSettings <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.IO.JsonWriterSettings.html>`__ -- `JsonOutputMode <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.IO.JsonOutputMode.html>`__ \ No newline at end of file +- `BsonDocument <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__ +- `BsonSerializer <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.BsonSerializer.html>`__ +- `ToJson() <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonExtensionMethods.ToJson.html>`__ +- `JsonWriter <{+api-root+}/MongoDB.Bson/MongoDB.Bson.IO.JsonWriter.html>`__ +- `JsonReader <{+api-root+}/MongoDB.Bson/MongoDB.Bson.IO.JsonReader.html>`__ +- `JsonWriterSettings <{+api-root+}/MongoDB.Bson/MongoDB.Bson.IO.JsonWriterSettings.html>`__ +- `JsonOutputMode <{+api-root+}/MongoDB.Bson/MongoDB.Bson.IO.JsonOutputMode.html>`__ \ No newline at end of file diff --git a/source/includes/collation.rst b/source/includes/collation.rst index e944268c..170a4b90 100644 --- a/source/includes/collation.rst +++ b/source/includes/collation.rst @@ -1,5 +1,5 @@ To configure collation for your operation, create an instance of the -`Collation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Collation.html>`__ class. +`Collation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Collation.html>`__ class. The following table describes the parameters that the ``Collation`` constructor accepts. It also lists the corresponding class property that you can use to read each @@ -46,7 +46,7 @@ setting's value. * - ``caseFirst`` - | *(Optional)* Specifies the sort order of case differences during tertiary level comparisons. | - | **Data Type**: `CollationCaseFirst <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollationCaseFirst.html>`__ + | **Data Type**: `CollationCaseFirst <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CollationCaseFirst.html>`__ | **Default**: ``CollationCaseFirst.Off`` - ``CaseFirst`` @@ -54,7 +54,7 @@ setting's value. - | *(Optional)* Specifies the level of comparison to perform, as defined in the `ICU documentation `__. | - | **Data Type**: `CollationStrength <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollationStrength.html>`__ + | **Data Type**: `CollationStrength <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CollationStrength.html>`__ | **Default**: ``CollationStrength.Tertiary`` - ``Strength`` @@ -81,7 +81,7 @@ setting's value. - | *(Optional)* Specifies whether the driver considers whitespace and punctuation as base characters for purposes of comparison. | - | **Data Type**: `CollationAlternate <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollationAlternate.html>`__ + | **Data Type**: `CollationAlternate <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CollationAlternate.html>`__ | **Default**: ``CollationAlternate.NonIgnorable`` (spaces and punctuation are considered base characters) - ``Alternate`` @@ -90,7 +90,7 @@ setting's value. - | *(Optional)* Specifies which characters the driver considers ignorable when the ``alternate`` argument is ``CollationAlternate.Shifted``. | - | **Data Type**: `CollationMaxVariable <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollationMaxVariable.html>`__ + | **Data Type**: `CollationMaxVariable <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CollationMaxVariable.html>`__ | **Default**: ``CollationMaxVariable.Punctuation`` (the driver ignores punctuation and spaces) - ``MaxVariable`` diff --git a/source/includes/fundamentals/connection-options/scheme.rst b/source/includes/fundamentals/connection-options/scheme.rst index 894343ed..fc460577 100644 --- a/source/includes/fundamentals/connection-options/scheme.rst +++ b/source/includes/fundamentals/connection-options/scheme.rst @@ -1,6 +1,6 @@ Specifies whether to use the standard connection string format (``MongoDB``) or the DNS seed list format (``MongoDBPlusSrv``). The available values for this -property are defined in the `ConnectionStringScheme <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.ConnectionStringScheme.html>`__ +property are defined in the `ConnectionStringScheme <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.ConnectionStringScheme.html>`__ enum. The default value is ``ConnectionStringScheme.MongoDB``. See :manual:`Connection Strings ` in the {+mdb-server+} manual for more information about connection string formats. diff --git a/source/includes/fundamentals/connection-options/serverMonitoringMode.rst b/source/includes/fundamentals/connection-options/serverMonitoringMode.rst index cf9f0f7a..64699a2b 100644 --- a/source/includes/fundamentals/connection-options/serverMonitoringMode.rst +++ b/source/includes/fundamentals/connection-options/serverMonitoringMode.rst @@ -1,5 +1,5 @@ Specifies the server monitoring protocol to use. The available values for this -property are defined in the `ServerMonitoringMode <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Servers.ServerMonitoringMode.html>`__ +property are defined in the `ServerMonitoringMode <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Servers.ServerMonitoringMode.html>`__ enum. The default value is ``Auto``. When this option is set to ``Auto`` the monitoring mode is determined diff --git a/source/includes/method-overloads.rst b/source/includes/method-overloads.rst index 48d11b14..4b77f466 100644 --- a/source/includes/method-overloads.rst +++ b/source/includes/method-overloads.rst @@ -3,4 +3,4 @@ Many of the methods on this page have multiple overloads. The examples in this guide show only one definition of each method. For more information about the available overloads, see the - `API documentation. <{+new-api-root+}/index.html>`__ \ No newline at end of file + `API documentation. <{+api-root+}/index.html>`__ \ No newline at end of file diff --git a/source/includes/page-templates/update/arrays.rst b/source/includes/page-templates/update/arrays.rst index 3a7e7521..25400f1f 100644 --- a/source/includes/page-templates/update/arrays.rst +++ b/source/includes/page-templates/update/arrays.rst @@ -125,7 +125,7 @@ This method accepts the following parameters: - A ``SortDefinition`` object that specifies how the driver sorts the array elements after adding the new values. - **Data Type:** `SortDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.SortDefinition-1.html>`__ + **Data Type:** `SortDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.SortDefinition-1.html>`__ The following code example uses the ``PushEach()`` method to add two new ``GradeEntry`` objects to the start of the ``Grades`` array in |matching-document-or-documents|. @@ -290,7 +290,7 @@ This method accepts the following parameters: * - ``filter`` - A query filter that specifies the condition for values to remove. - **Data Type:** `FilterDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ + **Data Type:** `FilterDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ The following code example uses the ``PullFilter()`` method to remove all ``GradeEntry`` objects where the ``Grade`` value is ``"F"`` from the ``Grades`` array in the @@ -365,13 +365,13 @@ API Documentation For more information about any of the methods or types discussed in this guide, see the following API documentation: -- `Builders.Update.Push() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Push.html>`__ -- `Builders.Update.AddToSet() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.AddToSet.html>`__ -- `Builders.Update.PushEach() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.PushEach.html>`__ -- `Builders.Update.AddToSetEach() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.AddToSetEach.html>`__ -- `Builders.Update.PopFirst() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.PopFirst.html>`__ -- `Builders.Update.PopLast() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.PopLast.html>`__ -- `Builders.Update.Pull() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Pull.html>`__ -- `Builders.Update.PullAll() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.PullAll.html>`__ -- `Builders.Update.PullFilter() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.PullFilter.html>`__ -- `Builders.Update.Set() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Set.html>`__ \ No newline at end of file +- `Builders.Update.Push() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Push.html>`__ +- `Builders.Update.AddToSet() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.AddToSet.html>`__ +- `Builders.Update.PushEach() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.PushEach.html>`__ +- `Builders.Update.AddToSetEach() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.AddToSetEach.html>`__ +- `Builders.Update.PopFirst() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.PopFirst.html>`__ +- `Builders.Update.PopLast() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.PopLast.html>`__ +- `Builders.Update.Pull() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Pull.html>`__ +- `Builders.Update.PullAll() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.PullAll.html>`__ +- `Builders.Update.PullFilter() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.PullFilter.html>`__ +- `Builders.Update.Set() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Set.html>`__ \ No newline at end of file diff --git a/source/includes/page-templates/update/fields.rst b/source/includes/page-templates/update/fields.rst index 9109797b..a85b8fa1 100644 --- a/source/includes/page-templates/update/fields.rst +++ b/source/includes/page-templates/update/fields.rst @@ -253,7 +253,7 @@ To set the value of a field to the current date and time, call the - The format of the date and time, defined in the ``UpdateDefinitionCurrentDateType`` enum. The default value is ``null``. - **Data Type:** `UpdateDefinitionCurrentDateType? <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionCurrentDateType.html>`__ + **Data Type:** `UpdateDefinitionCurrentDateType? <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionCurrentDateType.html>`__ The following code example uses the ``CurrentDate()`` method to update the ``Date`` field of the first ``GradeEntry`` object to the current date in @@ -290,12 +290,12 @@ API Documentation For more information about any of the methods discussed in this guide, see the following API documentation: -- `Builders.Update.Inc() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Inc.html>`__ -- `Builders.Update.Mul() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Mul.html>`__ -- `Builders.Update.Rename() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Rename.html>`__ -- `Builders.Update.Set() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Set.html>`__ -- `Builders.Update.Max() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Max.html>`__ -- `Builders.Update.Min() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Min.html>`__ -- `Builders.Update.SetOnInsert() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.SetOnInsert.html>`__ -- `Builders.Update.CurrentDate() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.CurrentDate.html>`__ -- `Builders.Update.Unset() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Unset.html>`__ +- `Builders.Update.Inc() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Inc.html>`__ +- `Builders.Update.Mul() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Mul.html>`__ +- `Builders.Update.Rename() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Rename.html>`__ +- `Builders.Update.Set() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Set.html>`__ +- `Builders.Update.Max() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Max.html>`__ +- `Builders.Update.Min() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Min.html>`__ +- `Builders.Update.SetOnInsert() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.SetOnInsert.html>`__ +- `Builders.Update.CurrentDate() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.CurrentDate.html>`__ +- `Builders.Update.Unset() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinitionBuilder-1.Unset.html>`__ diff --git a/source/includes/page-templates/update/update.rst b/source/includes/page-templates/update/update.rst index a468442d..2f0ca289 100644 --- a/source/includes/page-templates/update/update.rst +++ b/source/includes/page-templates/update/update.rst @@ -32,21 +32,21 @@ The |sync-method| and |async-method| methods accept the following parameters: to update. To learn how to create a query filter, see :ref:`csharp-specify-query`. - **Data Type:** `FilterDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ + **Data Type:** `FilterDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ * - ``update`` - An instance of the ``UpdateDefinition`` class. This object specifies the kind of update operation, the fields to update, and the new value for each field. To learn how to create an ``UpdateDefinition`` object, see |fields-link| and |arrays-link|. - **Data Type:** `UpdateDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinition-1.html>`__ + **Data Type:** `UpdateDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateDefinition-1.html>`__ * - ``options`` - *Optional.* An instance of the ``UpdateOptions`` class that specifies the configuration for the update operation. The default value is ``null``. For a list of available options, see |options-ref-link|. - **Data Type:** `UpdateOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateOptions.html>`__ + **Data Type:** `UpdateOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateOptions.html>`__ * - ``cancellationToken`` - *Optional.* A token that you can use to cancel the operation. @@ -152,7 +152,7 @@ The ``UpdateOptions`` class contains the following properties: See :manual:`the {+mdb-server+} manual` for more information. - **Data Type:** IEnumerable<`ArrayFilterDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ArrayFilterDefinition.html>`__> + **Data Type:** IEnumerable<`ArrayFilterDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ArrayFilterDefinition.html>`__> * - ``BypassDocumentValidation`` - Specifies whether the update operation bypasses document validation. This lets you @@ -167,21 +167,21 @@ The ``UpdateOptions`` class contains the following properties: results. See the :ref:`` section of this page for more information. - **Data Type:** `Collation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Collation.html>`__ + **Data Type:** `Collation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Collation.html>`__ * - ``Comment`` - Gets or sets the user-provided comment for the operation. See :manual:`the {+mdb-server+} manual` for more information. - **Data Type:** `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ + **Data Type:** `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ * - ``Hint`` - Gets or sets the index to use to scan for documents. See :manual:`the {+mdb-server+} manual` for more information. - **Data Type:** `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ + **Data Type:** `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ * - ``IsUpsert`` - Specifies whether the update operation performs an upsert operation if no @@ -213,7 +213,7 @@ The ``UpdateOptions`` class contains the following properties: See :manual:`the {+mdb-server+} manual ` for more information. - **Data Type:** `BsonDocument <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__ + **Data Type:** `BsonDocument <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonDocument.html>`__ .. _csharp-update-collation: @@ -262,7 +262,7 @@ The ``UpdateResult`` class contains the following properties: - The ID of the document that was upserted in the database, if the driver performed an upsert. - **Data Type:** `BsonValue <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ + **Data Type:** `BsonValue <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.html>`__ Additional Information ---------------------- @@ -283,7 +283,7 @@ guide, see the following API documentation: - |sync-api-link| - |async-api-link| -- `UpdateOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateOptions.html>`__ -- `UpdateResult <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateResult.html>`__ +- `UpdateOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateOptions.html>`__ +- `UpdateResult <{+api-root+}/MongoDB.Driver/MongoDB.Driver.UpdateResult.html>`__ |instruqt-lab-component| diff --git a/source/includes/troubleshooting/server-selection-timeout.rst b/source/includes/troubleshooting/server-selection-timeout.rst index 1f1b67f9..637bce0a 100644 --- a/source/includes/troubleshooting/server-selection-timeout.rst +++ b/source/includes/troubleshooting/server-selection-timeout.rst @@ -4,7 +4,7 @@ Driver Throws a Timeout During Server Selection Each driver operation requires that you choose a server that satisfies the :manual:`server selection criteria `. If you do not select an appropriate -server within the `server selection timeout <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.ServerSelectionTimeout.html>`__, the driver throws a +server within the `server selection timeout <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.ServerSelectionTimeout.html>`__, the driver throws a server selection timeout exception. The exception looks similar to the following: diff --git a/source/includes/vector-search-intro.rst b/source/includes/vector-search-intro.rst index c380225d..aea7e61a 100644 --- a/source/includes/vector-search-intro.rst +++ b/source/includes/vector-search-intro.rst @@ -30,7 +30,7 @@ following parameters: Although the data type of this parameter is ``QueryVector``, you can also pass an array of ``float`` values. - **Data type**: `QueryVector <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.QueryVector.html>`__ + **Data type**: `QueryVector <{+api-root+}/MongoDB.Driver/MongoDB.Driver.QueryVector.html>`__ * - ``limit`` - The maximum number of documents to return. @@ -40,7 +40,7 @@ following parameters: * - ``options`` - Configuration options for the vector search operation. - **Data type**: `VectorSearchOptions <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.VectorSearchOptions-1.html>`__ + **Data type**: `VectorSearchOptions <{+api-root+}/MongoDB.Driver/MongoDB.Driver.VectorSearchOptions-1.html>`__ You can use the ``options`` parameter to configure your vector search operation. The ``VectorSearchOptions`` class contains the following properties: @@ -64,7 +64,7 @@ You can use the ``options`` parameter to configure your vector search operation. * - ``Filter`` - Additional search criteria that the found documents must match. - | **Data Type:** `FilterDefinition <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ + | **Data Type:** `FilterDefinition <{+api-root+}/MongoDB.Driver/MongoDB.Driver.FilterDefinition-1.html>`__ | **Default**: ``null`` * - ``IndexName`` diff --git a/source/index.txt b/source/index.txt index e327bab5..62b00435 100644 --- a/source/index.txt +++ b/source/index.txt @@ -131,7 +131,7 @@ API Documentation For detailed information about types and methods in the {+driver-short+}, see the `{+driver-long+} API documentation -<{+new-api-root+}/index.html>`__. +<{+api-root+}/index.html>`__. Issues & Help ------------- diff --git a/source/indexes.txt b/source/indexes.txt index 07f4420a..47c23afa 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -397,7 +397,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 @@ -415,6 +415,6 @@ Additional Information For more information about the classes and methods used on this page, see the following API documentation: -- `CreateOne() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoIndexManager-1.CreateOne.html>`__ -- `CreateIndexModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CreateIndexModel-1.html>`__ -- `IndexKeysDefinitionBuilder <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IndexKeysDefinitionBuilder-1.html>`__ \ No newline at end of file +- `CreateOne() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoIndexManager-1.CreateOne.html>`__ +- `CreateIndexModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CreateIndexModel-1.html>`__ +- `IndexKeysDefinitionBuilder <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IndexKeysDefinitionBuilder-1.html>`__ \ No newline at end of file diff --git a/source/indexes/search-indexes.txt b/source/indexes/search-indexes.txt index 1d68349b..5c3c99e3 100644 --- a/source/indexes/search-indexes.txt +++ b/source/indexes/search-indexes.txt @@ -317,10 +317,10 @@ API Documentation To learn more about the methods and types mentioned in this guide, see the following API documentation: -- `CreateSearchIndexModel <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CreateSearchIndexModel.html>`__ -- `SearchIndexType <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.SearchIndexType.html>`__ -- `CreateOne() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Search.IMongoSearchIndexManager.CreateOne.html>`__ -- `CreateMany() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Search.IMongoSearchIndexManager.CreateMany.html>`__ -- `List() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Search.IMongoSearchIndexManager.List.html>`__ -- `Update() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Search.IMongoSearchIndexManager.Update.html>`__ -- `DropOne() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Search.IMongoSearchIndexManager.DropOne.html>`__ +- `CreateSearchIndexModel <{+api-root+}/MongoDB.Driver/MongoDB.Driver.CreateSearchIndexModel.html>`__ +- `SearchIndexType <{+api-root+}/MongoDB.Driver/MongoDB.Driver.SearchIndexType.html>`__ +- `CreateOne() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Search.IMongoSearchIndexManager.CreateOne.html>`__ +- `CreateMany() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Search.IMongoSearchIndexManager.CreateMany.html>`__ +- `List() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Search.IMongoSearchIndexManager.List.html>`__ +- `Update() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Search.IMongoSearchIndexManager.Update.html>`__ +- `DropOne() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Search.IMongoSearchIndexManager.DropOne.html>`__ diff --git a/source/logging-and-monitoring/change-streams.txt b/source/logging-and-monitoring/change-streams.txt index 0b6a14f5..89cbbc63 100644 --- a/source/logging-and-monitoring/change-streams.txt +++ b/source/logging-and-monitoring/change-streams.txt @@ -398,7 +398,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/logging-and-monitoring/monitoring.txt b/source/logging-and-monitoring/monitoring.txt index 49eb96f6..74b8c2fa 100644 --- a/source/logging-and-monitoring/monitoring.txt +++ b/source/logging-and-monitoring/monitoring.txt @@ -65,7 +65,7 @@ The following table describes the types of events that the driver emits: - Events related to the connection pool held by the driver. For a complete list of events the driver emits, see the API documentation for the -`MongoDB.Driver.Core.Events <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Events.html>`__ +`MongoDB.Driver.Core.Events <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Events.html>`__ namespace. .. _csharp-monitor-events: @@ -110,5 +110,5 @@ API Documentation To learn more about the methods and classes used to monitor events in the driver, see the following API documentation: -- `MongoDB.Driver.Core.Events <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Events.html>`__ -- `Subscribe() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.ClusterBuilder.Subscribe.html>`__ +- `MongoDB.Driver.Core.Events <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Events.html>`__ +- `Subscribe() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.ClusterBuilder.Subscribe.html>`__ diff --git a/source/reference/quick-reference.txt b/source/reference/quick-reference.txt index 3d4b183a..44dea2e2 100644 --- a/source/reference/quick-reference.txt +++ b/source/reference/quick-reference.txt @@ -25,7 +25,7 @@ their related reference and API documentation. * - | **Find a Document** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Find.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Find.html>`__ | :ref:`Fundamentals ` - .. io-code-block:: @@ -48,7 +48,7 @@ their related reference and API documentation. * - | **Find a Document (Async)** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.FindAsync.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.FindAsync.html>`__ | :ref:`Fundamentals ` - .. io-code-block:: @@ -72,7 +72,7 @@ their related reference and API documentation. * - | **Find Multiple Documents** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Find.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Find.html>`__ | :ref:`Fundamentals ` - .. io-code-block:: @@ -99,7 +99,7 @@ their related reference and API documentation. * - | **Find Multiple Documents (Async)** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Find.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollectionExtensions.Find.html>`__ | :ref:`Fundamentals ` - .. io-code-block:: @@ -126,7 +126,7 @@ their related reference and API documentation. * - | **Insert a Document** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertOne.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertOne.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -136,7 +136,7 @@ their related reference and API documentation. * - | **Insert a Document (Async)** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertOneAsync.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertOneAsync.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -146,7 +146,7 @@ their related reference and API documentation. * - | **Insert Multiple Documents** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertMany.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertMany.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -160,7 +160,7 @@ their related reference and API documentation. * - | **Insert Multiple Documents (Async)** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertManyAsync.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertManyAsync.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -174,7 +174,7 @@ their related reference and API documentation. * - | **Update a Document** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateOne.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateOne.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -190,7 +190,7 @@ their related reference and API documentation. * - | **Update a Document (Async)** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateOneAsync.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateOneAsync.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -206,7 +206,7 @@ their related reference and API documentation. * - | **Update Multiple Documents** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateMany.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateMany.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -222,7 +222,7 @@ their related reference and API documentation. * - | **Update Multiple Documents (Async)** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateManyAsync.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateManyAsync.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -238,7 +238,7 @@ their related reference and API documentation. * - | **Update an Array in a Document** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateOne.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.UpdateOne.html>`__ | :ref:`Fundamentals (Update One) ` | :ref:`Fundamentals (Update Many) ` @@ -260,7 +260,7 @@ their related reference and API documentation. * - | **Replace a Document** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.ReplaceOne.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.ReplaceOne.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -292,7 +292,7 @@ their related reference and API documentation. * - | **Replace a Document (Async)** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.ReplaceOneAsync.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.ReplaceOneAsync.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -324,7 +324,7 @@ their related reference and API documentation. * - | **Delete a Document** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteOne.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteOne.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -337,7 +337,7 @@ their related reference and API documentation. * - | **Delete a Document (Async)** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteOneAsync.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteOneAsync.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -350,7 +350,7 @@ their related reference and API documentation. * - | **Delete Multiple Documents** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteMany.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteMany.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -363,7 +363,7 @@ their related reference and API documentation. * - | **Delete Multiple Documents (Async)** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteManyAsync.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.DeleteManyAsync.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp @@ -376,7 +376,7 @@ their related reference and API documentation. * - | **Access Data from a Cursor Iteratively** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursor-1.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IAsyncCursor-1.html>`__ - .. io-code-block:: :copyable: true @@ -407,7 +407,7 @@ their related reference and API documentation. * - | **Count Documents** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.CountDocuments.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.CountDocuments.html>`__ - .. io-code-block:: :copyable: true @@ -429,7 +429,7 @@ their related reference and API documentation. * - | **List the Distinct Documents or Field Values** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.Distinct.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.Distinct.html>`__ - .. io-code-block:: :copyable: true @@ -450,7 +450,7 @@ their related reference and API documentation. * - | **Limit the Number of Documents Retrieved** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluent-2.Limit.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluent-2.Limit.html>`__ - .. io-code-block:: :copyable: true @@ -475,7 +475,7 @@ their related reference and API documentation. * - | **Skip Retrieved Documents** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluent-2.Skip.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluent-2.Skip.html>`__ - .. io-code-block:: :copyable: true @@ -502,7 +502,7 @@ their related reference and API documentation. * - | **Sort the Documents When Retrieving Them** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluentExtensions.SortBy.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IFindFluentExtensions.SortBy.html>`__ - .. io-code-block:: :copyable: true @@ -530,7 +530,7 @@ their related reference and API documentation. * - | **Project Document Fields When Retrieving Them** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ProjectionDefinitionBuilder-1.html>`__ | :ref:`Fundamentals ` - .. io-code-block:: @@ -563,7 +563,7 @@ their related reference and API documentation. * - | **Create an Index** | - | `API Documentation <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoIndexManager-1.CreateOne.html>`__ + | `API Documentation <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoIndexManager-1.CreateOne.html>`__ | :ref:`Fundamentals ` - .. code-block:: csharp diff --git a/source/reference/upgrade/v3.txt b/source/reference/upgrade/v3.txt index 87b79d80..8545892f 100644 --- a/source/reference/upgrade/v3.txt +++ b/source/reference/upgrade/v3.txt @@ -201,16 +201,16 @@ Version 3.0 Breaking Changes - Removes the ``[Obsolete]`` attribute from the ``AsLocalTime`` and ``AsUniversalTime`` properties. - - Adds the `AsNullableLocalTime <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.AsNullableLocalTime.html#MongoDB_Bson_BsonValue_AsNullableLocalTime>`__ - and `AsNullableUniversalTime <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.AsNullableUniversalTime.html#MongoDB_Bson_BsonValue_AsNullableUniversalTime>`__ + - Adds the `AsNullableLocalTime <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.AsNullableLocalTime.html#MongoDB_Bson_BsonValue_AsNullableLocalTime>`__ + and `AsNullableUniversalTime <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.AsNullableUniversalTime.html#MongoDB_Bson_BsonValue_AsNullableUniversalTime>`__ properties. - - Removes the ``AsDateTime`` property. Use the `AsUniversalTime <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.AsUniversalTime.html#MongoDB_Bson_BsonValue_AsUniversalTime>`__ + - Removes the ``AsDateTime`` property. Use the `AsUniversalTime <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.AsUniversalTime.html#MongoDB_Bson_BsonValue_AsUniversalTime>`__ property instead. - - Removes the ``AsNullableDateTime`` property. Use the `AsNullableUniversalTime <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.AsNullableUniversalTime.html#MongoDB_Bson_BsonValue_AsNullableUniversalTime>`__ + - Removes the ``AsNullableDateTime`` property. Use the `AsNullableUniversalTime <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonValue.AsNullableUniversalTime.html#MongoDB_Bson_BsonValue_AsNullableUniversalTime>`__ property instead. - The driver removes individual cluster events from ``MongoClient.Cluster``. To listen for - cluster events, call the `ClusterBuilder.Subscribe() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.ClusterBuilder.Subscribe.html>`__ + cluster events, call the `ClusterBuilder.Subscribe() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core.Configuration.ClusterBuilder.Subscribe.html>`__ method. - If any type in a collection uses a scalar discriminator, the driver throws diff --git a/source/run-command.txt b/source/run-command.txt index a6fb0cdc..e368b016 100644 --- a/source/run-command.txt +++ b/source/run-command.txt @@ -221,6 +221,6 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `RunCommand() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.RunCommand.html>`_ -- `RunCommandAsync() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.RunCommandAsync.html>`_ -- `ReadPreference <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.ReadPreference.html>`_ \ No newline at end of file +- `RunCommand() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.RunCommand.html>`_ +- `RunCommandAsync() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoDatabase.RunCommandAsync.html>`_ +- `ReadPreference <{+api-root+}/MongoDB.Driver/MongoDB.Driver.ReadPreference.html>`_ \ No newline at end of file diff --git a/source/security/authentication/aws-iam.txt b/source/security/authentication/aws-iam.txt index cc6def81..8c74de9a 100644 --- a/source/security/authentication/aws-iam.txt +++ b/source/security/authentication/aws-iam.txt @@ -242,7 +242,7 @@ API Documentation To learn more about any of the methods or types discussed on this page, see the following API documentation: -- `MongoClient <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ -- `MongoCredential <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__ -- `AddAWSAuthentication() <{+new-api-root+}/MongoDB.Driver.Authentication.Aws/MongoDB.Driver.Authentication.AWS.ExtensionManagerExtensions.AddAWSAuthentication.html>`__ \ No newline at end of file +- `MongoClient <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `MongoCredential <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__ +- `AddAWSAuthentication() <{+api-root+}/MongoDB.Driver.Authentication.Aws/MongoDB.Driver.Authentication.AWS.ExtensionManagerExtensions.AddAWSAuthentication.html>`__ \ No newline at end of file diff --git a/source/security/authentication/kerberos.txt b/source/security/authentication/kerberos.txt index 5d166e50..2fa0b56a 100644 --- a/source/security/authentication/kerberos.txt +++ b/source/security/authentication/kerberos.txt @@ -214,8 +214,8 @@ API Documentation To learn more about any of the methods or types discussed on this page, see the following API documentation: -- `MongoClient <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ -- `MongoCredential <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__ -- `CreateGssapiCredential() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.CreateGssapiCredential.html>`__ -- `WithMechanismProperty() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.WithMechanismProperty.html>`__ \ No newline at end of file +- `MongoClient <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `MongoCredential <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__ +- `CreateGssapiCredential() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.CreateGssapiCredential.html>`__ +- `WithMechanismProperty() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.WithMechanismProperty.html>`__ \ No newline at end of file diff --git a/source/security/authentication/ldap.txt b/source/security/authentication/ldap.txt index 88d8cba8..7b2f10db 100644 --- a/source/security/authentication/ldap.txt +++ b/source/security/authentication/ldap.txt @@ -84,7 +84,7 @@ API Documentation To learn more about any of the methods or types discussed on this page, see the following API documentation: -- `MongoClient <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ -- `MongoCredential <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__ -- `CreatePlainCredential() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.CreatePlainCredential.html>`__ \ No newline at end of file +- `MongoClient <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `MongoCredential <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__ +- `CreatePlainCredential() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.CreatePlainCredential.html>`__ \ No newline at end of file diff --git a/source/security/authentication/oidc.txt b/source/security/authentication/oidc.txt index 81cd766b..305679d4 100644 --- a/source/security/authentication/oidc.txt +++ b/source/security/authentication/oidc.txt @@ -262,12 +262,12 @@ API Documentation To learn more about any of the methods or types discussed on this page, see the following API documentation: -- `MongoClient() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ -- `MongoClientSettings() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ -- `MongoCredential() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__ -- `MongoClientSettings.Extensions.AddAWSAuthentication() <{+new-api-root+}/MongoDB.Driver/MongoClientSettings.Extensions.html#MongoDB_Driver_MongoClientSettings_Extensions_AddAWSAuthentication>`__ -- `CreateOidcCredential() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.CreateOidcCredential.html>`__ -- `WithMechanismProperty() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.CreateOidcCredential.html#MongoDB_Driver_MongoDB_Driver_MongoCredential_WithMechanismProperty>`__ -- `IOidcCallback <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core/Authentication/IOidcCallback.html>`__ -- `OidcAccessToken <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core/Authentication/OidcAccessToken.html>`__ -- `OidcCallbackParameters <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.Core/Authentication/OidcCallbackParameters.html>`__ \ No newline at end of file +- `MongoClient() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ +- `MongoClientSettings() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `MongoCredential() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__ +- `MongoClientSettings.Extensions.AddAWSAuthentication() <{+api-root+}/MongoDB.Driver/MongoClientSettings.Extensions.html#MongoDB_Driver_MongoClientSettings_Extensions_AddAWSAuthentication>`__ +- `CreateOidcCredential() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.CreateOidcCredential.html>`__ +- `WithMechanismProperty() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.CreateOidcCredential.html#MongoDB_Driver_MongoDB_Driver_MongoCredential_WithMechanismProperty>`__ +- `IOidcCallback <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core/Authentication/IOidcCallback.html>`__ +- `OidcAccessToken <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core/Authentication/OidcAccessToken.html>`__ +- `OidcCallbackParameters <{+api-root+}/MongoDB.Driver/MongoDB.Driver.Core/Authentication/OidcCallbackParameters.html>`__ \ No newline at end of file diff --git a/source/security/authentication/scram.txt b/source/security/authentication/scram.txt index 39a48ec8..9492be79 100644 --- a/source/security/authentication/scram.txt +++ b/source/security/authentication/scram.txt @@ -98,7 +98,7 @@ API Documentation To learn more about any of the methods or types discussed on this page, see the following API documentation: -- `MongoCredential <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__ -- `MongoClient <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ -- `CreateCredential() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.CreateCredential.html>`__ \ No newline at end of file +- `MongoCredential <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__ +- `MongoClient <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `CreateCredential() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.CreateCredential.html>`__ \ No newline at end of file diff --git a/source/security/authentication/x509.txt b/source/security/authentication/x509.txt index dc80bbce..968feaa5 100644 --- a/source/security/authentication/x509.txt +++ b/source/security/authentication/x509.txt @@ -135,12 +135,12 @@ API Documentation To learn more about any of the MongoDB methods and types used on this page, see the following API documentation: -- `MongoClient <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ -- `MongoCredential <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__ -- `SslSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.SslSettings.html>`__ -- `MongoServerAddress <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoServerAddress.html>`__ -- `CreateMongoX509Credential() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.CreateMongoX509Credential.html>`__ +- `MongoClient <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClient.html>`__ +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ +- `MongoCredential <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.html>`__ +- `SslSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.SslSettings.html>`__ +- `MongoServerAddress <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoServerAddress.html>`__ +- `CreateMongoX509Credential() <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoCredential.CreateMongoX509Credential.html>`__ For more information about the .NET types used on this page, see the following MSDN documentation: diff --git a/source/security/tls-ssl.txt b/source/security/tls-ssl.txt index a34cc5fd..25c8ced6 100644 --- a/source/security/tls-ssl.txt +++ b/source/security/tls-ssl.txt @@ -242,4 +242,4 @@ API Documentation To learn more about any of the connection options discussed in this guide, see the following API documentation: -- `MongoClientSettings <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ \ No newline at end of file +- `MongoClientSettings <{+api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.html>`__ \ No newline at end of file diff --git a/source/serialization.txt b/source/serialization.txt index 7e55fb58..ff3af7e9 100644 --- a/source/serialization.txt +++ b/source/serialization.txt @@ -47,7 +47,7 @@ interface. The {+driver-short+} has many built-in serializers made to handle primitive types, collection types, and custom classes. For a full list of available serializers, see the -`Serializers namespace API documentation <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Serializers.html>`__. +`Serializers namespace API documentation <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Serializers.html>`__. .. _csharp-faq-object-serializer: @@ -173,7 +173,7 @@ IBsonIdProvider ~~~~~~~~~~~~~~~ The `IBsonIdProvider -<{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.IBsonIdProvider.html>`__ +<{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.IBsonIdProvider.html>`__ interface provides the ``GetDocumentId()`` and ``SetDocumentId()`` methods, and is useful if the object you are serializing uses an ``_id`` type other than ``ObjectId``. @@ -181,7 +181,7 @@ IBsonDocumentSerializer ~~~~~~~~~~~~~~~~~~~~~~~ Implementing the `IBsonDocumentSerializer -<{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.IBsonDocumentSerializer.html>`__ +<{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.IBsonDocumentSerializer.html>`__ interface enables the driver to access the member information of the object you are serializing. This allows the driver to properly construct type-safe queries when using a custom serializer. @@ -190,7 +190,7 @@ IBsonArraySerializer ~~~~~~~~~~~~~~~~~~~~ Implementing the `IBsonArraySerializer -<{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.IBsonArraySerializer.html>`__ +<{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.IBsonArraySerializer.html>`__ interface enables the driver to access serialization information for individual items in an array. @@ -216,22 +216,22 @@ built-in conventions: * - Convention - Description - * - `CamelCaseElementNameConvention <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.CamelCaseElementNameConvention.html>`__ + * - `CamelCaseElementNameConvention <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.CamelCaseElementNameConvention.html>`__ - Converts element names to camel case during serialization and deserialization. - * - `EnumRepresentationConvention <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.EnumRepresentationConvention.html>`__ + * - `EnumRepresentationConvention <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.EnumRepresentationConvention.html>`__ - Converts enum values to a specified representation during serialization and deserialization. - * - `IgnoreExtraElementsConvention <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.IgnoreExtraElementsConvention.html>`__ + * - `IgnoreExtraElementsConvention <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.IgnoreExtraElementsConvention.html>`__ - Specifies whether to ignore extra elements in a document during deserialization. - * - `ObjectSerializerAllowedTypesConvention <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.ObjectSerializerAllowedTypesConvention.html>`__ + * - `ObjectSerializerAllowedTypesConvention <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.ObjectSerializerAllowedTypesConvention.html>`__ - Specifies which types are allowed to be serialized using an object serializer. To view a full list of available conventions, see the `Conventions -<{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.html>`__ +<{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.html>`__ class reference in the API Documentation. You can register a convention by instantiating a ``ConventionPack`` with the @@ -322,9 +322,9 @@ see the following pages: To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `SerializerRegistry <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.BsonSerializer.SerializerRegistry.html>`__ -- `BsonSerializer <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.BsonSerializer.html>`__ -- `IBsonSerializer <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.IBsonSerializer.html>`__ -- `ConventionPack <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.ConventionPack.html>`__ -- `ConventionRegistry <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.ConventionRegistry.html>`__ -- `Register() <{+new-api-root+}/MongoDB.Bson.Serialization.Conventions.ConventionRegistry.Register.html#MongoDB_Bson_Serialization_Conventions_ConventionRegistry_Register_System_String_MongoDB_Bson_Serialization_Conventions_IConventionPack_System_Func_System_Type_System_Boolean__>`__ +- `SerializerRegistry <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.BsonSerializer.SerializerRegistry.html>`__ +- `BsonSerializer <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.BsonSerializer.html>`__ +- `IBsonSerializer <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.IBsonSerializer.html>`__ +- `ConventionPack <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.ConventionPack.html>`__ +- `ConventionRegistry <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.ConventionRegistry.html>`__ +- `Register() <{+api-root+}/MongoDB.Bson.Serialization.Conventions.ConventionRegistry.Register.html#MongoDB_Bson_Serialization_Conventions_ConventionRegistry_Register_System_String_MongoDB_Bson_Serialization_Conventions_IConventionPack_System_Func_System_Type_System_Boolean__>`__ diff --git a/source/serialization/class-mapping.txt b/source/serialization/class-mapping.txt index cd1e629f..7fab6b9d 100644 --- a/source/serialization/class-mapping.txt +++ b/source/serialization/class-mapping.txt @@ -398,8 +398,8 @@ API Documentation ----------------- - `BsonClassMap - <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.BsonClassMap.html>`__ + <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.BsonClassMap.html>`__ - `RegisterClassMap - <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.BsonClassMap.RegisterClassMap.html>`__ + <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.BsonClassMap.RegisterClassMap.html>`__ - `AutoMap - <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.BsonClassMap.AutoMap.html>`__ + <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.BsonClassMap.AutoMap.html>`__ diff --git a/source/serialization/guids.txt b/source/serialization/guids.txt index 24ba397f..f3630409 100644 --- a/source/serialization/guids.txt +++ b/source/serialization/guids.txt @@ -27,7 +27,7 @@ also known as **universally unique identifiers** (UUIDs). .. tip:: ObjectId In MongoDB applications, you can use the - `ObjectId <{+new-api-root+}/api/MongoDB.Bson/MongoDB.Bson.ObjectId.html>`__ type + `ObjectId <{+api-root+}/api/MongoDB.Bson/MongoDB.Bson.ObjectId.html>`__ type as a unique identifier for a document. Consider using ``ObjectId`` instances in place of GUIDs in MongoDB applications where possible. @@ -82,7 +82,7 @@ which all MongoDB drivers encode in the same way. If your application uses GUIDs recommend using ``BsonBinaryData`` subtype 4 to store them. For a list of all ``BsonBinaryData`` subtypes, see the -API documentation for the `BsonBinarySubType <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonBinarySubType.html>`__ +API documentation for the `BsonBinarySubType <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonBinarySubType.html>`__ enum. Serializing GUIDs @@ -151,7 +151,7 @@ If you're using the {+driver-short+} to :ref:`automap your {+language+} classes to document schemas `, you can add the ``BsonGuidRepresentation`` attribute to a GUID property to specify its representation. This attribute accepts a value from the -`GuidRepresentation <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.GuidRepresentation.html>`__ +`GuidRepresentation <{+api-root+}/MongoDB.Bson/MongoDB.Bson.GuidRepresentation.html>`__ enum. The following code example specifies the ``Standard`` GUID representation for the @@ -240,8 +240,8 @@ Additional Information To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `BsonBinaryData <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.BsonBinaryData.html>`__ -- `BsonGuidRepresentation <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonGuidRepresentationAttribute.html>`__ -- `GuidSerializer <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Serializers.GuidSerializer.html>`__ -- `ObjectSerializer <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Serializers.ObjectSerializer.html>`__ -- `GuidRepresentation <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.GuidRepresentation.html>`__ +- `BsonBinaryData <{+api-root+}/MongoDB.Bson/MongoDB.Bson.BsonBinaryData.html>`__ +- `BsonGuidRepresentation <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonGuidRepresentationAttribute.html>`__ +- `GuidSerializer <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Serializers.GuidSerializer.html>`__ +- `ObjectSerializer <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Serializers.ObjectSerializer.html>`__ +- `GuidRepresentation <{+api-root+}/MongoDB.Bson/MongoDB.Bson.GuidRepresentation.html>`__ diff --git a/source/serialization/poco.txt b/source/serialization/poco.txt index b165356a..02ff987c 100644 --- a/source/serialization/poco.txt +++ b/source/serialization/poco.txt @@ -841,7 +841,7 @@ Additional Information ---------------------- For a full list of serialization-related attributes, see the -`Serialization.Attributes API documentation <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.html>`__. +`Serialization.Attributes API documentation <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.html>`__. To learn more about how the driver maps BSON documents to POCOs, see :ref:`csharp-class-mapping`. @@ -852,14 +852,14 @@ API Documentation To learn more about any of the methods or types discussed in this guide, see the following API documentation: -- `[BsonElement()] <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonElementAttribute.html>`__ -- `[BsonRepresentation()] <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonRepresentationAttribute.html>`__ -- `[BsonId()] <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonIdAttribute.html>`__ -- `[BsonIgnore()] <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonIgnoreAttribute.html>`__ -- `[BsonDefaultValue()] <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonDefaultValueAttribute.html>`__ -- `[BsonIgnoreIfDefault] <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonIgnoreIfDefaultAttribute.html>`__ -- `[BsonDateTimeOptions()] <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonDateTimeOptionsAttribute.html>`__ -- `[BsonDictionaryOptions()] <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonDictionaryOptionsAttribute.html>`__ -- `ConventionPack <{+new-api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.ConventionPack.html>`__ +- `[BsonElement()] <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonElementAttribute.html>`__ +- `[BsonRepresentation()] <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonRepresentationAttribute.html>`__ +- `[BsonId()] <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonIdAttribute.html>`__ +- `[BsonIgnore()] <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonIgnoreAttribute.html>`__ +- `[BsonDefaultValue()] <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonDefaultValueAttribute.html>`__ +- `[BsonIgnoreIfDefault] <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonIgnoreIfDefaultAttribute.html>`__ +- `[BsonDateTimeOptions()] <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonDateTimeOptionsAttribute.html>`__ +- `[BsonDictionaryOptions()] <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Attributes.BsonDictionaryOptionsAttribute.html>`__ +- `ConventionPack <{+api-root+}/MongoDB.Bson/MongoDB.Bson.Serialization.Conventions.ConventionPack.html>`__ - `InsertOne() - <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertMany.html>`__ + <{+api-root+}/MongoDB.Driver/MongoDB.Driver.IMongoCollection-1.InsertMany.html>`__ diff --git a/source/time-series.txt b/source/time-series.txt index 0b0c35e5..a055e657 100644 --- a/source/time-series.txt +++ b/source/time-series.txt @@ -111,8 +111,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>`__