dwh 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3971b0c0d4f6964a2f6d1ce8d04038f3f79e09036cd8ab19a2c5dd866d5411ca
-  data.tar.gz: 567185f3ec75fa9b606538031076f8215e376257a421159f6139dfc951e43e30
+  metadata.gz: 1d0cb4848d96ff20f5b4c80e00cbfde5f1150e0e975cf55827f8466b9d4eaf49
+  data.tar.gz: ce79d54a93388718886c8ec7892e9da544c4ddc52333e1a765a742518552df69
 SHA512:
-  metadata.gz: 75c38e6b03b9d6759cc43d363924b6cbffa91bfd2af30e327d864371c5c77143071d909f8b805d44fb59de679ad23ed1be0294a99906ef435b5effb18a381e33
-  data.tar.gz: e8e5ac7103954e9c644a0fbfc819b66ef673bbd4a85dd9a8a96a6b4cacb86dd50b73e37aeb1cba4bd049a190d42a3f78f7024235b8b0c4fd4c44a0f931f581fb
+  metadata.gz: e61d14edd0b8e5818eb2eb3fe5ec25adf69a49279c9fd8b8db0ddb271f746de30573d97d90a6fe3bb9acf350f2ad80a72f076a19bd72a1270d9418aee6eca320
+  data.tar.gz: a53cc7c72c222b579777e7796bbdefeada81ac77a8bf12d5ab46be73e2d76b7721deba91deb2019597013a1f1a46173a7406d6d95d1f8d11eb53f62e7ba19b26

data/README.md

@@ -84,10 +84,11 @@ Standardized API across adapters:
 
 ## Tutorials and Guides
 
