
  
  <section id="snowflake-snowpark-types-structtype">
<h1>snowflake.snowpark.types.StructType<a class="headerlink" href="#snowflake-snowpark-types-structtype" title="Permalink to this heading" data-nosnippet="">¶</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="snowflake.snowpark.types.StructType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">snowflake.snowpark.types.</span></span><span class="sig-name descname"><span class="pre">StructType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fields</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="snowflake.snowpark.types.StructField.html#snowflake.snowpark.types.StructField" title="snowflake.snowpark.types.StructField"><span class="pre">StructField</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><span class="viewcode-link"><span class="pre">[source]</span></span> (https://github.com/snowflakedb/snowpark-python/blob/release-v1.8.0/src/snowflake/snowpark/types.py#L332-L397)<a class="headerlink" href="#snowflake.snowpark.types.StructType" title="Permalink to this definition" data-nosnippet="">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="snowflake.snowpark.types.DataType.html#snowflake.snowpark.types.DataType" title="snowflake.snowpark.types.DataType"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataType</span></code></a></p>
<p>Represents a table schema. Contains <a class="reference internal" href="snowflake.snowpark.types.StructField.html#snowflake.snowpark.types.StructField" title="snowflake.snowpark.types.StructField"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructField</span></code></a> for each column.</p>
<p class="rubric">Methods</p>
<div class="scrollable-table-wrapper relative group text-sm"><div class="scrollable-table-frame" data-scrollable-table-injected="true"><div class="scrollable-table-scroll-container"><table class="autosummary longtable docutils align-default scrollable-table-toggleable" data-table-index="0"><caption class="scrollable-table-caption-generated scrollable-table-caption-bg"></caption>
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">add</span></code>(field[,&nbsp;datatype,&nbsp;nullable])</p></td>
<td><p></p></td>
</tr>
</tbody>
</table></div><div class="scrollable-table-show-more-fab"><button type="button" data-table-index="0" aria-label="See more" data-tooltip="See more" class="codeblock-button scrollable-table-show-more" disabled=""><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="copybutton-icon double-chevron-icon"><path d="M7 7l5 5 5-5M7 13l5 5 5-5"></path></svg><span class="sr-only">See more</span></button><button type="button" data-table-index="0" aria-label="Show less" data-tooltip="Show less" class="codeblock-button scrollable-table-show-less" disabled=""><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="copybutton-icon double-chevron-icon is-up"><path d="M7 7l5 5 5-5M7 13l5 5 5-5"></path></svg><span class="sr-only">Show less</span></button></div><div class="scrollable-table-toggle-fab"><button type="button" data-table-index="0" class="codeblock-button scrollable-table-toggle" aria-expanded="false" aria-label="Expand table" data-tooltip="Expand"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="copybutton-icon toggle-icon toggle-icon-expand"><path d="M15 3H21V9"></path><path d="M21 3L14 10"></path><path d="M9 21H3V15"></path><path d="M3 21L10 14"></path></svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="copybutton-icon toggle-icon toggle-icon-collapse"><path d="M4 14H10V20"></path><path d="M20 10H14V4"></path><path d="M14 10L21 3"></path><path d="M10 14L3 21"></path></svg><span class="sr-only">Expand</span></button></div><div class="scrollable-table-bottom-fade"></div></div></div>
<p class="rubric">Attributes</p>
<div class="scrollable-table-wrapper relative group text-sm"><div class="scrollable-table-frame" data-scrollable-table-injected="true"><div class="scrollable-table-scroll-container"><table class="autosummary longtable docutils align-default scrollable-table-toggleable" data-table-index="1"><caption class="scrollable-table-caption-generated scrollable-table-caption-bg"></caption>
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">names</span></code></p></td>
<td><p>Returns the list of names of the <a class="reference internal" href="snowflake.snowpark.types.StructField.html#snowflake.snowpark.types.StructField" title="snowflake.snowpark.types.StructField"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructField</span></code></a></p></td>
</tr>
</tbody>
</table></div><div class="scrollable-table-show-more-fab"><button type="button" data-table-index="1" aria-label="See more" data-tooltip="See more" class="codeblock-button scrollable-table-show-more" disabled=""><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="copybutton-icon double-chevron-icon"><path d="M7 7l5 5 5-5M7 13l5 5 5-5"></path></svg><span class="sr-only">See more</span></button><button type="button" data-table-index="1" aria-label="Show less" data-tooltip="Show less" class="codeblock-button scrollable-table-show-less" disabled=""><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="copybutton-icon double-chevron-icon is-up"><path d="M7 7l5 5 5-5M7 13l5 5 5-5"></path></svg><span class="sr-only">Show less</span></button></div><div class="scrollable-table-toggle-fab"><button type="button" data-table-index="1" class="codeblock-button scrollable-table-toggle" aria-expanded="false" aria-label="Expand table" data-tooltip="Expand"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="copybutton-icon toggle-icon toggle-icon-expand"><path d="M15 3H21V9"></path><path d="M21 3L14 10"></path><path d="M9 21H3V15"></path><path d="M3 21L10 14"></path></svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="copybutton-icon toggle-icon toggle-icon-collapse"><path d="M4 14H10V20"></path><path d="M20 10H14V4"></path><path d="M14 10L21 3"></path><path d="M10 14L3 21"></path></svg><span class="sr-only">Expand</span></button></div><div class="scrollable-table-bottom-fade"></div></div></div>
</dd></dl>

</section>




snowflake.snowpark.types.StructType¶