Skip to content

Commit

Permalink
Update website for 5.88.0 release
Browse files Browse the repository at this point in the history
This uses Ruby 3.4 to generate the rdoc documentation.
  • Loading branch information
jeremyevans committed Jan 1, 2025
1 parent 67be5eb commit 6488dbf
Show file tree
Hide file tree
Showing 94 changed files with 1,947 additions and 1,169 deletions.
4 changes: 3 additions & 1 deletion documentation.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
<main class="main">
<div class="main__container">
<section class="documentation">
<h1 class="h1">Documentation for Sequel (v5.87.0)</h1>
<h1 class="h1">Documentation for Sequel (v5.88.0)</h1>

<hr class="hr" />

Expand Down Expand Up @@ -166,6 +166,8 @@ <h3 class="h3"><a class="a" href="rdoc/files/CHANGELOG.html">Release Notes</a></

<li>

<a class="a" href="rdoc/files/doc/release_notes/5_88_0_txt.html">5.88</a> |

<a class="a" href="rdoc/files/doc/release_notes/5_87_0_txt.html">5.87</a> |

<a class="a" href="rdoc/files/doc/release_notes/5_86_0_txt.html">5.86</a> |
Expand Down
12 changes: 10 additions & 2 deletions plugins.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<div class="main__container">
<section class="plugins">

<h1 class="h1">Sequel::Model Plugins for v5.87.0</h1>
<h1 class="h1">Sequel::Model Plugins for v5.88.0</h1>

<div class="plugins__sidebar">
<aside class="plugins__sidebar-aside">
Expand Down Expand Up @@ -258,7 +258,11 @@ <h4 class="h4">Caching</h4>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/StaticCacheCache.html">static_cache_cache </a>
<span class="ul__span">Support caching rows for static_cache models to a file to avoid database queries during model initialization.</span>
<span class="ul__span">Support caching rows for models using static_cache and subset_static_cache plugins to a file to avoid database queries during model initialization.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="rdoc-plugins/classes/Sequel/Plugins/SubsetStaticCache.html">subset_static_cache </a>
<span class="ul__span">Caches all model instances for subsets of a model class.</span>
</li>
</ul>
<h4 class="h4">Hooks</h4>
Expand Down Expand Up @@ -1170,6 +1174,10 @@ <h3 class="h3">External Extensions</h3>
<a class="a" href="http://github.com/jsvd/sequel_vectorized">sequel_vectorized </a>
<span class="ul__span">Allows Sequel::Dataset to be exported as an Hash of Arrays and NArrays.</span>
</li>
<li class="ul__li ul__li--grid">
<a class="a" href="https://github.com/eriklovmo/sequel_more_than">sequel_more_than </a>
<span class="ul__span">Efficiently compare a Sequel::Dataset's row count against a given number.</span>
</li>
</ul>

<a name="extensions-external-adapters"></a>
Expand Down
4 changes: 2 additions & 2 deletions rdoc-adapters/classes/Sequel/Postgres/Database.html
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ <h2>Public Instance methods</h2>
</div>
<div class='description'>

<p><code>copy_into</code> uses PostgreSQL’s +COPY FROM STDIN+ SQL statement to do very fast inserts into a table using input preformatting in either CSV or PostgreSQL text format. This method is only supported if pg 0.14.0+ is the underlying ruby driver. This method should only be called if you want results returned to the client. If you are using +COPY FROM+ with a filename, you should just use <code>run</code> instead of this method.</p>
<p><a href="Database.html#method-i-copy_into"><code>copy_into</code></a> uses PostgreSQL’s +COPY FROM STDIN+ SQL statement to do very fast inserts into a table using input preformatting in either CSV or PostgreSQL text format. This method is only supported if pg 0.14.0+ is the underlying ruby driver. This method should only be called if you want results returned to the client. If you are using +COPY FROM+ with a filename, you should just use <code>run</code> instead of this method.</p>

<p>The following options are respected:</p>
<table class="rdoc-list note-list"><tbody><tr><td class='label'>:columns </td><td>
Expand Down Expand Up @@ -338,7 +338,7 @@ <h2>Public Instance methods</h2>
</div>
<div class='description'>

