Skip to content

Commit

Permalink
doc update for tag main
Browse files Browse the repository at this point in the history
  • Loading branch information
deltars committed Jan 30, 2024
1 parent e79e7de commit 69d87c7
Show file tree
Hide file tree
Showing 39 changed files with 4,540 additions and 62 deletions.
22 changes: 22 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,8 @@








Expand Down Expand Up @@ -437,6 +439,26 @@








<li class="md-nav__item">
<a href="/delta-io/delta-rs/delta-lake-big-data-small-data/" class="md-nav__link">


<span class="md-ellipsis">
Delta Lake for big and small data
</span>


</a>
</li>




</ul>
</nav>

Expand Down
22 changes: 22 additions & 0 deletions api/catalog/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,8 @@








Expand Down Expand Up @@ -450,6 +452,26 @@








<li class="md-nav__item">
<a href="../../delta-lake-big-data-small-data/" class="md-nav__link">


<span class="md-ellipsis">
Delta Lake for big and small data
</span>


</a>
</li>




</ul>
</nav>

Expand Down
22 changes: 22 additions & 0 deletions api/delta_table/delta_table_alterer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,8 @@








Expand Down Expand Up @@ -450,6 +452,26 @@








<li class="md-nav__item">
<a href="../../../delta-lake-big-data-small-data/" class="md-nav__link">


<span class="md-ellipsis">
Delta Lake for big and small data
</span>


</a>
</li>




</ul>
</nav>

Expand Down
22 changes: 22 additions & 0 deletions api/delta_table/delta_table_merger/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,8 @@








Expand Down Expand Up @@ -450,6 +452,26 @@








<li class="md-nav__item">
<a href="../../../delta-lake-big-data-small-data/" class="md-nav__link">


<span class="md-ellipsis">
Delta Lake for big and small data
</span>


</a>
</li>




</ul>
</nav>

Expand Down
39 changes: 37 additions & 2 deletions api/delta_table/delta_table_optimizer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,8 @@








Expand Down Expand Up @@ -450,6 +452,26 @@








<li class="md-nav__item">
<a href="../../../delta-lake-big-data-small-data/" class="md-nav__link">


<span class="md-ellipsis">
Delta Lake for big and small data
</span>


</a>
</li>




</ul>
</nav>

Expand Down Expand Up @@ -1853,14 +1875,27 @@ <h4 id="deltalake.table.TableOptimizer.z_order" class="doc doc-heading">
</td>
<td>
<div class="doc-md-description">
<p>the columns to use for Z-ordering. There must be at least one column.
partition_filters: the partition filters that will be used for getting the matched files</p>
<p>the columns to use for Z-ordering. There must be at least one column.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr>
<td><code>partition_filters</code></td>
<td>
<code><span title="typing.Optional">Optional</span>[<span title="deltalake.table.FilterType">FilterType</span>]</code>
</td>
<td>
<div class="doc-md-description">
<p>the partition filters that will be used for getting the matched files</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
<tr>
<td><code>target_size</code></td>
<td>
Expand Down
26 changes: 24 additions & 2 deletions api/delta_table/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,8 @@








Expand Down Expand Up @@ -450,6 +452,26 @@








<li class="md-nav__item">
<a href="../../delta-lake-big-data-small-data/" class="md-nav__link">


<span class="md-ellipsis">
Delta Lake for big and small data
</span>


</a>
</li>




</ul>
</nav>

Expand Down Expand Up @@ -2968,7 +2990,7 @@ <h4 id="deltalake.DeltaTable.merge" class="doc doc-heading">


</h4>
<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">merge</span><span class="p">(</span><span class="n">source</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">pyarrow</span><span class="o">.</span><span class="n">Table</span><span class="p">,</span> <span class="n">pyarrow</span><span class="o">.</span><span class="n">RecordBatch</span><span class="p">,</span> <span class="n">pyarrow</span><span class="o">.</span><span class="n">RecordBatchReader</span><span class="p">,</span> <span class="n">ds</span><span class="o">.</span><span class="n">Dataset</span><span class="p">,</span> <span class="n">pandas</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">],</span> <span class="n">predicate</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">source_alias</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">target_alias</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">error_on_type_mismatch</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">writer_properties</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">WriterProperties</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">large_dtypes</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">custom_metadata</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TableMerger</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">merge</span><span class="p">(</span><span class="n">source</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">pyarrow</span><span class="o">.</span><span class="n">Table</span><span class="p">,</span> <span class="n">pyarrow</span><span class="o">.</span><span class="n">RecordBatch</span><span class="p">,</span> <span class="n">pyarrow</span><span class="o">.</span><span class="n">RecordBatchReader</span><span class="p">,</span> <span class="n">ds</span><span class="o">.</span><span class="n">Dataset</span><span class="p">,</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">],</span> <span class="n">predicate</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">source_alias</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">target_alias</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">error_on_type_mismatch</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">writer_properties</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">WriterProperties</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">large_dtypes</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">custom_metadata</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TableMerger</span>
</span></code></pre></div>

<div class="doc doc-contents ">
Expand Down Expand Up @@ -3476,7 +3498,7 @@ <h4 id="deltalake.DeltaTable.to_pandas" class="doc doc-heading">


</h4>
<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">to_pandas</span><span class="p">(</span><span class="n">partitions</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">columns</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">filesystem</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">pa_fs</span><span class="o">.</span><span class="n">FileSystem</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">filters</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">FilterType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pandas</span><span class="o">.</span><span class="n">DataFrame</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">to_pandas</span><span class="p">(</span><span class="n">partitions</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">columns</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">filesystem</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">pa_fs</span><span class="o">.</span><span class="n">FileSystem</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">filters</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">FilterType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span>
</span></code></pre></div>

<div class="doc doc-contents ">
Expand Down
22 changes: 22 additions & 0 deletions api/delta_table/metadata/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,8 @@








Expand Down Expand Up @@ -450,6 +452,26 @@








<li class="md-nav__item">
<a href="../../../delta-lake-big-data-small-data/" class="md-nav__link">


<span class="md-ellipsis">
Delta Lake for big and small data
</span>


</a>
</li>




</ul>
</nav>

Expand Down
Loading

0 comments on commit 69d87c7

Please sign in to comment.