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 Mar 11, 2024
1 parent a40a015 commit 8c96ab1
Show file tree
Hide file tree
Showing 41 changed files with 3,059 additions and 46 deletions.
22 changes: 22 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -1265,6 +1265,8 @@








Expand Down Expand Up @@ -1328,6 +1330,26 @@



<li class="md-nav__item">
<a href="/delta-io/delta-rs/integrations/delta-lake-dagster/" class="md-nav__link">


<span class="md-ellipsis">
Dagster
</span>


</a>
</li>









<li class="md-nav__item">
<a href="/delta-io/delta-rs/integrations/delta-lake-dask/" class="md-nav__link">

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








Expand Down Expand Up @@ -1404,6 +1406,26 @@



<li class="md-nav__item">
<a href="../../integrations/delta-lake-dagster/" class="md-nav__link">


<span class="md-ellipsis">
Dagster
</span>


</a>
</li>









<li class="md-nav__item">
<a href="../../integrations/delta-lake-dask/" class="md-nav__link">

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 @@ -1345,6 +1345,8 @@








Expand Down Expand Up @@ -1408,6 +1410,26 @@



<li class="md-nav__item">
<a href="../../../integrations/delta-lake-dagster/" class="md-nav__link">


<span class="md-ellipsis">
Dagster
</span>


</a>
</li>









<li class="md-nav__item">
<a href="../../../integrations/delta-lake-dask/" class="md-nav__link">

Expand Down
63 changes: 60 additions & 3 deletions api/delta_table/delta_table_merger/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1394,6 +1394,8 @@








Expand Down Expand Up @@ -1457,6 +1459,26 @@



<li class="md-nav__item">
<a href="../../../integrations/delta-lake-dagster/" class="md-nav__link">


<span class="md-ellipsis">
Dagster
</span>


</a>
</li>









<li class="md-nav__item">
<a href="../../../integrations/delta-lake-dask/" class="md-nav__link">

Expand Down Expand Up @@ -1871,6 +1893,11 @@ <h4 id="deltalake.table.TableMerger.when_matched_delete" class="doc doc-heading"
<p>Delete a matched row from the table only if the given <code>predicate</code> (if specified) is
true for the matched row. If not specified it deletes all matches.</p>

<details class="note" open>
<summary>Note</summary>
<p>Column names with special characters, such as numbers or spaces should be encapsulated
in backticks: "target.<code>123column</code>" or "target.<code>my column</code>"</p>
</details>


<p><strong>Parameters:</strong></p>
Expand Down Expand Up @@ -1993,6 +2020,11 @@ <h4 id="deltalake.table.TableMerger.when_matched_update" class="doc doc-heading"
<p>Update a matched table row based on the rules defined by <code>updates</code>.
If a <code>predicate</code> is specified, then it must evaluate to true for the row to be updated.</p>

<details class="note" open>
<summary>Note</summary>
<p>Column names with special characters, such as numbers or spaces should be encapsulated
in backticks: "target.<code>123column</code>" or "target.<code>my column</code>"</p>
</details>


