> ## 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::CollectStatisticsRequest

> gpudb::CollectStatisticsRequest — 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#a71a881b85611086a22694f352810dc45">GPUdb::collectStatistics</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/collect__statistics_8h_source">gpudb/protocol/collect\_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:a19572fdc4647aa1dbfe0c53fdded9e70" id="r_a19572fdc4647aa1dbfe0c53fdded9e70">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a19572fdc4647aa1dbfe0c53fdded9e70">CollectStatisticsRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a19572fdc4647aa1dbfe0c53fdded9e70">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CollectStatisticsRequest" title="A set of parameters for GPUdb::collectStatistics.">CollectStatisticsRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a9d4e3fb62780bb56deed09c463aadf13" id="r_a9d4e3fb62780bb56deed09c463aadf13">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a9d4e3fb62780bb56deed09c463aadf13">CollectStatisticsRequest</a> (const std::string \&tableName\_, const std::vector\< std::string > \&columnNames\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

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

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

      <tr className="memitem:a85b887306871ab139f94a49b7eb92daf" id="r_a85b887306871ab139f94a49b7eb92daf">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a85b887306871ab139f94a49b7eb92daf">tableName</a></td>
      </tr>

      <tr className="memdesc:a85b887306871ab139f94a49b7eb92daf">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of a table, 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:a85b887306871ab139f94a49b7eb92daf">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:a4a59cdf8e2992dce05be1e5e0e0ab04e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">List of one or more column names in <a className="el" href="#a85b887306871ab139f94a49b7eb92daf">tableName</a> for which to collect statistics (cardinality, mean value, etc.). <br /></td>
      </tr>

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

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

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

      <tr className="separator:aad288b63c5424b999cbaabcf6c61a4de">
        <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#a71a881b85611086a22694f352810dc45">GPUdb::collectStatistics</a>. </p>
      <p>Collect statistics for a column(s) in a specified table. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/collect__statistics_8h_source#l00018">18</a> of file <a className="el" href="/content/api/cpp/collect__statistics_8h_source">collect\_statistics.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a19572fdc4647aa1dbfe0c53fdded9e70">◆ </a></span>CollectStatisticsRequest() <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::CollectStatisticsRequest::CollectStatisticsRequest </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_1CollectStatisticsRequest" title="A set of parameters for GPUdb::collectStatistics.">CollectStatisticsRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/collect__statistics_8h_source#l00024">24</a> of file <a className="el" href="/content/api/cpp/collect__statistics_8h_source">collect\_statistics.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a9d4e3fb62780bb56deed09c463aadf13">◆ </a></span>CollectStatisticsRequest() <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::CollectStatisticsRequest::CollectStatisticsRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">tableName\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const std::vector\< std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">columnNames\_</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_1CollectStatisticsRequest" title="A set of parameters for GPUdb::collectStatistics.">CollectStatisticsRequest</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">tableName\_</td>
                <td>Name of a table, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table. A value of '\*' collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, <span className="em arg">columnNames\_</span> must be '\*'. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">columnNames\_</td>
                <td>List of one or more column names in <span className="em arg">tableName\_</span> for which to collect statistics (cardinality, mean value, etc.). A single entry of '\*' expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped). </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>
                <td>Optional parameters. 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/collect__statistics_8h_source#l00053">53</a> of file <a className="el" href="/content/api/cpp/collect__statistics_8h_source">collect\_statistics.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>List of one or more column names in <a className="el" href="#a85b887306871ab139f94a49b7eb92daf">tableName</a> for which to collect statistics (cardinality, mean value, etc.). </p>
        <p>A single entry of '\*' expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped). </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/collect__statistics_8h_source#l00076">76</a> of file <a className="el" href="/content/api/cpp/collect__statistics_8h_source">collect\_statistics.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aad288b63c5424b999cbaabcf6c61a4de">◆ </a></span>options</h2>

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

      <div className="memdoc">
        <p>Optional parameters. </p>
        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/collect__statistics_8h_source#l00081">81</a> of file <a className="el" href="/content/api/cpp/collect__statistics_8h_source">collect\_statistics.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a85b887306871ab139f94a49b7eb92daf">◆ </a></span>tableName</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CollectStatisticsRequest::tableName</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of a table, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </p>
        <p>Must be an existing table. A value of '\*' collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, <a className="el" href="#a4a59cdf8e2992dce05be1e5e0e0ab04e">columnNames</a> must be '\*'. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/collect__statistics_8h_source#l00068">68</a> of file <a className="el" href="/content/api/cpp/collect__statistics_8h_source">collect\_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/collect__statistics_8h_source">collect\_statistics.h</a></li>
    </ul>
  </div>
</div>