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

# showProcStatus

<div className="kinetica-doxygen">
  <div id="a1d460da9ead16a63d91e8a104805d0a6" />

  <h2 className="memtitle"><span className="permalink"><a href="#a1d460da9ead16a63d91e8a104805d0a6">◆ </a></span>showProcStatus() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusResponse">ShowProcStatusResponse</a> gpudb::GPUdb::showProcStatus </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusRequest">ShowProcStatusRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Shows the statuses of running or completed proc instances. </p>
      <p>Results are grouped by run ID (as returned from <a className="el" href="#aec2cf18c6185bf22d4fa351019b9924e">executeProc</a>) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).</p>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusRequest">Request</a> object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a24b7a91e64544a630bba237a13278ced" />

  <h2 className="memtitle"><span className="permalink"><a href="#a24b7a91e64544a630bba237a13278ced">◆ </a></span>showProcStatus() <span className="overload">\[2/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusResponse">ShowProcStatusResponse</a> & gpudb::GPUdb::showProcStatus </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusRequest">ShowProcStatusRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusResponse">ShowProcStatusResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Shows the statuses of running or completed proc instances. </p>
      <p>Results are grouped by run ID (as returned from <a className="el" href="#aec2cf18c6185bf22d4fa351019b9924e">executeProc</a>) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).</p>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a13497a80667b878cad9e5e6db04092d9" />

  <h2 className="memtitle"><span className="permalink"><a href="#a13497a80667b878cad9e5e6db04092d9">◆ </a></span>showProcStatus() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusResponse">ShowProcStatusResponse</a> gpudb::GPUdb::showProcStatus </td>
          <td>(</td>
          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">runId</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Shows the statuses of running or completed proc instances. </p>
      <p>Results are grouped by run ID (as returned from <a className="el" href="#a19f569cb61a53022021bbfd9e031468d">executeProc</a>) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).</p>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">runId</td>
              <td>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 ''. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#ac66483badacbfc643b331dc9a4fa49e4">show\_proc\_status\_clear\_complete</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#a52fcd6cd1d56e6a8dab49e68f0749ba5">true</a>, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a52fcd6cd1d56e6a8dab49e68f0749ba5">show\_proc\_status\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a14ba0ef4c12caf314a87db74604ffa80">show\_proc\_status\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a14ba0ef4c12caf314a87db74604ffa80">show\_proc\_status\_false</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a346fcb78bba835a71c440750418aae75">show\_proc\_status\_run\_tag</a>: If <span className="em arg">runId</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="el" href="#a19f569cb61a53022021bbfd9e031468d">executeProc</a>. If <span className="em arg">runId</span> is not specified, return statuses for all proc instances where a matching run tag was provided to <a className="el" href="#a19f569cb61a53022021bbfd9e031468d">executeProc</a>. The default value is ''. </li>
                </ul>

                The default value is an empty map.
              </td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="ac60a93b49b3d2f94f229a9d0df2aa79b" />

  <h2 className="memtitle"><span className="permalink"><a href="#ac60a93b49b3d2f94f229a9d0df2aa79b">◆ </a></span>showProcStatus() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusResponse">ShowProcStatusResponse</a> & gpudb::GPUdb::showProcStatus </td>
          <td>(</td>
          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">runId</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusResponse">ShowProcStatusResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Shows the statuses of running or completed proc instances. </p>
      <p>Results are grouped by run ID (as returned from <a className="el" href="#a19f569cb61a53022021bbfd9e031468d">executeProc</a>) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).</p>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">runId</td>
              <td>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 ''. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#ac66483badacbfc643b331dc9a4fa49e4">show\_proc\_status\_clear\_complete</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#a52fcd6cd1d56e6a8dab49e68f0749ba5">true</a>, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a52fcd6cd1d56e6a8dab49e68f0749ba5">show\_proc\_status\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a14ba0ef4c12caf314a87db74604ffa80">show\_proc\_status\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a14ba0ef4c12caf314a87db74604ffa80">show\_proc\_status\_false</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a346fcb78bba835a71c440750418aae75">show\_proc\_status\_run\_tag</a>: If <span className="em arg">runId</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="el" href="#a19f569cb61a53022021bbfd9e031468d">executeProc</a>. If <span className="em arg">runId</span> is not specified, return statuses for all proc instances where a matching run tag was provided to <a className="el" href="#a19f569cb61a53022021bbfd9e031468d">executeProc</a>. The default value is ''. </li>
                </ul>

                The default value is an empty map.
              </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>