deploy: 4e14b21

omnivector-solutions · Nov 21, 2023 · 99fc34e · 99fc34e
1 parent cd8442d
commit 99fc34e
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 31 deletions.
diff --git a/objects.inv b/objects.inv
diff --git a/reference/api/index.html b/reference/api/index.html
@@ -1655,22 +1655,22 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#jobbergate_api.storage.EngineFactory.cleanup" class="md-nav__link">
-    cleanup()
+  <a href="#jobbergate_api.storage.EngineFactory.auto_session" class="md-nav__link">
+    auto_session()
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#jobbergate_api.storage.EngineFactory.get_engine" class="md-nav__link">
-    get_engine()
+  <a href="#jobbergate_api.storage.EngineFactory.cleanup" class="md-nav__link">
+    cleanup()
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#jobbergate_api.storage.EngineFactory.get_session" class="md-nav__link">
-    get_session()
+  <a href="#jobbergate_api.storage.EngineFactory.get_engine" class="md-nav__link">
+    get_engine()
   </a>
 
 </li>
@@ -2616,22 +2616,22 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#jobbergate_api.storage.EngineFactory.cleanup" class="md-nav__link">
-    cleanup()
+  <a href="#jobbergate_api.storage.EngineFactory.auto_session" class="md-nav__link">
+    auto_session()
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#jobbergate_api.storage.EngineFactory.get_engine" class="md-nav__link">
-    get_engine()
+  <a href="#jobbergate_api.storage.EngineFactory.cleanup" class="md-nav__link">
+    cleanup()
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#jobbergate_api.storage.EngineFactory.get_session" class="md-nav__link">
-    get_session()
+  <a href="#jobbergate_api.storage.EngineFactory.get_engine" class="md-nav__link">
+    get_engine()
   </a>
 
 </li>
@@ -10938,21 +10938,24 @@ <h6 id="jobbergate_api.storage.EngineFactory.__init__" class="doc doc-heading">
 
 
 
-<h6 id="jobbergate_api.storage.EngineFactory.cleanup" class="doc doc-heading">
-          <span class="doc doc-object-name doc-function-name">cleanup</span>
+<h6 id="jobbergate_api.storage.EngineFactory.auto_session" class="doc doc-heading">
+          <span class="doc doc-object-name doc-function-name">auto_session</span>
 
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-async"><code>async</code></small>
   </span>
 
 </h6>
-<div class="doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">cleanup</span><span class="p">()</span>
+<div class="doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">auto_session</span><span class="p">(</span>
+</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>    <span class="n">override_db_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">commit</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>
+</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">typing</span><span class="o">.</span><span class="n">AsyncIterator</span><span class="p">[</span><span class="n">AsyncSession</span><span class="p">]</span>
 </span></code></pre></div>
 
   <div class="doc doc-contents ">
 
-      <p>Close all engines stored in the engine map and clears the engine_map.</p>
+      <p>Get an asynchronous database session.</p>
+<p>Gets a new session from the correct engine in the engine map.</p>
 
   </div>
 
@@ -10964,21 +10967,21 @@ <h6 id="jobbergate_api.storage.EngineFactory.cleanup" class="doc doc-heading">
 
 
 
-<h6 id="jobbergate_api.storage.EngineFactory.get_engine" class="doc doc-heading">
-          <span class="doc doc-object-name doc-function-name">get_engine</span>
+<h6 id="jobbergate_api.storage.EngineFactory.cleanup" class="doc doc-heading">
+          <span class="doc doc-object-name doc-function-name">cleanup</span>
 
+
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-async"><code>async</code></small>
+  </span>
 
 </h6>
-<div class="doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">get_engine</span><span class="p">(</span>
-</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>    <span class="n">override_db_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
-</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AsyncEngine</span>
+<div class="doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">cleanup</span><span class="p">()</span>
 </span></code></pre></div>
 
   <div class="doc doc-contents ">
 
-      <p>Get a database engine.</p>
-<p>If the database url is already in the engine map, return the engine stored there. Otherwise, build
-a new one, store it, and return the new engine.</p>
+      <p>Close all engines stored in the engine map and clears the engine_map.</p>
 
   </div>
 
@@ -10990,20 +10993,21 @@ <h6 id="jobbergate_api.storage.EngineFactory.get_engine" class="doc doc-heading"
 
 
 
-<h6 id="jobbergate_api.storage.EngineFactory.get_session" class="doc doc-heading">
-          <span class="doc doc-object-name doc-function-name">get_session</span>
+<h6 id="jobbergate_api.storage.EngineFactory.get_engine" class="doc doc-heading">
+          <span class="doc doc-object-name doc-function-name">get_engine</span>
 
 
 </h6>
-<div class="doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">get_session</span><span class="p">(</span>
+<div class="doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">get_engine</span><span class="p">(</span>
 </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>    <span class="n">override_db_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
-</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AsyncSession</span>
+</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AsyncEngine</span>
 </span></code></pre></div>
 
   <div class="doc doc-contents ">
 
-      <p>Get an asynchronous database session.</p>
-<p>Gets a new session from the correct engine in the engine map.</p>
+      <p>Get a database engine.</p>
+<p>If the database url is already in the engine map, return the engine stored there. Otherwise, build
+a new one, store it, and return the new engine.</p>
 
   </div>
 

diff --git a/search/search_index.json b/search/search_index.json
diff --git a/sitemap.xml.gz b/sitemap.xml.gz