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

# gpudb::ShowStatisticsRequest

> gpudb::ShowStatisticsRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a9f383f90577358cd07abe30ddf79295f">GPUdb::showStatistics</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/show__statistics_8h_source">gpudb/protocol/show\_statistics.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a8282fa01f4c2ffdec2231b40d6e44dbe" id="r_a8282fa01f4c2ffdec2231b40d6e44dbe">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a8282fa01f4c2ffdec2231b40d6e44dbe">ShowStatisticsRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a8282fa01f4c2ffdec2231b40d6e44dbe">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ShowStatisticsRequest" title="A set of parameters for GPUdb::showStatistics.">ShowStatisticsRequest</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:a8282fa01f4c2ffdec2231b40d6e44dbe">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:af4e7d7092adc26bbd4e2857b056706c7" id="r_af4e7d7092adc26bbd4e2857b056706c7">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af4e7d7092adc26bbd4e2857b056706c7">tableNames</a></td>
      </tr>

      <tr className="memdesc:af4e7d7092adc26bbd4e2857b056706c7">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Names of tables whose metadata will be fetched, each in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. <br /></td>
      </tr>

      <tr className="separator:af4e7d7092adc26bbd4e2857b056706c7">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a30de29104da8b00d39c59d881df47a06" id="r_a30de29104da8b00d39c59d881df47a06">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a30de29104da8b00d39c59d881df47a06">options</a></td>
      </tr>

      <tr className="memdesc:a30de29104da8b00d39c59d881df47a06">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

      <tr className="separator:a30de29104da8b00d39c59d881df47a06">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a7694d01a338a50a9728f395fa99f75f5" id="r_a7694d01a338a50a9728f395fa99f75f5">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7694d01a338a50a9728f395fa99f75f5">ShowStatisticsRequest</a> (const std::vector\< std::string > \&tableNames\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a7694d01a338a50a9728f395fa99f75f5">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ShowStatisticsRequest" title="A set of parameters for GPUdb::showStatistics.">ShowStatisticsRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:a7694d01a338a50a9728f395fa99f75f5">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a9f383f90577358cd07abe30ddf79295f">GPUdb::showStatistics</a>. </p>
      <p>Retrieves the collected column statistics for the specified table(s). </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__statistics_8h_source#l00018">18</a> of file <a className="el" href="/content/api/cpp/show__statistics_8h_source">show\_statistics.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a8282fa01f4c2ffdec2231b40d6e44dbe">◆ </a></span>ShowStatisticsRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::ShowStatisticsRequest::ShowStatisticsRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ShowStatisticsRequest" title="A set of parameters for GPUdb::showStatistics.">ShowStatisticsRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__statistics_8h_source#l00023">23</a> of file <a className="el" href="/content/api/cpp/show__statistics_8h_source">show\_statistics.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::ShowStatisticsRequest::ShowStatisticsRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::vector\< std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">tableNames\_</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>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ShowStatisticsRequest" title="A set of parameters for GPUdb::showStatistics.">ShowStatisticsRequest</a> object with the specified parameters. </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">tableNames\_</td>
                <td>Names of tables whose metadata will be fetched, each in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. All provided tables must exist, or an error is returned. A single entry of '\*' expands to every user table the caller may read (excluding system schemas, views, and temporary tables); when used it must be the only entry. </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#a7d76a95c1fb5ee220e049f6334be9696">show\_statistics\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a83d9cb34ce94fe40114b20cb32748eb7">true</a> and if the table names specified in <span className="em arg">tableNames\_</span> does not exist, no error is returned. If <a className="el" href="/content/api/cpp/namespacegpudb#a42cedb45be89e7b0b659b4f55e70fccc">false</a> and if the table names specified in <span className="em arg">tableNames\_</span> does not exist, then an error is returned. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a83d9cb34ce94fe40114b20cb32748eb7">show\_statistics\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a42cedb45be89e7b0b659b4f55e70fccc">show\_statistics\_false</a> </li>
                      </ul>

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

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#afda28f4842d432638004887c1236ec41">show\_statistics\_column\_names</a>: Columns, per table in <span className="em arg">tableNames\_</span>, to collect statistics for when input.key options.collect\_now{"}"} is <a className="el" href="/content/api/cpp/namespacegpudb#a83d9cb34ce94fe40114b20cb32748eb7">true</a>; ignored otherwise. Encoded as a ';'-separated parallel array aligned with <span className="em arg">tableNames\_</span> (e.g. 'x,y;z' requests columns x,y for the first table and z for the second). A value of '<span className="em">' expands to every collectable column on each table (geometry, vector, JSON, and array columns are skipped). An explicit list may not be combined with a '</span>' table\_names wildcard. The default value is ''. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a2f041f9c9672949ef3dd2f921f58116d">show\_statistics\_collect\_now</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a83d9cb34ce94fe40114b20cb32748eb7">true</a>, the columns named byinput.key options.column\_names{"}"} are collected synchronously during this request and reflected in the response. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a83d9cb34ce94fe40114b20cb32748eb7">show\_statistics\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a42cedb45be89e7b0b659b4f55e70fccc">show\_statistics\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a42cedb45be89e7b0b659b4f55e70fccc">show\_statistics\_false</a>.
                    </li>
                  </ul>

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

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__statistics_8h_source#l00109">109</a> of file <a className="el" href="/content/api/cpp/show__statistics_8h_source">show\_statistics.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a30de29104da8b00d39c59d881df47a06">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::ShowStatisticsRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a7d76a95c1fb5ee220e049f6334be9696">show\_statistics\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a83d9cb34ce94fe40114b20cb32748eb7">true</a> and if the table names specified in <a className="el" href="#af4e7d7092adc26bbd4e2857b056706c7">tableNames</a> does not exist, no error is returned. If <a className="el" href="/content/api/cpp/namespacegpudb#a42cedb45be89e7b0b659b4f55e70fccc">false</a> and if the table names specified in <a className="el" href="#af4e7d7092adc26bbd4e2857b056706c7">tableNames</a> does not exist, then an error is returned. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a83d9cb34ce94fe40114b20cb32748eb7">show\_statistics\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a42cedb45be89e7b0b659b4f55e70fccc">show\_statistics\_false</a> </li>
            </ul>

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

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#afda28f4842d432638004887c1236ec41">show\_statistics\_column\_names</a>: Columns, per table in <a className="el" href="#af4e7d7092adc26bbd4e2857b056706c7">tableNames</a>, to collect statistics for wheninput.key options.collect\_now{"}"} is <a className="el" href="/content/api/cpp/namespacegpudb#a83d9cb34ce94fe40114b20cb32748eb7">true</a>; ignored otherwise. Encoded as a ';'-separated parallel array aligned with <a className="el" href="#af4e7d7092adc26bbd4e2857b056706c7">tableNames</a> (e.g. 'x,y;z' requests columns x,y for the first table and z for the second). A value of '<span className="em">' expands to every collectable column on each table (geometry, vector, JSON, and array columns are skipped). An explicit list may not be combined with a '</span>' table\_names wildcard. The default value is ''. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a2f041f9c9672949ef3dd2f921f58116d">show\_statistics\_collect\_now</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a83d9cb34ce94fe40114b20cb32748eb7">true</a>, the columns named by input.key options.column\_names{"}"} are collected synchronously during this request and reflected in the response. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a83d9cb34ce94fe40114b20cb32748eb7">show\_statistics\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a42cedb45be89e7b0b659b4f55e70fccc">show\_statistics\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a42cedb45be89e7b0b659b4f55e70fccc">show\_statistics\_false</a>.
          </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__statistics_8h_source#l00174">174</a> of file <a className="el" href="/content/api/cpp/show__statistics_8h_source">show\_statistics.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#af4e7d7092adc26bbd4e2857b056706c7">◆ </a></span>tableNames</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<std::string> gpudb::ShowStatisticsRequest::tableNames</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Names of tables whose metadata will be fetched, each in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </p>
        <p>All provided tables must exist, or an error is returned. A single entry of '\*' expands to every user table the caller may read (excluding system schemas, views, and temporary tables); when used it must be the only entry. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__statistics_8h_source#l00124">124</a> of file <a className="el" href="/content/api/cpp/show__statistics_8h_source">show\_statistics.h</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/show__statistics_8h_source">show\_statistics.h</a></li>
    </ul>
  </div>
</div>