> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# to_df

<div className="kinetica-pydoc">
  <div className="dl py method">
    <div className="dt sig sig-object py" id="gpudb.GPUdb.to_df"> <span className="sig-name descname"><span className="pre">to\_df</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">sql</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">str</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">sql\_params</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">list</span></span><span className="w"> </span><span className="o"><span className="pre">=</span></span><span className="w"> </span><span className="default_value"><span className="pre">\[]</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">batch\_size</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">int</span></span><span className="w"> </span><span className="o"><span className="pre">=</span></span><span className="w"> </span><span className="default_value"><span className="pre">5000</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">sql\_opts</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">dict</span></span><span className="w"> </span><span className="o"><span className="pre">=</span></span><span className="w"> </span><span className="default_value"><span className="pre">{"{"}{"}"}</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">show\_progress</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">bool</span></span><span className="w"> </span><span className="o"><span className="pre">=</span></span><span className="w"> </span><span className="default_value"><span className="pre">False</span></span></span><span className="sig-paren">)</span><a href="https://github.com/kineticadb/kinetica-api-python/blob/master/gpudb/gpudb.py#L11375"><span className="viewcode-link"><span className="pre">\[source]</span></span></a></div>

    <div className="dd">
      <p>Runs the given query and converts the result to a Pandas Data Frame.</p>
      <p><strong>Parameters</strong></p>

      <div className="blockquote">
        <div>
          <div className="dl simple">
            <div className="dt">sql (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>The SQL query to run</p>
            </div>

            <div className="dt">sql\_params (<span className="em">list</span>) –</div>

            <div className="dd">
              <p>The SQL parameters that will be substituted for tokens (e.g. $1 $2)</p>
            </div>

            <div className="dt">batch\_size (<span className="em">int</span>) –</div>

            <div className="dd">
              <p>The number of records to retrieve at a time from the database</p>
            </div>

            <div className="dt">sql\_opts (<span className="em">dict</span>) –</div>

            <div className="dd">
              <p>The options for SQL execution, matching the options passed to <a className="reference internal" href="#gpudb.GPUdb.execute_sql" title="gpudb.GPUdb.execute_sql"><code className="xref py py-meth docutils literal notranslate"><span className="pre">GPUdb.execute\_sql()</span></code></a>. Defaults to None.</p>
            </div>

            <div className="dt">show\_progress (<span className="em">bool</span>) –</div>

            <div className="dd">
              <p>Whether to display progress on the console or not. Defaults to False.</p>
            </div>
          </div>
        </div>
      </div>

      <p><strong>Raises</strong></p>

      <div className="blockquote">
        <div>
          <p>GPUdbException</p>
        </div>
      </div>

      <p><strong>Returns</strong></p>

      <div className="blockquote">
        <div>
          <div className="dl simple">
            <div className="dt">pd.DataFrame –</div>

            <div className="dd">
              <p>A Pandas Data Frame containing the result set of the SQL query or None if there are no results</p>
            </div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>