Add 8.2.1 Api docs

mongodb · Dec 13, 2024 · 8580e7b · 8580e7b
1 parent 5c98dca
commit 8580e7b
Show file tree

Hide file tree

Showing 547 changed files with 87,064 additions and 0 deletions.
diff --git a/8.2.1/api/Microsoft.EntityFrameworkCore.MongoDbContextOptionsExtensions.UseMongoDB.html b/8.2.1/api/Microsoft.EntityFrameworkCore.MongoDbContextOptionsExtensions.UseMongoDB.html
diff --git a/8.2.1/api/Microsoft.EntityFrameworkCore.MongoDbContextOptionsExtensions.html b/8.2.1/api/Microsoft.EntityFrameworkCore.MongoDbContextOptionsExtensions.html
@@ -0,0 +1,193 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+      <title>Class MongoDbContextOptionsExtensions | MongoDB EF Core Provider API Reference </title>
+      <meta name="viewport" content="width=device-width, initial-scale=1.0">
+      <meta name="title" content="Class MongoDbContextOptionsExtensions | MongoDB EF Core Provider API Reference ">
+
+      <meta name="description" content="MongoDB-specific extension methods for .">
+      <link rel="icon" href="../favicon.ico">
+      <link rel="stylesheet" href="../public/docfx.min.css">
+      <link rel="stylesheet" href="../public/main.css">
+      <meta name="docfx:navrel" content="">
+      <meta name="docfx:tocrel" content="toc.html">
+
+
+
+
+      <meta name="docfx:docurl" content="https://github.com/mongodb/mongo-efcore-provider/new/main/apiSpec/new?filename=Microsoft_EntityFrameworkCore_MongoDbContextOptionsExtensions.md&amp;value=---%0Auid%3A%20Microsoft.EntityFrameworkCore.MongoDbContextOptionsExtensions%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
+      <meta name="loc:inThisArticle" content="In this article">
+      <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
+      <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
+      <meta name="loc:tocFilter" content="Filter by title">
+      <meta name="loc:nextArticle" content="Next">
+      <meta name="loc:prevArticle" content="Previous">
+      <meta name="loc:themeLight" content="Light">
+      <meta name="loc:themeDark" content="Dark">
+      <meta name="loc:themeAuto" content="Auto">
+      <meta name="loc:changeTheme" content="Change theme">
+      <meta name="loc:copy" content="Copy">
+      <meta name="loc:downloadPdf" content="Download PDF">
+
+      <script type="module" src="./../public/docfx.min.js"></script>
+
+      <script>
+        const theme = localStorage.getItem('theme') || 'auto'
+        document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
+      </script>
+
+  </head>
+
+  <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
+    <header class="bg-body border-bottom">
+      <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
+        <div class="container-xxl flex-nowrap">
+          <a class="navbar-brand" href="../index.html">
+            <img id="logo" class="svg" src="../images/mongodb-logo.svg" alt="">
+
+          </a>
+          <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
+            <i class="bi bi-three-dots"></i>
+          </button>
+          <div class="collapse navbar-collapse" id="navpanel">
+            <div id="navbar">
+            </div>
+          </div>
+        </div>
+      </nav>
+    </header>
+
+    <main class="container-xxl">
+      <div class="toc-offcanvas">
+        <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
+          <div class="offcanvas-header">
+            <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
+            <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
+          </div>
+          <div class="offcanvas-body">
+            <nav class="toc" id="toc"></nav>
+          </div>
+        </div>
+      </div>
+
+      <div class="content">
+        <div class="actionbar">
+          <button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
+            <i class="bi bi-list"></i>
+          </button>
+
+          <nav id="breadcrumb"></nav>
+        </div>
+
+        <article data-uid="Microsoft.EntityFrameworkCore.MongoDbContextOptionsExtensions">
+
+
+
+  <h1 id="Microsoft_EntityFrameworkCore_MongoDbContextOptionsExtensions" data-uid="Microsoft.EntityFrameworkCore.MongoDbContextOptionsExtensions" class="text-break">
+Class MongoDbContextOptionsExtensions  <a class="header-action link-secondary" title="View source" href="https://github.com/mongodb/mongo-efcore-provider/blob/main/src/MongoDB.EntityFrameworkCore/Extensions/MongoDbContextOptionsExtensions.cs/#L28"><i class="bi bi-code-slash"></i></a>
+  </h1>
+
+  <div class="facts text-secondary">
+    <dl><dt>Namespace</dt><dd><a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft">Microsoft</a>.<a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.entityframeworkcore">EntityFrameworkCore</a></dd></dl>
+  <dl><dt>Assembly</dt><dd>MongoDB.EntityFrameworkCore.dll</dd></dl>
+  </div>
+
+  <div class="markdown summary"><p>MongoDB-specific extension methods for <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.entityframeworkcore.dbcontextoptionsbuilder">DbContextOptionsBuilder</a>.</p>
+</div>
+  <div class="markdown conceptual"></div>
+
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public static class MongoDbContextOptionsExtensions</code></pre>
+  </div>
+
+
+
+
+  <dl class="typelist inheritance">
+    <dt>Inheritance</dt>
+    <dd>
+      <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
+      <div><span class="xref">MongoDbContextOptionsExtensions</span></div>
+    </dd>
+  </dl>
+
+
+
+  <dl class="typelist inheritedMembers">
+    <dt>Inherited Members</dt>
+    <dd>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
+    </div>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
+    </div>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
+    </div>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
+    </div>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
+    </div>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
+    </div>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
+    </div>
+  </dd></dl>
+
+
+
+
+
+  <h2 class="section" id="methods">Methods
+</h2>
+
+  <dl class="jumplist">
+    <dt><a class="xref" href="Microsoft.EntityFrameworkCore.MongoDbContextOptionsExtensions.UseMongoDB.html#Microsoft_EntityFrameworkCore_MongoDbContextOptionsExtensions_UseMongoDB_Microsoft_EntityFrameworkCore_DbContextOptionsBuilder_MongoDB_Driver_IMongoClient_System_String_System_Action_MongoDB_EntityFrameworkCore_Infrastructure_MongoDbContextOptionsBuilder__">UseMongoDB(DbContextOptionsBuilder, IMongoClient, string, Action&lt;MongoDbContextOptionsBuilder&gt;?)</a></dt>
+    <dd><p>Configures the context to connect to a MongoDB database using the <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.entityframeworkcore.dbcontextoptionsbuilder">DbContextOptionsBuilder</a>.</p>
+</dd>
+  </dl>
+  <dl class="jumplist">
+    <dt><a class="xref" href="Microsoft.EntityFrameworkCore.MongoDbContextOptionsExtensions.UseMongoDB.html#Microsoft_EntityFrameworkCore_MongoDbContextOptionsExtensions_UseMongoDB_Microsoft_EntityFrameworkCore_DbContextOptionsBuilder_System_String_System_String_System_Action_MongoDB_EntityFrameworkCore_Infrastructure_MongoDbContextOptionsBuilder__">UseMongoDB(DbContextOptionsBuilder, string, string, Action&lt;MongoDbContextOptionsBuilder&gt;?)</a></dt>
+    <dd><p>Configures the context to connect to a MongoDB database using the <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.entityframeworkcore.dbcontextoptionsbuilder">DbContextOptionsBuilder</a>.</p>
+</dd>
+  </dl>
+  <dl class="jumplist">
+    <dt><a class="xref" href="Microsoft.EntityFrameworkCore.MongoDbContextOptionsExtensions.UseMongoDB.html#Microsoft_EntityFrameworkCore_MongoDbContextOptionsExtensions_UseMongoDB__1_Microsoft_EntityFrameworkCore_DbContextOptionsBuilder___0__MongoDB_Driver_IMongoClient_System_String_System_Action_MongoDB_EntityFrameworkCore_Infrastructure_MongoDbContextOptionsBuilder__">UseMongoDB&lt;TContext&gt;(DbContextOptionsBuilder&lt;TContext&gt;, IMongoClient, string, Action&lt;MongoDbContextOptionsBuilder&gt;?)</a></dt>
+    <dd><p>Configures the <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.entityframeworkcore.dbcontext">DbContext</a> subclass to connect to a MongoDB database.</p>
+</dd>
+  </dl>
+  <dl class="jumplist">
+    <dt><a class="xref" href="Microsoft.EntityFrameworkCore.MongoDbContextOptionsExtensions.UseMongoDB.html#Microsoft_EntityFrameworkCore_MongoDbContextOptionsExtensions_UseMongoDB__1_Microsoft_EntityFrameworkCore_DbContextOptionsBuilder___0__System_String_System_String_System_Action_MongoDB_EntityFrameworkCore_Infrastructure_MongoDbContextOptionsBuilder__">UseMongoDB&lt;TContext&gt;(DbContextOptionsBuilder&lt;TContext&gt;, string, string, Action&lt;MongoDbContextOptionsBuilder&gt;?)</a></dt>
+    <dd><p>Configures the <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.entityframeworkcore.dbcontext">DbContext</a> subclass to connect to a MongoDB database.</p>
+</dd>
+  </dl>
+
+
+
+</article>
+
+
+
+      </div>
+
+      <div class="affix">
+        <nav id="affix"></nav>
+      </div>
+    </main>
+
+
+    <footer class="border-top text-secondary">
+      <div class="container-xxl">
+        <div class="flex-fill">
+          &copy; 2023 MongoDB, Inc.
+        </div>
+      </div>
+    </footer>
+  </body>
+</html>
diff --git a/8.2.1/api/Microsoft.EntityFrameworkCore.MongoOptionsExtension.-ctor.html b/8.2.1/api/Microsoft.EntityFrameworkCore.MongoOptionsExtension.-ctor.html
@@ -0,0 +1,195 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+      <title>Constructor MongoOptionsExtension | MongoDB EF Core Provider API Reference </title>
+      <meta name="viewport" content="width=device-width, initial-scale=1.0">
+      <meta name="title" content="Constructor MongoOptionsExtension | MongoDB EF Core Provider API Reference ">
+
+
+      <link rel="icon" href="../favicon.ico">
+      <link rel="stylesheet" href="../public/docfx.min.css">
+      <link rel="stylesheet" href="../public/main.css">
+      <meta name="docfx:navrel" content="">
+      <meta name="docfx:tocrel" content="toc.html">
+
+
+
+
+      <meta name="docfx:docurl" content="https://github.com/mongodb/mongo-efcore-provider/new/main/apiSpec/new?filename=Microsoft_EntityFrameworkCore_MongoOptionsExtension__ctor_.md&amp;value=---%0Auid%3A%20Microsoft.EntityFrameworkCore.MongoOptionsExtension.%23ctor*%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
+      <meta name="loc:inThisArticle" content="In this article">
+      <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
+      <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
+      <meta name="loc:tocFilter" content="Filter by title">
+      <meta name="loc:nextArticle" content="Next">
+      <meta name="loc:prevArticle" content="Previous">
+      <meta name="loc:themeLight" content="Light">
+      <meta name="loc:themeDark" content="Dark">
+      <meta name="loc:themeAuto" content="Auto">
+      <meta name="loc:changeTheme" content="Change theme">
+      <meta name="loc:copy" content="Copy">
+      <meta name="loc:downloadPdf" content="Download PDF">
+
+      <script type="module" src="./../public/docfx.min.js"></script>
+
+      <script>
+        const theme = localStorage.getItem('theme') || 'auto'
+        document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
+      </script>
+
+  </head>
+
+  <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
+    <header class="bg-body border-bottom">
+      <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
+        <div class="container-xxl flex-nowrap">
+          <a class="navbar-brand" href="../index.html">
+            <img id="logo" class="svg" src="../images/mongodb-logo.svg" alt="">
+
+          </a>
+          <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
+            <i class="bi bi-three-dots"></i>
+          </button>
+          <div class="collapse navbar-collapse" id="navpanel">
+            <div id="navbar">
+            </div>
+          </div>
+        </div>
+      </nav>
+    </header>
+
+    <main class="container-xxl">
+      <div class="toc-offcanvas">
+        <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
+          <div class="offcanvas-header">
+            <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
+            <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
+          </div>
+          <div class="offcanvas-body">
+            <nav class="toc" id="toc"></nav>
+          </div>
+        </div>
+      </div>
+
+      <div class="content">
+        <div class="actionbar">
+          <button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
+            <i class="bi bi-list"></i>
+          </button>
+
+          <nav id="breadcrumb"></nav>
+        </div>
+
+        <article data-uid="Microsoft.EntityFrameworkCore.MongoOptionsExtension.#ctor*">
+
+
+
+
+
+<h1 id="Microsoft_EntityFrameworkCore_MongoOptionsExtension__ctor_" data-uid="Microsoft.EntityFrameworkCore.MongoOptionsExtension.#ctor*" class="text-break">
+Constructor MongoOptionsExtension  <a class="header-action link-secondary" title="View source" href="https://github.com/mongodb/mongo-efcore-provider/blob/main/src/MongoDB.EntityFrameworkCore/Infrastructure/MongoOptionsExtension.cs/#L45"><i class="bi bi-code-slash"></i></a>
+</h1>
+
+<div class="facts text-secondary">
+  <dl><dt>Namespace</dt><dd><a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft">Microsoft</a>.<a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.entityframeworkcore">EntityFrameworkCore</a></dd></dl>
+  <dl><dt>Assembly</dt><dd>MongoDB.EntityFrameworkCore.dll</dd></dl>
+</div>
+
+<div class="markdown summary"></div>
+<div class="markdown conceptual"></div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<a id="Microsoft_EntityFrameworkCore_MongoOptionsExtension__ctor_" data-uid="Microsoft.EntityFrameworkCore.MongoOptionsExtension.#ctor*"></a>
+
+<h3 id="Microsoft_EntityFrameworkCore_MongoOptionsExtension__ctor" data-uid="Microsoft.EntityFrameworkCore.MongoOptionsExtension.#ctor">
+  MongoOptionsExtension()
+  <a class="header-action link-secondary" title="View source" href="https://github.com/mongodb/mongo-efcore-provider/blob/main/src/MongoDB.EntityFrameworkCore/Infrastructure/MongoOptionsExtension.cs/#L45"><i class="bi bi-code-slash"></i></a>
+</h3>
+
+<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Microsoft.EntityFrameworkCore.MongoOptionsExtension.html">MongoOptionsExtension</a>.</p>
+</div>
+<div class="markdown level1 conceptual"></div>
+
+<div class="codewrapper">
+  <pre><code class="lang-csharp hljs">public MongoOptionsExtension()</code></pre>
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<a id="Microsoft_EntityFrameworkCore_MongoOptionsExtension__ctor_" data-uid="Microsoft.EntityFrameworkCore.MongoOptionsExtension.#ctor*"></a>
+
+<h3 id="Microsoft_EntityFrameworkCore_MongoOptionsExtension__ctor_Microsoft_EntityFrameworkCore_MongoOptionsExtension_" data-uid="Microsoft.EntityFrameworkCore.MongoOptionsExtension.#ctor(Microsoft.EntityFrameworkCore.MongoOptionsExtension)">
+  MongoOptionsExtension(MongoOptionsExtension)
+  <a class="header-action link-secondary" title="View source" href="https://github.com/mongodb/mongo-efcore-provider/blob/main/src/MongoDB.EntityFrameworkCore/Infrastructure/MongoOptionsExtension.cs/#L52"><i class="bi bi-code-slash"></i></a>
+</h3>
+
+<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Microsoft.EntityFrameworkCore.MongoOptionsExtension.html">MongoOptionsExtension</a> by copying from an existing instance.</p>
+</div>
+<div class="markdown level1 conceptual"></div>
+
+<div class="codewrapper">
+  <pre><code class="lang-csharp hljs">protected MongoOptionsExtension(MongoOptionsExtension copyFrom)</code></pre>
+</div>
+
+<h4 class="section">Parameters</h4>
+<dl class="parameters">
+  <dt><code>copyFrom</code> <a class="xref" href="Microsoft.EntityFrameworkCore.MongoOptionsExtension.html">MongoOptionsExtension</a></dt>
+  <dd></dd>
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+</article>
+
+
+
+      </div>
+
+      <div class="affix">
+        <nav id="affix"></nav>
+      </div>
+    </main>
+
+
+    <footer class="border-top text-secondary">
+      <div class="container-xxl">
+        <div class="flex-fill">
+          &copy; 2023 MongoDB, Inc.
+        </div>
+      </div>
+    </footer>
+  </body>
+</html>