-- [Getting Started](/docs/guides/getting-started.md)
-- [Adapter Configuration](/docs/guides/adapters.md)
-- [Creating an Adapter](/docs/guides/creating-adapters.md)
-- [API](https://rubydoc.info/github/stratasite/dwh.git)
+- [Getting Started](https://strata.site/dwh/file.getting-started.html)
+- [Adapter Configuration](https://strata.site/dwh/file.adapters.html)
+- [Creating an Adapter](https://strata.site/dwh/file.creating-adapters.html)
+- [Advanced Usage](https://strata.site/dwh/file.usage.html)
+- [API](https://strata.site/dwh/DWH.html)
 
 ## Testing
 

data/Rakefile

@@ -11,7 +11,7 @@ YARD::Rake::YardocTask.new(:doc) do |t|
   t.options = [
     '--output-dir', 'docs',
     '--markup', 'markdown',
-    '--markup-provider', 'kramdown',
+    '--markup-provider', 'redcarpet',
     '--charset', 'utf-8',
     '--verbose', '--debug',
     '--files', 'docs/guides/*.md'

data/docs/DWH/Adapters/Adapter.html

@@ -117,12 +117,12 @@
 and implement these core required methods:</p>
 
 <ul>
-  <li><span class='object_link'><a href="#stats-instance_method" title="DWH::Adapters::Adapter#stats (method)">#stats</a></span> - get table statistics</li>
-  <li><span class='object_link'><a href="#tables-instance_method" title="DWH::Adapters::Adapter#tables (method)">#tables</a></span> - list tables</li>
-  <li><span class='object_link'><a href="#metadata-instance_method" title="DWH::Adapters::Adapter#metadata (method)">#metadata</a></span> - get metadata for a specific table</li>
-  <li><span class='object_link'><a href="#execute-instance_method" title="DWH::Adapters::Adapter#execute (method)">#execute</a></span> - run query and return result</li>
-  <li><span class='object_link'><a href="#execute_stream-instance_method" title="DWH::Adapters::Adapter#execute_stream (method)">#execute_stream</a></span> - run query and stream results to provided IO</li>
-  <li><span class='object_link'><a href="#stream-instance_method" title="DWH::Adapters::Adapter#stream (method)">#stream</a></span> - run query and yeild streaming results</li>
+<li><span class='object_link'><a href="#stats-instance_method" title="DWH::Adapters::Adapter#stats (method)">#stats</a></span> - get table statistics</li>
+<li><span class='object_link'><a href="#tables-instance_method" title="DWH::Adapters::Adapter#tables (method)">#tables</a></span> - list tables</li>
+<li><span class='object_link'><a href="#metadata-instance_method" title="DWH::Adapters::Adapter#metadata (method)">#metadata</a></span> - get metadata for a specific table</li>
+<li><span class='object_link'><a href="#execute-instance_method" title="DWH::Adapters::Adapter#execute (method)">#execute</a></span> - run query and return result</li>
+<li><span class='object_link'><a href="#execute_stream-instance_method" title="DWH::Adapters::Adapter#execute_stream (method)">#execute_stream</a></span> - run query and stream results to provided IO</li>
+<li><span class='object_link'><a href="#stream-instance_method" title="DWH::Adapters::Adapter#stream (method)">#stream</a></span> - run query and yeild streaming results</li>
 </ul>
 </div>
 </div>
@@ -136,7 +136,7 @@ file in a relative directory like so: <em>settings/my_adapter.yml</em>. Or, you
 an exact settings file location at the class level:</p>
 
 <p>class MyAdapter &lt; DWH::Adapters::Adapter
-    settings_file_path “my_dir/my_settings.yml”
+    settings_file_path &quot;my_dir/my_settings.yml&quot;
   end</p>
 
 
@@ -1700,13 +1700,19 @@ connection object or self</p>
       
       
         &mdash;
-        <div class='inline'><p>return format type
-- array returns array of array
-- object returns array of Hashes
-- csv returns as csv
-- native returns the native result from any clients used
-  - For example: Postgres using pg client will return PG::Result
-  - Http clients will returns the HTTP response object</p>
+        <div class='inline'><p>return format type</p>
+
+<ul>
+<li>array returns array of array</li>
+<li>object returns array of Hashes</li>
+<li>csv returns as csv</li>
+<li>native returns the native result from any clients used
+
+<ul>
+<li>For example: Postgres using pg client will return PG::Result</li>
+<li>Http clients will returns the HTTP response object</li>
+</ul></li>
+</ul>
 </div>
       
     </li>
@@ -2044,9 +2050,9 @@ from the config to the executor.</p>
 Pass in optional catalog and schema info.</p>
 
 <p>Example:
-  metadata(“public.big_table”)
-  metadata(“big_table”)
-  metadata(“big_table”,schema: “public”)</p>
+  metadata(&quot;public.big_table&quot;)
+  metadata(&quot;big_table&quot;)
+  metadata(&quot;big_table&quot;,schema: &quot;public&quot;)</p>
 
 
   </div>
@@ -2066,7 +2072,7 @@ Pass in optional catalog and schema info.</p>
       
         &mdash;
         <div class='inline'><ul>
-  <li>table name</li>
+<li>table name</li>
 </ul>
 </div>
       
@@ -2105,7 +2111,7 @@ Pass in optional catalog and schema info.</p>
           </span>
           
             &mdash; <div class='inline'><p>optional catalog or equivalent name space.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -2118,7 +2124,7 @@ will be ignored if the adapter doesn’t support</p>
           </span>
           
             &mdash; <div class='inline'><p>optional schema to scope to.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -2330,7 +2336,7 @@ date_start, and date_end.</p>
           </span>
           
             &mdash; <div class='inline'><p>optional catalog or equivalent name space.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -2343,7 +2349,7 @@ will be ignored if the adapter doesn’t support</p>
           </span>
           
             &mdash; <div class='inline'><p>optional schema to scope to.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -2543,7 +2549,7 @@ might vary depending on the target db and settings</p>
           </span>
           
             &mdash; <div class='inline'><p>optional catalog or equivalent name space.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -2556,7 +2562,7 @@ will be ignored if the adapter doesn’t support</p>
           </span>
           
             &mdash; <div class='inline'><p>optional schema to scope to.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -2652,7 +2658,7 @@ config only specified here.</p>
           </span>
           
             &mdash; <div class='inline'><p>optional catalog or equivalent name space.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -2665,7 +2671,7 @@ will be ignored if the adapter doesn’t support</p>
           </span>
           
             &mdash; <div class='inline'><p>optional schema to scope to.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -3043,7 +3049,7 @@ will just return the block.call</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Aug 22 08:31:22 2025 by
+  Generated on Mon Aug 25 10:59:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

data/docs/DWH/Adapters/Athena.html

@@ -389,8 +389,7 @@ is passed in as options hash or argument list.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'>
-</div></span>
+    <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
 
@@ -654,13 +653,19 @@ connection object or self</p>
       
       
         &mdash;
-        <div class='inline'><p>return format type
-- array returns array of array
-- object returns array of Hashes
-- csv returns as csv
-- native returns the native result from any clients used
-  - For example: Postgres using pg client will return PG::Result
-  - Http clients will returns the HTTP response object</p>
+        <div class='inline'><p>return format type</p>
+
+<ul>
+<li>array returns array of array</li>
+<li>object returns array of Hashes</li>
+<li>csv returns as csv</li>
+<li>native returns the native result from any clients used
+
+<ul>
+<li>For example: Postgres using pg client will return PG::Result</li>
+<li>Http clients will returns the HTTP response object</li>
+</ul></li>
+</ul>
 </div>
       
     </li>
@@ -936,9 +941,9 @@ to the provided IO object.</p>
 Pass in optional catalog and schema info.</p>
 
 <p>Example:
-  metadata(“public.big_table”)
-  metadata(“big_table”)
-  metadata(“big_table”,schema: “public”)</p>
+  metadata(&quot;public.big_table&quot;)
+  metadata(&quot;big_table&quot;)
+  metadata(&quot;big_table&quot;,schema: &quot;public&quot;)</p>
 
 
   </div>
@@ -958,7 +963,7 @@ Pass in optional catalog and schema info.</p>
       
         &mdash;
         <div class='inline'><ul>
-  <li>table name</li>
+<li>table name</li>
 </ul>
 </div>
       
@@ -997,7 +1002,7 @@ Pass in optional catalog and schema info.</p>
           </span>
           
             &mdash; <div class='inline'><p>optional catalog or equivalent name space.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -1010,7 +1015,7 @@ will be ignored if the adapter doesn’t support</p>
           </span>
           
             &mdash; <div class='inline'><p>optional schema to scope to.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -1209,7 +1214,7 @@ date_start, and date_end.</p>
           </span>
           
             &mdash; <div class='inline'><p>optional catalog or equivalent name space.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -1222,7 +1227,7 @@ will be ignored if the adapter doesn’t support</p>
           </span>
           
             &mdash; <div class='inline'><p>optional schema to scope to.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -1472,7 +1477,7 @@ config only specified here.</p>
           </span>
           
             &mdash; <div class='inline'><p>optional catalog or equivalent name space.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -1485,7 +1490,7 @@ will be ignored if the adapter doesn’t support</p>
           </span>
           
             &mdash; <div class='inline'><p>optional schema to scope to.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -1643,7 +1648,6 @@ connection object or self</p>
   <div class="discussion">
     
 
-
   </div>
 </div>
 <div class="tags">
@@ -1694,7 +1698,7 @@ connection object or self</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Aug 22 08:31:22 2025 by
+  Generated on Mon Aug 25 10:59:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

data/docs/DWH/Adapters/Boolean.html

@@ -111,7 +111,7 @@
 </div>
 
       <div id="footer">
-  Generated on Fri Aug 22 08:31:22 2025 by
+  Generated on Mon Aug 25 10:59:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

data/docs/DWH/Adapters/Druid.html

@@ -760,13 +760,19 @@ as valid ISO timestamps</p>
       
       
         &mdash;
-        <div class='inline'><p>return format type
-- array returns array of array
-- object returns array of Hashes
-- csv returns as csv
-- native returns the native result from any clients used
-  - For example: Postgres using pg client will return PG::Result
-  - Http clients will returns the HTTP response object</p>
+        <div class='inline'><p>return format type</p>
+
+<ul>
+<li>array returns array of array</li>
+<li>object returns array of Hashes</li>
+<li>csv returns as csv</li>
+<li>native returns the native result from any clients used
+
+<ul>
+<li>For example: Postgres using pg client will return PG::Result</li>
+<li>Http clients will returns the HTTP response object</li>
+</ul></li>
+</ul>
 </div>
       
     </li>
@@ -1082,9 +1088,9 @@ to the provided IO object.</p>
 Pass in optional catalog and schema info.</p>
 
 <p>Example:
-  metadata(“public.big_table”)
-  metadata(“big_table”)
-  metadata(“big_table”,schema: “public”)</p>
+  metadata(&quot;public.big_table&quot;)
+  metadata(&quot;big_table&quot;)
+  metadata(&quot;big_table&quot;,schema: &quot;public&quot;)</p>
 
 
   </div>
@@ -1104,7 +1110,7 @@ Pass in optional catalog and schema info.</p>
       
         &mdash;
         <div class='inline'><ul>
-  <li>table name</li>
+<li>table name</li>
 </ul>
 </div>
       
@@ -1616,7 +1622,7 @@ connection object or self</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Aug 22 08:31:22 2025 by
+  Generated on Mon Aug 25 10:59:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

data/docs/DWH/Adapters/DuckDb.html

@@ -189,7 +189,7 @@ is passed in as options hash or argument list.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'><p>DuckDB is an in process database so we don’t want to open multiple instances of the same db in memory.</p>
+    <span class="summary_desc"><div class='inline'><p>DuckDB is an in process database so we don&#39;t want to open multiple instances of the same db in memory.</p>
 </div></span>
   
 </li>
@@ -212,8 +212,7 @@ is passed in as options hash or argument list.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'>
-</div></span>
+    <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
 
@@ -235,8 +234,7 @@ is passed in as options hash or argument list.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'>
-</div></span>
+    <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
 
@@ -497,8 +495,7 @@ is passed in as options hash or argument list.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'>
-</div></span>
+    <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
 
@@ -639,7 +636,7 @@ is passed in as options hash or argument list.</p>
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>DuckDB is an in process database so we don’t want to
+    <p>DuckDB is an in process database so we don&#39;t want to
 open multiple instances of the same db in memory. Rather,
 we open one instance but many connections. Use this
 method to close them all.</p>
@@ -915,13 +912,19 @@ connection object or self</p>
       
       
         &mdash;
-        <div class='inline'><p>return format type
-- array returns array of array
-- object returns array of Hashes
-- csv returns as csv
-- native returns the native result from any clients used
-  - For example: Postgres using pg client will return PG::Result
-  - Http clients will returns the HTTP response object</p>
+        <div class='inline'><p>return format type</p>
+
+<ul>
+<li>array returns array of array</li>
+<li>object returns array of Hashes</li>
+<li>csv returns as csv</li>
+<li>native returns the native result from any clients used
+
+<ul>
+<li>For example: Postgres using pg client will return PG::Result</li>
+<li>Http clients will returns the HTTP response object</li>
+</ul></li>
+</ul>
 </div>
       
     </li>
@@ -1207,9 +1210,9 @@ to the provided IO object.</p>
 Pass in optional catalog and schema info.</p>
 
 <p>Example:
-  metadata(“public.big_table”)
-  metadata(“big_table”)
-  metadata(“big_table”,schema: “public”)</p>
+  metadata(&quot;public.big_table&quot;)
+  metadata(&quot;big_table&quot;)
+  metadata(&quot;big_table&quot;,schema: &quot;public&quot;)</p>
 
 
   </div>
@@ -1229,7 +1232,7 @@ Pass in optional catalog and schema info.</p>
       
         &mdash;
         <div class='inline'><ul>
-  <li>table name</li>
+<li>table name</li>
 </ul>
 </div>
       
@@ -1268,7 +1271,7 @@ Pass in optional catalog and schema info.</p>
           </span>
           
             &mdash; <div class='inline'><p>optional catalog or equivalent name space.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -1281,7 +1284,7 @@ will be ignored if the adapter doesn’t support</p>
           </span>
           
             &mdash; <div class='inline'><p>optional schema to scope to.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -1521,7 +1524,7 @@ date_start, and date_end.</p>
           </span>
           
             &mdash; <div class='inline'><p>optional catalog or equivalent name space.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -1534,7 +1537,7 @@ will be ignored if the adapter doesn’t support</p>
           </span>
           
             &mdash; <div class='inline'><p>optional schema to scope to.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -1774,7 +1777,7 @@ config only specified here.</p>
           </span>
           
             &mdash; <div class='inline'><p>optional catalog or equivalent name space.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -1787,7 +1790,7 @@ will be ignored if the adapter doesn’t support</p>
           </span>
           
             &mdash; <div class='inline'><p>optional schema to scope to.
-will be ignored if the adapter doesn’t support</p>
+will be ignored if the adapter doesn&#39;t support</p>
 </div>
           
         </li>
@@ -1951,7 +1954,6 @@ connection object or self</p>
   <div class="discussion">
     
 
-
   </div>
 </div>
 <div class="tags">
@@ -2002,7 +2004,7 @@ connection object or self</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Aug 22 08:31:22 2025 by
+  Generated on Mon Aug 25 10:59:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>