docs: rename "ingest" to "orchestrate"

qe-collaborative-services · Jan 5, 2024 · 3a72821 · 3a72821
1 parent 782a989
commit 3a72821
Show file tree

Hide file tree

Showing 20 changed files with 337 additions and 241 deletions.
diff --git a/support/docs/lib/ahc-hrsn-elt/screening/all_symbols.html b/support/docs/lib/ahc-hrsn-elt/screening/all_symbols.html
@@ -46,11 +46,11 @@ <h2 class="section_title" id="Class"><a href="#Class" aria-label="Anchor">Classe
   c
 </div>
 
-            <a href=".//~/IngestEngine.html">IngestEngine</a>
+            <a href=".//~/OrchEngine.html">OrchEngine</a>
           </div>
         </td>
         <td class="symbol_section_doc">
-        <div class="markdown_summary"><p>Use IngestEngine to prepare SQL for ingestion steps and execute them
+        <div class="markdown_summary"><p>Use OrchEngine to prepare SQL for orchestration steps and execute them
 using DuckDB CLI engine. Each method that does not have a @ieDescr.disregard()
 attribute is considered a &quot;step&quot; and each step is executed in the order it is
 declared. As each step is executed, its error or results are passed to the
@@ -71,7 +71,15 @@ <h2 class="section_title" id="Class"><a href="#Class" aria-label="Anchor">Classe
           </div>
         </td>
         <td class="symbol_section_doc">