<p>:nocov: <code>copy_table</code> uses PostgreSQL’s +COPY TO STDOUT+ SQL statement to return formatted results directly to the caller. This method is only supported if pg is the underlying ruby driver. This method should only be called if you want results returned to the client. If you are using +COPY TO+ with a filename, you should just use <code>run</code> instead of this method.</p>
<p>:nocov: <a href="Database.html#method-i-copy_table"><code>copy_table</code></a> uses PostgreSQL’s +COPY TO STDOUT+ SQL statement to return formatted results directly to the caller. This method is only supported if pg is the underlying ruby driver. This method should only be called if you want results returned to the client. If you are using +COPY TO+ with a filename, you should just use <code>run</code> instead of this method.</p>

<p>The table argument supports the following types:</p>
<table class="rdoc-list note-list"><tbody><tr><td class='label'>String </td><td>
Expand Down
4 changes: 2 additions & 2 deletions rdoc-adapters/created.rid
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Sun, 01 Dec 2024 09:22:43 -0800
Wed, 01 Jan 2025 09:27:57 -0800
lib/sequel/adapters/ado.rb Tue, 21 Sep 2021 14:24:30 -0700
lib/sequel/adapters/ado/access.rb Tue, 21 Sep 2021 14:24:30 -0700
lib/sequel/adapters/ado/mssql.rb Mon, 28 Jan 2019 08:29:19 -0800
Expand Down Expand Up @@ -33,7 +33,7 @@ lib/sequel/adapters/shared/db2.rb Thu, 11 Jul 2024 11:09:22 -0700
lib/sequel/adapters/shared/mssql.rb Thu, 11 Jul 2024 11:09:22 -0700
lib/sequel/adapters/shared/mysql.rb Mon, 11 Nov 2024 14:55:11 -0800
lib/sequel/adapters/shared/oracle.rb Wed, 06 Dec 2023 16:41:40 -0800
lib/sequel/adapters/shared/postgres.rb Mon, 11 Nov 2024 14:55:11 -0800
lib/sequel/adapters/shared/postgres.rb Wed, 18 Dec 2024 11:43:49 -0800
lib/sequel/adapters/shared/sqlanywhere.rb Wed, 06 Dec 2023 16:41:40 -0800
lib/sequel/adapters/shared/sqlite.rb Thu, 22 Aug 2024 11:50:35 -0700
lib/sequel/adapters/sqlanywhere.rb Tue, 21 Sep 2021 14:24:30 -0700
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h1 class='name'>postgres.rb
</div>
<div class='last-update'>
Last Update:
<span class='datetime'>2024-11-11 14:55:11 -0800</span>
<span class='datetime'>2024-12-18 11:43:49 -0800</span>
</div>
</div>
<div id='content'>
Expand Down
56 changes: 28 additions & 28 deletions rdoc-plugins/classes/Array.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,13 @@ <h1 class='name'><span class='type'>class</span>
<div id='content'>
<div id='text'>
<div id='description'>
<p><a href="Sequel.html"><code>Sequel</code></a> extends <code>Array</code> to add methods to implement the SQL DSL. Most of these methods require that the array not be empty and that it must consist solely of other arrays that have exactly two elements.</p>
<p><a href="Sequel.html"><code>Sequel</code></a> extends <a href="Array.html"><code>Array</code></a> to add methods to implement the SQL DSL. Most of these methods require that the array not be empty and that it must consist solely of other arrays that have exactly two elements.</p>
</div>
<div id='method-list'>
<h2>Methods</h2>
<h3>Public Instance</h3>
<ol>
<li><a href="#method-i-~">~</a></li>
<li><a href="#method-i-case">case</a></li>
<li><a href="#method-i-pg_array">pg_array</a></li>
<li><a href="#method-i-pg_json">pg_json</a></li>
Expand All @@ -68,14 +69,38 @@ <h3>Public Instance</h3>
<li><a href="#method-i-sql_or">sql_or</a></li>
<li><a href="#method-i-sql_string_join">sql_string_join</a></li>
<li><a href="#method-i-sql_value_list">sql_value_list</a></li>
<li><a href="#method-i-~">~</a></li>
</ol>
</div>
<div id='context'>
</div>
<div id='section'>
<div id='methods'>
<h2>Public Instance methods</h2>
<div class='method public-instance' id='method-method-i-~'>
<a name='method-i-~'></a>
<div class='synopsis'>
<span class='name'>~</span><span class='arguments'>()</span>

