Deployed 1303589 with MkDocs version: 1.6.1

DeltaColumnBuilder/index.html

@@ -8,13 +8,15 @@
 <span class=w>  </span><span class=n>dataType</span><span class=p>:</span><span class=w> </span><span class=nc>String</span><span class=p>):</span><span class=w> </span><span class=nc>DeltaColumnBuilder</span>
 </code></pre></div> <h3 id=generatedAlwaysAs>generatedAlwaysAs<a class=headerlink href=#generatedAlwaysAs title="Permanent link">&para;</a></h3> <div class=highlight><pre><span></span><code><span class=n>generatedAlwaysAs</span><span class=p>(</span>
 <span class=w>  </span><span class=n>expr</span><span class=p>:</span><span class=w> </span><span class=nc>String</span><span class=p>):</span><span class=w> </span><span class=nc>DeltaColumnBuilder</span>
-</code></pre></div> <p>Registers the <a href=#generationExpr>Generation Expression</a> of this field</p> <h3 id=generatedAlwaysAsIdentity>generatedAlwaysAsIdentity<a class=headerlink href=#generatedAlwaysAsIdentity title="Permanent link">&para;</a></h3> <div class=highlight><pre><span></span><code><span class=n>generatedAlwaysAsIdentity</span><span class=p>(</span>
+</code></pre></div> <p>Registers the <a href=#generationExpr>Generation Expression</a> of this field</p> <h3 id=generatedAlwaysAsIdentity>generatedAlwaysAsIdentity<a class=headerlink href=#generatedAlwaysAsIdentity title="Permanent link">&para;</a></h3> <div class=highlight><pre><span></span><code><span class=n>generatedAlwaysAsIdentity</span><span class=p>():</span><span class=w> </span><span class=nc>DeltaColumnBuilder</span><span class=w> </span><span class=c1>// (1)!</span>
+<span class=n>generatedAlwaysAsIdentity</span><span class=p>(</span>
 <span class=w>  </span><span class=n>start</span><span class=p>:</span><span class=w> </span><span class=nc>Long</span><span class=p>,</span>
 <span class=w>  </span><span class=n>step</span><span class=p>:</span><span class=w> </span><span class=nc>Long</span><span class=p>):</span><span class=w> </span><span class=nc>DeltaColumnBuilder</span>
-</code></pre></div> <p>Sets the following:</p> <table> <thead> <tr> <th>Property</th> <th>Value</th> </tr> </thead> <tbody> <tr> <td><a href=#identityStart>identityStart</a></td> <td><code>start</code></td> </tr> <tr> <td><a href=#identityStep>identityStep</a></td> <td><code>step</code></td> </tr> <tr> <td><a href=#identityAllowExplicitInsert>identityAllowExplicitInsert</a></td> <td><code>false</code></td> </tr> </tbody> </table> <h3 id=generatedByDefaultAsIdentity>generatedByDefaultAsIdentity<a class=headerlink href=#generatedByDefaultAsIdentity title="Permanent link">&para;</a></h3> <div class=highlight><pre><span></span><code><span class=n>generatedByDefaultAsIdentity</span><span class=p>(</span>
+</code></pre></div> <ol> <li>Uses the defaults</li> </ol> <p>Sets the following:</p> <table> <thead> <tr> <th>Property</th> <th>Value</th> <th>Default Value</th> </tr> </thead> <tbody> <tr> <td><a href=#identityStart>identityStart</a></td> <td><code>start</code></td> <td>1</td> </tr> <tr> <td><a href=#identityStep>identityStep</a></td> <td><code>step</code></td> <td>1</td> </tr> <tr> <td><a href=#identityAllowExplicitInsert>identityAllowExplicitInsert</a></td> <td><code>false</code></td> <td>(undefined)</td> </tr> </tbody> </table> <h3 id=generatedByDefaultAsIdentity>generatedByDefaultAsIdentity<a class=headerlink href=#generatedByDefaultAsIdentity title="Permanent link">&para;</a></h3> <div class=highlight><pre><span></span><code><span class=n>generatedByDefaultAsIdentity</span><span class=p>():</span><span class=w> </span><span class=nc>DeltaColumnBuilder</span><span class=w> </span><span class=c1>// (1)!</span>
+<span class=n>generatedByDefaultAsIdentity</span><span class=p>(</span>
 <span class=w>  </span><span class=n>start</span><span class=p>:</span><span class=w> </span><span class=nc>Long</span><span class=p>,</span>
 <span class=w>  </span><span class=n>step</span><span class=p>:</span><span class=w> </span><span class=nc>Long</span><span class=p>):</span><span class=w> </span><span class=nc>DeltaColumnBuilder</span>
