nautobot 2.4.14__py3-none-any.whl → 2.4.16__py3-none-any.whl

nautobot/project-static/docs/code-reference/nautobot/apps/querysets.html

@@ -8743,6 +8743,29 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/breadcrumbs-titles.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    Breadcrumbs and titles
+    
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -10185,6 +10208,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -10207,7 +10231,7 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.models.querysets.RestrictedQuerySet" href="models.html#nautobot.apps.models.RestrictedQuerySet">RestrictedQuerySet</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.models.RestrictedQuerySet (nautobot.core.models.querysets.RestrictedQuerySet)" href="models.html#nautobot.apps.models.RestrictedQuerySet">RestrictedQuerySet</a></code></p>
 
 
         <p>QuerySet manager used by models which support ConfigContext (device and virtual machine).</p>
@@ -10225,6 +10249,7 @@ multiple objects.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -10252,6 +10277,7 @@ unlike PostgreSQL's implementation. This is why we include "weight" and "name" i
 sort it within Python to ensure correctness.</p>
 <p>Do not use this method by itself, use get_config_context() method directly on ConfigContextModel instead.</p>
 
+
     </div>
 
 </div>

nautobot/project-static/docs/code-reference/nautobot/apps/secrets.html

@@ -8770,6 +8770,29 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/breadcrumbs-titles.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    Breadcrumbs and titles
+    
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -10239,6 +10262,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -10274,6 +10298,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -10301,6 +10326,7 @@
 
         <p>Django Form class with inputs for describing the parameter(s) required for a Secret to use this Provider.</p>
 <p>The clean() method may be implemented to provide additional input validation.</p>
+
     </div>
 
 </div>
@@ -10322,6 +10348,7 @@
     <div class="doc doc-contents ">
 
         <p>Human-friendly name for this class, falling back to the slug if not overridden.</p>
+
     </div>
 
 </div>
@@ -10344,6 +10371,7 @@
     <div class="doc doc-contents ">
 
         <p>String uniquely identifying this class; will be used as a key to look up the class owning a given Secret.</p>
+
     </div>
 
 </div>
@@ -10402,7 +10430,7 @@
                 <code>obj</code>
             </td>
             <td>
-                  <code>object</code>
+                  <code><span title="object">object</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -10416,6 +10444,7 @@
       </tbody>
     </table>
 
+
     </div>
 
 </div>

nautobot/project-static/docs/code-reference/nautobot/apps/tables.html

@@ -8236,6 +8236,15 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.tables.BaseTable.add_conditional_prefetch" class="md-nav__link">
+    <span class="md-ellipsis">
+      add_conditional_prefetch
+    </span>
+  </a>
+  
 </li>
         
       </ul>
@@ -8917,6 +8926,29 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/breadcrumbs-titles.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    Breadcrumbs and titles
+    
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -10312,6 +10344,15 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.tables.BaseTable.add_conditional_prefetch" class="md-nav__link">
+    <span class="md-ellipsis">
+      add_conditional_prefetch
+    </span>
+  </a>
+  
 </li>
         
       </ul>
@@ -10533,6 +10574,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -10569,6 +10611,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -10609,7 +10652,7 @@
                 <code>*args</code>
             </td>
             <td>
-                  <code>list</code>
+                  <code><span title="list">list</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -10625,7 +10668,7 @@
                 <code>table_changes_pending</code>
             </td>
             <td>
-                  <code>bool</code>
+                  <code><span title="bool">bool</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -10641,7 +10684,7 @@
                 <code>saved_view</code>
             </td>
             <td>
-                  <code>SavedView</code>
+                  <code><span title="SavedView">SavedView</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -10657,7 +10700,7 @@
                 <code>user</code>
             </td>
             <td>
-                  <code>User</code>
+                  <code><span title="User">User</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -10673,7 +10716,7 @@
                 <code>hide_hierarchy_ui</code>
             </td>
             <td>
-                  <code>bool</code>
+                  <code><span title="bool">bool</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -10689,7 +10732,7 @@
                 <code>order_by</code>
             </td>
             <td>
-                  <code>list</code>
+                  <code><span title="list">list</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -10705,7 +10748,7 @@
                 <code>data_transform_callback</code>
             </td>
             <td>
-                  <code>function</code>
+                  <code><span title="function">function</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -10723,7 +10766,7 @@ Used for example in IPAM views to inject "fake" records for "available" Prefixes
                 <code>**kwargs</code>
             </td>
             <td>
-                  <code>dict</code>
+                  <code><span title="dict">dict</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -10740,6 +10783,89 @@ Used for example in IPAM views to inject "fake" records for "available" Prefixes
     Do not modify/set the <code>base_columns</code> attribute after BaseTable class is instantiated.
     Do not modify/set the <code>base_columns</code> attribute after calling super().<strong>init</strong>() of BaseTable class.</p>
 
