> ## 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.

# show_proc_status

<div className="kinetica-pydoc">
  <div className="dl py method">
    <div className="dt sig sig-object py" id="gpudb.GPUdb.show_proc_status"> <span className="sig-name descname"><span className="pre">show\_proc\_status</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">run\_id</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">''</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">options</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">{"{"}{"}"}</span></span></span><span className="sig-paren">)</span><a href="https://github.com/kineticadb/kinetica-api-python/blob/master/gpudb/gpudb.py#L38919"><span className="viewcode-link"><span className="pre">\[source]</span></span></a></div>

    <div className="dd">
      <p>Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from <a className="reference internal" href="#gpudb.GPUdb.execute_proc" title="gpudb.GPUdb.execute_proc"><code className="xref py py-meth docutils literal notranslate"><span className="pre">GPUdb.execute\_proc()</span></code></a>) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).</p>
      <p><strong>Parameters</strong></p>

      <div className="blockquote">
        <div>
          <div className="dl">
            <div className="dt">run\_id (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>The run ID of a specific proc instance for which the status will be returned. If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed proc instances will be returned. The default value is ‘’.</p>
            </div>

            <div className="dt">options (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Optional parameters. Allowed keys are:</p>

              <ul>
                <li>
                  <p><strong>clear\_complete</strong> – If set to <span className="em">true</span>, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Allowed values are:</p>

                  <ul className="simple">
                    <li>
                      <p>true</p>
                    </li>

                    <li>
                      <p>false</p>
                    </li>
                  </ul>

                  <p>The default value is ‘false’.</p>
                </li>

                <li>
                  <p><strong>run\_tag</strong> – If input parameter <span className="em">run\_id</span> is specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided to <a className="reference internal" href="#gpudb.GPUdb.execute_proc" title="gpudb.GPUdb.execute_proc"><code className="xref py py-meth docutils literal notranslate"><span className="pre">GPUdb.execute\_proc()</span></code></a>. If input parameter <span className="em">run\_id</span> is not specified, return statuses for all proc instances where a matching run tag was provided to <a className="reference internal" href="#gpudb.GPUdb.execute_proc" title="gpudb.GPUdb.execute_proc"><code className="xref py py-meth docutils literal notranslate"><span className="pre">GPUdb.execute\_proc()</span></code></a>. The default value is ‘’.</p>
                </li>
              </ul>

              <p>The default value is an empty dict ( {"{"}{"}"} ).</p>
            </div>
          </div>
        </div>
      </div>

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

      <div className="blockquote">
        <div>
          <p>A dict with the following entries–</p>

          <div className="dl simple">
            <div className="dt">proc\_names (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>The proc names corresponding to the returned run IDs.</p>
            </div>

            <div className="dt">params (<span className="em">dict of str to dicts of str to str</span>) –</div>

            <div className="dd">
              <p>The string params passed to <a className="reference internal" href="#gpudb.GPUdb.execute_proc" title="gpudb.GPUdb.execute_proc"><code className="xref py py-meth docutils literal notranslate"><span className="pre">GPUdb.execute\_proc()</span></code></a> for the returned run IDs.</p>
            </div>

            <div className="dt">bin\_params (<span className="em">dict of str to dicts of str to bytes</span>) –</div>

            <div className="dd">
              <p>The binary params passed to <a className="reference internal" href="#gpudb.GPUdb.execute_proc" title="gpudb.GPUdb.execute_proc"><code className="xref py py-meth docutils literal notranslate"><span className="pre">GPUdb.execute\_proc()</span></code></a> for the returned run IDs.</p>
            </div>

            <div className="dt">input\_table\_names (<span className="em">dict of str to lists of str</span>) –</div>

            <div className="dd">
              <p>The input table names passed to <a className="reference internal" href="#gpudb.GPUdb.execute_proc" title="gpudb.GPUdb.execute_proc"><code className="xref py py-meth docutils literal notranslate"><span className="pre">GPUdb.execute\_proc()</span></code></a> for the returned run IDs.</p>
            </div>

            <div className="dt">input\_column\_names (<span className="em">dict of str to dicts of str to lists of str</span>) –</div>

            <div className="dd">
              <p>The input column names passed to <a className="reference internal" href="#gpudb.GPUdb.execute_proc" title="gpudb.GPUdb.execute_proc"><code className="xref py py-meth docutils literal notranslate"><span className="pre">GPUdb.execute\_proc()</span></code></a> for the returned run IDs, supplemented with the column names for input tables not included in the input column name map.</p>
            </div>

            <div className="dt">output\_table\_names (<span className="em">dict of str to lists of str</span>) –</div>

            <div className="dd">
              <p>The output table names passed to <a className="reference internal" href="#gpudb.GPUdb.execute_proc" title="gpudb.GPUdb.execute_proc"><code className="xref py py-meth docutils literal notranslate"><span className="pre">GPUdb.execute\_proc()</span></code></a> for the returned run IDs.</p>
            </div>

            <div className="dt">options (<span className="em">dict of str to dicts of str to str</span>) –</div>

            <div className="dd">
              <p>The optional parameters passed to <a className="reference internal" href="#gpudb.GPUdb.execute_proc" title="gpudb.GPUdb.execute_proc"><code className="xref py py-meth docutils literal notranslate"><span className="pre">GPUdb.execute\_proc()</span></code></a> for the returned run IDs.</p>
            </div>

            <div className="dt">overall\_statuses (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Overall statuses for the returned run IDs. Note that these are rollups and individual statuses may differ between data segments for the same run ID; see output parameter <span className="em">statuses</span> and output parameter <span className="em">messages</span> for statuses from individual data segments. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p><strong>running</strong> – The proc instance is currently running.</p>
                </li>

                <li>
                  <p><strong>complete</strong> – The proc instance completed with no errors.</p>
                </li>

                <li>
                  <p><strong>killed</strong> – The proc instance was killed before completion.</p>
                </li>

                <li>
                  <p><strong>error</strong> – The proc instance failed with an error.</p>
                </li>

                <li>
                  <p><strong>none</strong> – The proc instance does not have a status, i.e. it has not yet ran.</p>
                </li>
              </ul>
            </div>

            <div className="dt">statuses (<span className="em">dict of str to dicts of str to str</span>) –</div>

            <div className="dd">
              <p>Statuses for the returned run IDs, grouped by data segment ID. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p><strong>running</strong> – The proc instance is currently running.</p>
                </li>

                <li>
                  <p><strong>complete</strong> – The proc instance completed with no errors.</p>
                </li>

                <li>
                  <p><strong>killed</strong> – The proc instance was killed before completion.</p>
                </li>

                <li>
                  <p><strong>error</strong> – The proc instance failed with an error.</p>
                </li>

                <li>
                  <p><strong>none</strong> – The proc instance does not have a status, i.e. it has not yet ran.</p>
                </li>
              </ul>
            </div>

            <div className="dt">messages (<span className="em">dict of str to dicts of str to str</span>) –</div>

            <div className="dd">
              <p>Messages containing additional status information for the returned run IDs, grouped by data segment ID.</p>
            </div>

            <div className="dt">results (<span className="em">dict of str to dicts of str to dicts of str to str</span>) –</div>

            <div className="dd">
              <p>String results for the returned run IDs, grouped by data segment ID.</p>
            </div>

            <div className="dt">bin\_results (<span className="em">dict of str to dicts of str to dicts of str to bytes</span>) –</div>

            <div className="dd">
              <p>Binary results for the returned run IDs, grouped by data segment ID.</p>
            </div>

            <div className="dt">output (<span className="em">dict of str to dicts of str to dicts of str to lists of str</span>) –</div>

            <div className="dd">
              <p>Output lines for the returned run IDs, grouped by data segment ID. Allowed keys are:</p>

              <ul className="simple">
                <li>
                  <p><strong>stdout</strong> – Output lines from stdout.</p>
                </li>

                <li>
                  <p><strong>stderr</strong> – Output lines from stderr.</p>
                </li>
              </ul>
            </div>

            <div className="dt">timings (<span className="em">dict of str to dicts of str to dicts of str to longs</span>) –</div>

            <div className="dd">
              <p>Timing information for the returned run IDs, grouped by data segment ID.</p>
            </div>

            <div className="dt">info (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Additional information.</p>
            </div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>