<p><strong>Parameters:</strong></p>
Expand Down Expand Up @@ -2066,18 +2098,18 @@ <h4 id="deltalake.table.TableMerger.when_matched_update" class="doc doc-heading"
<div class="language-python 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="kn">from</span> <span class="nn">deltalake</span> <span class="kn">import</span> <span class="n">DeltaTable</span><span class="p">,</span> <span class="n">write_deltalake</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="kn">import</span> <span class="nn">pyarrow</span> <span class="k">as</span> <span class="nn">pa</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="n">data</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">table</span><span class="p">({</span><span class="s2">&quot;x&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span> <span class="s2">&quot;y&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">]})</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="n">data</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">table</span><span class="p">({</span><span class="s2">&quot;x&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span> <span class="s2">&quot;1y&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">]})</span>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="n">write_deltalake</span><span class="p">(</span><span class="s2">&quot;tmp&quot;</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="n">dt</span> <span class="o">=</span> <span class="n">DeltaTable</span><span class="p">(</span><span class="s2">&quot;tmp&quot;</span><span class="p">)</span>
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="n">new_data</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">table</span><span class="p">({</span><span class="s2">&quot;x&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="s2">&quot;y&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">7</span><span class="p">]})</span>
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="n">new_data</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">table</span><span class="p">({</span><span class="s2">&quot;x&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="s2">&quot;1y&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">7</span><span class="p">]})</span>
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="p">(</span>
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">dt</span><span class="o">.</span><span class="n">merge</span><span class="p">(</span>
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n">source</span><span class="o">=</span><span class="n">new_data</span><span class="p">,</span>
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n">predicate</span><span class="o">=</span><span class="s2">&quot;target.x = source.x&quot;</span><span class="p">,</span>
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n">source_alias</span><span class="o">=</span><span class="s2">&quot;source&quot;</span><span class="p">,</span>
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n">target_alias</span><span class="o">=</span><span class="s2">&quot;target&quot;</span><span class="p">)</span>
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="o">.</span><span class="n">when_matched_update</span><span class="p">(</span><span class="n">updates</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;x&quot;</span><span class="p">:</span> <span class="s2">&quot;source.x&quot;</span><span class="p">,</span> <span class="s2">&quot;y&quot;</span><span class="p">:</span> <span class="s2">&quot;source.y&quot;</span><span class="p">})</span>
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="o">.</span><span class="n">when_matched_update</span><span class="p">(</span><span class="n">updates</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;x&quot;</span><span class="p">:</span> <span class="s2">&quot;source.x&quot;</span><span class="p">,</span> <span class="s2">&quot;`1y`&quot;</span><span class="p">:</span> <span class="s2">&quot;source.`1y`&quot;</span><span class="p">})</span>
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="p">)</span>
</span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="p">{</span><span class="s1">&#39;num_source_rows&#39;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;num_target_rows_inserted&#39;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">&#39;num_target_rows_updated&#39;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;num_target_rows_deleted&#39;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">&#39;num_target_rows_copied&#39;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s1">&#39;num_output_rows&#39;</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s1">&#39;num_target_files_added&#39;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;num_target_files_removed&#39;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;execution_time_ms&#39;</span><span class="p">:</span> <span class="o">...</span><span class="p">,</span> <span class="s1">&#39;scan_time_ms&#39;</span><span class="p">:</span> <span class="o">...</span><span class="p">,</span> <span class="s1">&#39;rewrite_time_ms&#39;</span><span class="p">:</span> <span class="o">...</span><span class="p">}</span>
Expand Down Expand Up @@ -2111,6 +2143,11 @@ <h4 id="deltalake.table.TableMerger.when_matched_update_all" class="doc doc-head
<p>Updating all source fields to target fields, source and target are required to have the same field names.
If a <code>predicate</code> is specified, then it must evaluate to true for the row to be updated.</p>

<details class="note" open>
<summary>Note</summary>
<p>Column names with special characters, such as numbers or spaces should be encapsulated
in backticks: "target.<code>123column</code>" or "target.<code>my column</code>"</p>
</details>


<p><strong>Parameters:</strong></p>
Expand Down Expand Up @@ -2215,6 +2252,11 @@ <h4 id="deltalake.table.TableMerger.when_not_matched_by_source_delete" class="do
<p>Delete a target row that has no matches in the source from the table only if the given
<code>predicate</code> (if specified) is true for the target row.</p>

<details class="note" open>
<summary>Note</summary>
<p>Column names with special characters, such as numbers or spaces should be encapsulated
in backticks: "target.<code>123column</code>" or "target.<code>my column</code>"</p>
</details>


<p><strong>Parameters:</strong></p>
Expand Down Expand Up @@ -2291,6 +2333,11 @@ <h4 id="deltalake.table.TableMerger.when_not_matched_by_source_update" class="do
<p>Update a target row that has no matches in the source based on the rules defined by <code>updates</code>.
If a <code>predicate</code> is specified, then it must evaluate to true for the row to be updated.</p>

<details class="note" open>
<summary>Note</summary>
<p>Column names with special characters, such as numbers or spaces should be encapsulated
in backticks: "target.<code>123column</code>" or "target.<code>my column</code>"</p>
</details>


<p><strong>Parameters:</strong></p>
Expand Down Expand Up @@ -2411,6 +2458,11 @@ <h4 id="deltalake.table.TableMerger.when_not_matched_insert" class="doc doc-head
<p>Insert a new row to the target table based on the rules defined by <code>updates</code>. If a
<code>predicate</code> is specified, then it must evaluate to true for the new row to be inserted.</p>

<details class="note" open>
<summary>Note</summary>
<p>Column names with special characters, such as numbers or spaces should be encapsulated
in backticks: "target.<code>123column</code>" or "target.<code>my column</code>"</p>
</details>


<p><strong>Parameters:</strong></p>
Expand Down Expand Up @@ -2535,6 +2587,11 @@ <h4 id="deltalake.table.TableMerger.when_not_matched_insert_all" class="doc doc-
required to have the same field names. If a <code>predicate</code> is specified, then it must evaluate to true for
the new row to be inserted.</p>

<details class="note" open>
<summary>Note</summary>
<p>Column names with special characters, such as numbers or spaces should be encapsulated
in backticks: "target.<code>123column</code>" or "target.<code>my column</code>"</p>
</details>


<p><strong>Parameters:</strong></p>
Expand Down
22 changes: 22 additions & 0 deletions api/delta_table/delta_table_optimizer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1345,6 +1345,8 @@








Expand Down Expand Up @@ -1408,6 +1410,26 @@



<li class="md-nav__item">
<a href="../../../integrations/delta-lake-dagster/" class="md-nav__link">


<span class="md-ellipsis">
Dagster
</span>


</a>
</li>









<li class="md-nav__item">
<a href="../../../integrations/delta-lake-dask/" class="md-nav__link">

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








Expand Down Expand Up @@ -1341,6 +1343,26 @@



<li class="md-nav__item">
<a href="../../integrations/delta-lake-dagster/" class="md-nav__link">


<span class="md-ellipsis">
Dagster
</span>


</a>
</li>









<li class="md-nav__item">
<a href="../../integrations/delta-lake-dask/" class="md-nav__link">

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 @@ -1373,6 +1373,8 @@








Expand Down Expand Up @@ -1436,6 +1438,26 @@



<li class="md-nav__item">
<a href="../../../integrations/delta-lake-dagster/" class="md-nav__link">


<span class="md-ellipsis">
Dagster
</span>


</a>
</li>









<li class="md-nav__item">
<a href="../../../integrations/delta-lake-dask/" class="md-nav__link">

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








Expand Down Expand Up @@ -1428,6 +1430,26 @@



<li class="md-nav__item">
<a href="../../integrations/delta-lake-dagster/" class="md-nav__link">


<span class="md-ellipsis">
Dagster
</span>


</a>
</li>









<li class="md-nav__item">
<a href="../../integrations/delta-lake-dask/" class="md-nav__link">

Expand Down
Loading

0 comments on commit 8c96ab1

Please sign in to comment.