+
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+<h3 id="nautobot.apps.tables.BaseTable.add_conditional_prefetch" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">add_conditional_prefetch</span><span class="p">(</span><span class="n">table_field</span><span class="p">,</span> <span class="n">db_column</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">prefetch</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
+
+<a href="#nautobot.apps.tables.BaseTable.add_conditional_prefetch" class="headerlink" title="Permanent link">&para;</a></h3>
+
+
+    <div class="doc doc-contents ">
+
+        <p>Conditionally prefetch the specified database column if the related table field is visible.</p>
+
+
+<p><span class="doc-section-title">Parameters:</span></p>
+    <table>
+      <thead>
+        <tr>
+          <th>Name</th>
+          <th>Type</th>
+          <th>Description</th>
+          <th>Default</th>
+        </tr>
+      </thead>
+      <tbody>
+          <tr class="doc-section-item">
+            <td>
+                <code>table_field</code>
+            </td>
+            <td>
+                  <code><span title="str">str</span></code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>Name of the field on the table to check for visibility. Also used as the prefetch field
+               if neither db_column nor prefetch is specified.</p>
+              </div>
+            </td>
+            <td>
+                <em>required</em>
+            </td>
+          </tr>
+          <tr class="doc-section-item">
+            <td>
+                <code>db_column</code>
+            </td>
+            <td>
+                  <code><span title="str">str</span></code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>Optionally specify the db column to prefetch. Mutually exclusive with prefetch.</p>
+              </div>
+            </td>
+            <td>
+                  <code>None</code>
+            </td>
+          </tr>
+          <tr class="doc-section-item">
+            <td>
+                <code>prefetch</code>
+            </td>
+            <td>
+                  <code><span title="django.db.models.Prefetch">Prefetch</span></code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>Optionally specify a prefetch object. Mutually exclusive with db_column.</p>
+              </div>
+            </td>
+            <td>
+                  <code>None</code>
+            </td>
+          </tr>
+      </tbody>
+    </table>
+
+
     </div>
 
 </div>
@@ -10779,6 +10905,7 @@ character.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -10826,6 +10953,7 @@ character.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -10871,6 +10999,7 @@ choices. The CSS class is derived by calling .get_FOO_class() on the row record.
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -10915,6 +11044,7 @@ choices. The CSS class is derived by calling .get_FOO_class() on the row record.
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -10959,6 +11089,7 @@ choices. The CSS class is derived by calling .get_FOO_class() on the row record.
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11003,6 +11134,7 @@ choices. The CSS class is derived by calling .get_FOO_class() on the row record.
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11053,6 +11185,7 @@ set <code>sort_items=False</code>.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11076,6 +11209,7 @@ set <code>sort_items=False</code>.</p>
 
         <p>Overload filter to optionally sort items.</p>
 
+
     </div>
 
 </div>
@@ -11093,6 +11227,7 @@ set <code>sort_items=False</code>.</p>
 
         <p>Overload render to optionally truncate words.</p>
 
+
     </div>
 
 </div>
@@ -11131,6 +11266,7 @@ set <code>sort_items=False</code>.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11184,7 +11320,7 @@ set <code>sort_items=False</code>.</p>
                 <code>viewname</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11200,7 +11336,7 @@ set <code>sort_items=False</code>.</p>
                 <code>url_params</code>
             </td>
             <td>
-                  <code>dict</code>
+                  <code><span title="dict">dict</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11217,7 +11353,7 @@ set <code>sort_items=False</code>.</p>
                 <code>view_kwargs</code>
             </td>
             <td>
-                  <code>dict</code>
+                  <code><span title="dict">dict</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11233,7 +11369,7 @@ set <code>sort_items=False</code>.</p>
                 <code>lookup</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11252,7 +11388,7 @@ TODO: this currently does <em>not</em> support nested lookups via <code>__</code
                 <code>reverse_lookup</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11269,7 +11405,7 @@ If not specified, the first key in <code>url_params</code> will be implicitly us
                 <code>distinct</code>
             </td>
             <td>
-                  <code>bool</code>
+                  <code><span title="bool">bool</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11285,7 +11421,7 @@ If not specified, the first key in <code>url_params</code> will be implicitly us
                 <code>display_field</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11303,7 +11439,7 @@ If not specified, it will use the "display" field.</p>
                 <code>**kwargs</code>
             </td>
             <td>
-                  <code>dict</code>
+                  <code><span title="dict">dict</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11353,6 +11489,7 @@ If not specified, it will use the "display" field.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11397,6 +11534,7 @@ If not specified, it will use the "display" field.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11428,7 +11566,7 @@ If not specified, it will use the "display" field.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.tables.BaseTable" href="#nautobot.apps.tables.BaseTable">BaseTable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.tables.BaseTable (nautobot.core.tables.BaseTable)" href="#nautobot.apps.tables.BaseTable">BaseTable</a></code></p>
 
 
         <p>Mixin to add a <code>role</code> field to a table.</p>
@@ -11441,6 +11579,7 @@ If not specified, it will use the "display" field.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11472,7 +11611,7 @@ If not specified, it will use the "display" field.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.tables.BaseTable" href="#nautobot.apps.tables.BaseTable">BaseTable</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.tables.BaseTable (nautobot.core.tables.BaseTable)" href="#nautobot.apps.tables.BaseTable">BaseTable</a></code></p>
 
 
         <p>Mixin to add a <code>status</code> field to a table.</p>
@@ -11485,6 +11624,7 @@ If not specified, it will use the "display" field.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11532,6 +11672,7 @@ If not specified, it will use the "display" field.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11562,6 +11703,7 @@ If not specified, it will use the "display" field.</p>
 example:
     return queryset.prefetch_related("my_model_set")</p>
 
+
     </div>
 
 </div>
@@ -11600,6 +11742,7 @@ example:
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11644,6 +11787,7 @@ example:
 
 
 
+
   <div class="doc doc-children">