-
+        <div class="markdown_summary"><p>Encapsulates <a href="https://sql.ophir.dev/">SQLPage</a> content. SqlPageNotebook has
+methods with the name of each <a href="https://sql.ophir.dev/">SQLPage</a> content that
+we want in the database. The MutationSqlNotebook sqlPageSeedDML method
+&quot;reads&quot; the cells in the SqlPageNotebook (each method's result) and
+generates SQL to insert the content of the page in the database in the format
+and table expected by <a href="https://sql.ophir.dev/">SQLPage</a>.
+NOTE: we break our PascalCase convention for the name of the class since SQLPage
+is a proper noun (product name).</p>
+</div>
         </td>
       </tr>
 
@@ -195,7 +203,7 @@ <h2 class="section_title" id="Interface"><a href="#Interface" aria-label="Anchor
   I
 </div>
 
-            <a href=".//~/IngestEngineArgs.html">IngestEngineArgs</a>
+            <a href=".//~/OrchEngineArgs.html">OrchEngineArgs</a>
           </div>
         </td>
         <td class="symbol_section_doc">
@@ -235,7 +243,7 @@ <h2 class="section_title" id="TypeAlias"><a href="#TypeAlias" aria-label="Anchor
   T
 </div>
 
-            <a href=".//~/IngestStep.html">IngestStep</a>
+            <a href=".//~/OrchStep.html">OrchStep</a>
           </div>
         </td>
         <td class="symbol_section_doc">
@@ -251,7 +259,7 @@ <h2 class="section_title" id="TypeAlias"><a href="#TypeAlias" aria-label="Anchor
   T
 </div>
 
-            <a href=".//~/IngestStepContext.html">IngestStepContext</a>
+            <a href=".//~/OrchStepContext.html">OrchStepContext</a>
           </div>
         </td>
         <td class="symbol_section_doc">
@@ -307,7 +315,7 @@ <h2 class="section_title" id="Variable"><a href="#Variable" aria-label="Anchor">
   v
 </div>
 
-            <a href=".//~/ieDescr.html">ieDescr</a>
+            <a href=".//~/oeDescr.html">oeDescr</a>
           </div>
         </td>
         <td class="symbol_section_doc">

diff --git a/support/docs/lib/ahc-hrsn-elt/screening/index.html b/support/docs/lib/ahc-hrsn-elt/screening/index.html
@@ -39,12 +39,12 @@ <h4>Class</h4>
             </li>
 
             <li>
-              <a href=".//~/IngestEngine.html">
+              <a href=".//~/OrchEngine.html">
                 <div class="symbol_kind kind_Class_text kind_Class_bg" title="Class">
   c
 </div>
 
-                <span>IngestEngine</span>
+                <span>OrchEngine</span>
               </a>
             </li>
 
@@ -133,12 +133,12 @@ <h4>Interface</h4>
           <ul>
 
             <li>
-              <a href=".//~/IngestEngineArgs.html">
+              <a href=".//~/OrchEngineArgs.html">
                 <div class="symbol_kind kind_Interface_text kind_Interface_bg" title="Interface">
   I
 </div>
 
-                <span>IngestEngineArgs</span>
+                <span>OrchEngineArgs</span>
               </a>
             </li>
 
@@ -160,22 +160,22 @@ <h4>Type Alias</h4>
             </li>
 
             <li>
-              <a href=".//~/IngestStep.html">
+              <a href=".//~/OrchStep.html">
                 <div class="symbol_kind kind_TypeAlias_text kind_TypeAlias_bg" title="Type Alias">
   T
 </div>
 
-                <span>IngestStep</span>
+                <span>OrchStep</span>
               </a>
             </li>
 
             <li>
-              <a href=".//~/IngestStepContext.html">
+              <a href=".//~/OrchStepContext.html">
                 <div class="symbol_kind kind_TypeAlias_text kind_TypeAlias_bg" title="Type Alias">
   T
 </div>
 
-                <span>IngestStepContext</span>
+                <span>OrchStepContext</span>
               </a>
             </li>
 
@@ -207,12 +207,12 @@ <h4>Variable</h4>
             </li>
 
             <li>
-              <a href=".//~/ieDescr.html">
+              <a href=".//~/oeDescr.html">
                 <div class="symbol_kind kind_Variable_text kind_Variable_bg" title="Variable">
   v
 </div>
 
-                <span>ieDescr</span>
+                <span>oeDescr</span>
               </a>
             </li>
 

diff --git a/support/docs/lib/ahc-hrsn-elt/screening/search_index.js b/support/docs/lib/ahc-hrsn-elt/screening/search_index.js
diff --git a/support/docs/lib/ahc-hrsn-elt/screening/~/ExcelSheetTodoIngestSource.html b/support/docs/lib/ahc-hrsn-elt/screening/~/ExcelSheetTodoIngestSource.html
@@ -30,12 +30,12 @@ <h3>Class</h3>
             </li>
 
             <li>
-              <a href="../.././/~/IngestEngine.html">
+              <a href="../.././/~/OrchEngine.html">
                 <div class="symbol_kind kind_Class_text kind_Class_bg" title="Class">
   c
 </div>
 
-                <span>IngestEngine</span>
+                <span>OrchEngine</span>
               </a>
             </li>
 
@@ -120,12 +120,12 @@ <h3>Interface</h3>
         <ul>
 
             <li>
-              <a href="../.././/~/IngestEngineArgs.html">
+              <a href="../.././/~/OrchEngineArgs.html">
                 <div class="symbol_kind kind_Interface_text kind_Interface_bg" title="Interface">
   I
 </div>
 
-                <span>IngestEngineArgs</span>
+                <span>OrchEngineArgs</span>
               </a>
             </li>
 
@@ -145,22 +145,22 @@ <h3>Type Alias</h3>
             </li>
 
             <li>
-              <a href="../.././/~/IngestStep.html">
+              <a href="../.././/~/OrchStep.html">
                 <div class="symbol_kind kind_TypeAlias_text kind_TypeAlias_bg" title="Type Alias">
   T
 </div>
 
-                <span>IngestStep</span>
+                <span>OrchStep</span>
               </a>
             </li>
 
             <li>
-              <a href="../.././/~/IngestStepContext.html">
+              <a href="../.././/~/OrchStepContext.html">
                 <div class="symbol_kind kind_TypeAlias_text kind_TypeAlias_bg" title="Type Alias">
   T
 </div>
 
-                <span>IngestStepContext</span>
+                <span>OrchStepContext</span>
               </a>
             </li>
 
@@ -190,12 +190,12 @@ <h3>Variable</h3>
             </li>
 
             <li>
-              <a href="../.././/~/ieDescr.html">
+              <a href="../.././/~/oeDescr.html">
                 <div class="symbol_kind kind_Variable_text kind_Variable_bg" title="Variable">
   v
 </div>
 
-                <span>ieDescr</span>
+                <span>oeDescr</span>
               </a>
             </li>
 
@@ -222,7 +222,7 @@ <h3>Variable</h3>
       <div>
         <span class="doc_block_subtitle_text"> implements </span>
 
-          <span>[ddbi.ExcelSheetIngestSource]</span>&lt;<a href="#type_param_SheetName" class="link">SheetName</a><span>, </span><span>string</span>&gt;
+          <span>[ddbo.ExcelSheetIngestSource]</span>&lt;<a href="#type_param_SheetName" class="link">SheetName</a><span>, </span><span>string</span>&gt;
 
 
       </div>
@@ -348,7 +348,7 @@ <h3>Variable</h3>
   <div class="doc_entry">
     <span class="doc_entry_children">
     <code>
-      <span style="font-weight: 700;">workflow</span><span style="font-weight: 500;">(): <span>ReturnType</span>&lt;<span>ddbi.ExcelSheetIngestSource</span>&lt;<span>string</span><span>, </span><span>string</span>&gt;[<span>"workflow"</span>]&gt;</span>
+      <span style="font-weight: 700;">workflow</span><span style="font-weight: 500;">(): <span>ReturnType</span>&lt;<span>ddbo.ExcelSheetIngestSource</span>&lt;<span>string</span><span>, </span><span>string</span>&gt;[<span>"workflow"</span>]&gt;</span>
     </code>
     </span>
   </div>

diff --git a/support/docs/lib/ahc-hrsn-elt/screening/~/ExcelWorkbookSheetName.html b/support/docs/lib/ahc-hrsn-elt/screening/~/ExcelWorkbookSheetName.html
@@ -30,12 +30,12 @@ <h3>Class</h3>
             </li>
 
             <li>
-              <a href="../.././/~/IngestEngine.html">
+              <a href="../.././/~/OrchEngine.html">
                 <div class="symbol_kind kind_Class_text kind_Class_bg" title="Class">
   c
 </div>
 
-                <span>IngestEngine</span>
+                <span>OrchEngine</span>
               </a>
             </li>
 
@@ -120,12 +120,12 @@ <h3>Interface</h3>
         <ul>
 
             <li>
-              <a href="../.././/~/IngestEngineArgs.html">
+              <a href="../.././/~/OrchEngineArgs.html">
                 <div class="symbol_kind kind_Interface_text kind_Interface_bg" title="Interface">
   I
 </div>
 
-                <span>IngestEngineArgs</span>
+                <span>OrchEngineArgs</span>
               </a>
             </li>
 
@@ -145,22 +145,22 @@ <h3>Type Alias</h3>
             </li>
 
             <li>
-              <a href="../.././/~/IngestStep.html">
+              <a href="../.././/~/OrchStep.html">
                 <div class="symbol_kind kind_TypeAlias_text kind_TypeAlias_bg" title="Type Alias">
   T
 </div>
 
-                <span>IngestStep</span>
+                <span>OrchStep</span>
               </a>
             </li>
 
             <li>
-              <a href="../.././/~/IngestStepContext.html">
+              <a href="../.././/~/OrchStepContext.html">
                 <div class="symbol_kind kind_TypeAlias_text kind_TypeAlias_bg" title="Type Alias">
   T
 </div>
 
-                <span>IngestStepContext</span>
+                <span>OrchStepContext</span>
               </a>
             </li>
 
@@ -190,12 +190,12 @@ <h3>Variable</h3>
             </li>
 
             <li>
-              <a href="../.././/~/ieDescr.html">
+              <a href="../.././/~/oeDescr.html">
                 <div class="symbol_kind kind_Variable_text kind_Variable_bg" title="Variable">
   v
 </div>
 
-                <span>ieDescr</span>
+                <span>oeDescr</span>
               </a>
             </li>