-</code></pre></div> <p>Sets the following:</p> <table> <thead> <tr> <th>Property</th> <th>Value</th> </tr> </thead> <tbody> <tr> <td><a href=#identityStart>identityStart</a></td> <td><code>start</code></td> </tr> <tr> <td><a href=#identityStep>identityStep</a></td> <td><code>step</code></td> </tr> <tr> <td><a href=#identityAllowExplicitInsert>identityAllowExplicitInsert</a></td> <td><code>true</code></td> </tr> </tbody> </table> <h3 id=nullable>nullable<a class=headerlink href=#nullable title="Permanent link">&para;</a></h3> <div class=highlight><pre><span></span><code><span class=n>nullable</span><span class=p>(</span>
+</code></pre></div> <ol> <li>Uses the defaults</li> </ol> <p>Sets the following:</p> <table> <thead> <tr> <th>Property</th> <th>Value</th> <th>Default Value</th> </tr> </thead> <tbody> <tr> <td><a href=#identityStart>identityStart</a></td> <td><code>start</code></td> <td>1</td> </tr> <tr> <td><a href=#identityStep>identityStep</a></td> <td><code>step</code></td> <td>1</td> </tr> <tr> <td><a href=#identityAllowExplicitInsert>identityAllowExplicitInsert</a></td> <td><code>true</code></td> <td>(undefined)</td> </tr> </tbody> </table> <h3 id=nullable>nullable<a class=headerlink href=#nullable title="Permanent link">&para;</a></h3> <div class=highlight><pre><span></span><code><span class=n>nullable</span><span class=p>(</span>
 <span class=w>  </span><span class=n>nullable</span><span class=p>:</span><span class=w> </span><span class=nc>Boolean</span><span class=p>):</span><span class=w> </span><span class=nc>DeltaColumnBuilder</span>
 </code></pre></div> <h2 id=generationExpr>Generation Expression<a class=headerlink href=#generationExpr title="Permanent link">&para;</a></h2> <div class=highlight><pre><span></span><code><span class=n>generationExpr</span><span class=p>:</span><span class=w> </span><span class=nc>Option</span><span class=p>[</span><span class=nc>String</span><span class=p>]</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=nc>None</span>
 </code></pre></div> <p><code>DeltaColumnBuilder</code> uses <code>generationExpr</code> internal registry for the <a href=#generatedAlwaysAs>generatedAlwaysAs</a> expression.</p> <p>When requested to <a href=#build>build a StructField</a>, <code>DeltaColumnBuilder</code> registers <code>generationExpr</code> under <a href=../spark-connector/DeltaSourceUtils/#GENERATION_EXPRESSION_METADATA_KEY>delta.generationExpression</a> key in the metadata (of this field).</p> <h2 id=identityAllowExplicitInsert>identityAllowExplicitInsert<a class=headerlink href=#identityAllowExplicitInsert title="Permanent link">&para;</a></h2> <div class=highlight><pre><span></span><code><span class=n>identityAllowExplicitInsert</span><span class=p>:</span><span class=w> </span><span class=nc>Option</span><span class=p>[</span><span class=nc>Boolean</span><span class=p>]</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=nc>None</span>