</div>
<div class='description'>

<p>Return a <code>Sequel::SQL::BooleanExpression</code> created from this array, not matching all of the conditions.</p>

<pre class="ruby"><span class="ruby-operator">~</span>[[<span class="ruby-value">:a</span>, <span class="ruby-keyword">true</span>]] <span class="ruby-comment"># SQL: (a IS NOT TRUE)</span>
<span class="ruby-operator">~</span>[[<span class="ruby-value">:a</span>, <span class="ruby-value">1</span>], [<span class="ruby-value">:b</span>, [<span class="ruby-value">2</span>, <span class="ruby-value">3</span>]]] <span class="ruby-comment"># SQL: ((a != 1) OR (b NOT IN (2, 3)))</span>
</pre>

</div>
<div class='source'>
<a class='source-toggle' href='#' onclick='toggleCode(&#39;method-i-~-source&#39;); return false'>
[show source]
</a>
<pre id='method-i-~-source'> <span class="ruby-comment"># File lib/sequel/extensions/core_extensions.rb</span>
<span class="line-num">26</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">~</span>
<span class="line-num">27</span> <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">~</span>(<span class="ruby-keyword">self</span>)
<span class="line-num">28</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-method-i-case'>
<a name='method-i-case'></a>
<div class='synopsis'>
Expand All @@ -84,7 +109,7 @@ <h2>Public Instance methods</h2>
</div>
<div class='description'>

<p>Return a <code>Sequel::SQL::CaseExpression</code> with this array as the conditions and the given default value and expression.</p>
<p>Return a <a href="Sequel/SQL/CaseExpression.html"><code>Sequel::SQL::CaseExpression</code></a> with this array as the conditions and the given default value and expression.</p>

<pre class="ruby">[[{<span class="ruby-value">a:</span> [<span class="ruby-value">2</span>,<span class="ruby-value">3</span>]}, <span class="ruby-value">1</span>]].<span class="ruby-identifier">case</span>(<span class="ruby-value">0</span>) <span class="ruby-comment"># SQL: CASE WHEN (a IN (2, 3)) THEN 1 ELSE 0 END</span>
[[<span class="ruby-value">:a</span>, <span class="ruby-value">1</span>], [<span class="ruby-value">:b</span>, <span class="ruby-value">2</span>]].<span class="ruby-identifier">case</span>(<span class="ruby-value">:d</span>, <span class="ruby-value">:c</span>) <span class="ruby-comment"># SQL: CASE c WHEN a THEN 1 WHEN b THEN 2 ELSE d END</span>
Expand Down Expand Up @@ -313,31 +338,6 @@ <h2>Public Instance methods</h2>
<span class="line-num">50</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-method-i-~'>
<a name='method-i-~'></a>
<div class='synopsis'>
<span class='name'>~</span><span class='arguments'>()</span>

</div>
<div class='description'>

<p>Return a <code>Sequel::SQL::BooleanExpression</code> created from this array, not matching all of the conditions.</p>

<pre class="ruby"><span class="ruby-operator">~</span>[[<span class="ruby-value">:a</span>, <span class="ruby-keyword">true</span>]] <span class="ruby-comment"># SQL: (a IS NOT TRUE)</span>
<span class="ruby-operator">~</span>[[<span class="ruby-value">:a</span>, <span class="ruby-value">1</span>], [<span class="ruby-value">:b</span>, [<span class="ruby-value">2</span>, <span class="ruby-value">3</span>]]] <span class="ruby-comment"># SQL: ((a != 1) OR (b NOT IN (2, 3)))</span>
</pre>

</div>
<div class='source'>
<a class='source-toggle' href='#' onclick='toggleCode(&#39;method-i-~-source&#39;); return false'>
[show source]
</a>
<pre id='method-i-~-source'> <span class="ruby-comment"># File lib/sequel/extensions/core_extensions.rb</span>
<span class="line-num">26</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">~</span>
<span class="line-num">27</span> <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">~</span>(<span class="ruby-keyword">self</span>)
<span class="line-num">28</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</div>

Expand Down
Loading

0 comments on commit 6488dbf

Please sign in to comment.