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

> gpudb::AggregateGroupByRequest — 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#a76d7b0a4e087f94ccd17f65a38f3fc8e">GPUdb::aggregateGroupBy</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/aggregate__group__by_8h_source">gpudb/protocol/aggregate\_group\_by.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:abc1fd66434f221d550080140496382da" id="r_abc1fd66434f221d550080140496382da">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#abc1fd66434f221d550080140496382da">AggregateGroupByRequest</a> ()</td>
      </tr>

      <tr className="memdesc:abc1fd66434f221d550080140496382da">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AggregateGroupByRequest" title="A set of parameters for GPUdb::aggregateGroupBy.">AggregateGroupByRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:ae3890daf7cfcfba0c37e0c7c6d295818" id="r_ae3890daf7cfcfba0c37e0c7c6d295818">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ae3890daf7cfcfba0c37e0c7c6d295818">AggregateGroupByRequest</a> (const std::string \&tableName\_, const std::vector\< std::string > \&columnNames\_, const int64\_t offset\_, const int64\_t limit\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:ae3890daf7cfcfba0c37e0c7c6d295818">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AggregateGroupByRequest" title="A set of parameters for GPUdb::aggregateGroupBy.">AggregateGroupByRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

      <tr className="memitem:ac141893cc12c84d86fa92e089cd7029c" id="r_ac141893cc12c84d86fa92e089cd7029c">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ac141893cc12c84d86fa92e089cd7029c">AggregateGroupByRequest</a> (const std::string \&tableName\_, const std::vector\< std::string > \&columnNames\_, const int64\_t offset\_, const int64\_t limit\_, const std::string \&encoding\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:ac141893cc12c84d86fa92e089cd7029c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AggregateGroupByRequest" title="A set of parameters for GPUdb::aggregateGroupBy.">AggregateGroupByRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:ac141893cc12c84d86fa92e089cd7029c">
        <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:a7b3c931bcf74b32ea40f4e956889bf91" id="r_a7b3c931bcf74b32ea40f4e956889bf91">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7b3c931bcf74b32ea40f4e956889bf91">tableName</a></td>
      </tr>

      <tr className="memdesc:a7b3c931bcf74b32ea40f4e956889bf91">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of an existing table or view on which the operation will be performed, 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:a7b3c931bcf74b32ea40f4e956889bf91">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:a8e3cb49fb147d79eec5ec008d999a2cd">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">List of one or more column names, expressions, and aggregate expressions. <br /></td>
      </tr>

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

      <tr className="memitem:ad33d5ef5e1c47ab8c549ddad114ee63e" id="r_ad33d5ef5e1c47ab8c549ddad114ee63e">
        <td className="memItemLeft" align="right" valign="top">int64\_t </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ad33d5ef5e1c47ab8c549ddad114ee63e">offset</a></td>
      </tr>

      <tr className="memdesc:ad33d5ef5e1c47ab8c549ddad114ee63e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). <br /></td>
      </tr>

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

      <tr className="memitem:a5765d2623bfa7ac83104f43748a8bcb1" id="r_a5765d2623bfa7ac83104f43748a8bcb1">
        <td className="memItemLeft" align="right" valign="top">int64\_t </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a5765d2623bfa7ac83104f43748a8bcb1">limit</a></td>
      </tr>

      <tr className="memdesc:a5765d2623bfa7ac83104f43748a8bcb1">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A positive integer indicating the maximum number of results to be returned, or END\_OF\_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a8a3c64e9b9ff9abc201731e54146393d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Specifies the encoding for returned records. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a7fb83ff0c7bd454e13268cdfb9c81db4">
        <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#a76d7b0a4e087f94ccd17f65a38f3fc8e">GPUdb::aggregateGroupBy</a>. </p>
      <p>Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination. This is somewhat analogous to an SQL-style SELECT...GROUP BY.</p>
      <p>For aggregation details and examples, see <a href="/content/concepts/aggregation/" target="_top">Aggregation</a>. For limitations, see <a href="/content/concepts/aggregation/#limitations" target="_top">Aggregation Limitations</a>.</p>
      <p>Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates.</p>
      <p>The results can be paged via the <a className="el" href="#ad33d5ef5e1c47ab8c549ddad114ee63e">offset</a> and <a className="el" href="#a5765d2623bfa7ac83104f43748a8bcb1">limit</a> parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"{"}"sort\_order":"descending", "sort\_by":"value"{"}"}.</p>
      <p><a className="el" href="#a7fb83ff0c7bd454e13268cdfb9c81db4">options</a> can be used to customize behavior of this call e.g. filtering or sorting the results.</p>
      <p>To group by columns 'x' and 'y' and compute the number of objects within each group, use: column\_names=\['x','y','count(\*)'].</p>
      <p>To also compute the sum of 'z' over each group, use: column\_names=\['x','y','count(\*)','sum(z)'].</p>
      <p>Available <a href="/content/concepts/expressions/#aggregate-expressions" target="_top">aggregation functions</a> are: count(\*), sum, min, max, avg, mean, stddev, stddev\_pop, stddev\_samp, var, var\_pop, var\_samp, arg\_min, arg\_max and count\_distinct.</p>
      <p>Available grouping functions are <a href="/content/concepts/rollup/" target="_top">Rollup</a>, <a href="/content/concepts/cube/" target="_top">Cube</a>, and <a href="/content/concepts/grouping_sets/" target="_top">Grouping Sets</a></p>
      <p>This service also provides support for <a href="/content/concepts/pivot/" target="_top">Pivot</a> operations.</p>
      <p>Filtering on aggregates is supported via expressions using <a href="/content/concepts/expressions/#aggregate-expressions" target="_top">aggregation functions</a> supplied to <a className="el" href="/content/api/cpp/namespacegpudb#ad1ab7a16358f987414622becec705d1f">having</a>.</p>
      <p>The response is returned as a dynamic schema. For details see: <a href="/content/api/concepts/#dynamic-schemas" target="_top">dynamic schemas documentation</a>.</p>
      <p>If a <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> name is specified in the <a className="el" href="#a7fb83ff0c7bd454e13268cdfb9c81db4">options</a>, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to <a href="/content/concepts/tables/#table" target="_top">standard naming conventions</a>; column/aggregation expressions will need to be aliased. If the source table's <a href="/content/concepts/tables/#shard-keys" target="_top">shard key</a> is used as the grouping column(s) and all result records are selected (<a className="el" href="#ad33d5ef5e1c47ab8c549ddad114ee63e">offset</a> is 0 and <a className="el" href="#a5765d2623bfa7ac83104f43748a8bcb1">limit</a> is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of <a className="el" href="#a8e3cb49fb147d79eec5ec008d999a2cd">columnNames</a> is an unrestricted-length string. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source#l00083">83</a> of file <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source">aggregate\_group\_by.h</a>.</p>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::AggregateGroupByRequest::AggregateGroupByRequest </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 an <a className="el" href="/content/api/cpp/structgpudb_1_1AggregateGroupByRequest" title="A set of parameters for GPUdb::aggregateGroupBy.">AggregateGroupByRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source#l00089">89</a> of file <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source">aggregate\_group\_by.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::AggregateGroupByRequest::AggregateGroupByRequest </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 int64\_t</td>
                  <td className="paramname"><span className="paramname"><span className="em">offset\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const int64\_t</td>
                  <td className="paramname"><span className="paramname"><span className="em">limit\_</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 an <a className="el" href="/content/api/cpp/structgpudb_1_1AggregateGroupByRequest" title="A set of parameters for GPUdb::aggregateGroupBy.">AggregateGroupByRequest</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 an existing table or view on which the operation will be performed, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">columnNames\_</td>
                <td>List of one or more column names, expressions, and aggregate expressions. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">offset\_</td>
                <td>A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX\_INT. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">limit\_</td>
                <td>A positive integer indicating the maximum number of results to be returned, or END\_OF\_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the <a href="/content/config/#config-main-general" target="_top">max\_get\_records\_size</a> parameter in the server configuration. Use <a className="el" href="/content/api/cpp/structgpudb_1_1RawAggregateGroupByResponse#ae76c8102a9ebe81fbfe43a04abfe8ada">hasMoreRecords</a> to see if more records exist in the result to be fetched, and <span className="em arg">offset\_</span> and <span className="em arg">limit\_</span> to request subsequent pages of results. The default value is -9999. </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#aa908254d090a87fb897ac0e6dd799163">aggregate\_group\_by\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a>. If <a className="el" href="/content/api/cpp/namespacegpudb#abcbd77d1cdc4e52ecc7b6469bedf5b09">result\_table\_persist</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">false</a> (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a className="el" href="/content/api/cpp/namespacegpudb#a12dc6d6449d7b963ee16706c1a91f08e">qualified\_result\_table\_name</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ccb9fa34308f0415ffd88c3bf069061">aggregate\_group\_by\_collection\_name</a>: \[DEPRECATED–please specify the containing schema as part of <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> and use <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a4aa5990ebebfab30b5961654f546cfd0">GPUdb::createSchema</a> to create the schema if non-existent] Name of a schema which is to contain the table specified in <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a>. If the schema provided is non-existent, it will be automatically created. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#af2c22ab3a12dd44da0c9dc5d26bd453c">aggregate\_group\_by\_expression</a>: Filter expression to apply to the table prior to computing the aggregate group by. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a03b07311fd52d5dff96e305b97a25f30">aggregate\_group\_by\_pipelined\_expression\_evaluation</a>: Evaluate the group-by during last JoinedSet filter plan step. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad1ab7a16358f987414622becec705d1f">aggregate\_group\_by\_having</a>: Filter expression to apply to the aggregated results. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#af106cf07673464dc15d91abbea82799b">aggregate\_group\_by\_sort\_order</a>: \[DEPRECATED–use order\_by instead] String indicating how the returned values should be sorted - ascending or descending. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a28c767d89d2965c6102e89152feb80aa">aggregate\_group\_by\_ascending</a>: Indicates that the returned values should be sorted in ascending order. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1b2fcf7cfa472b96e381ce240b4a3be9">aggregate\_group\_by\_descending</a>: Indicates that the returned values should be sorted in descending order. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a28c767d89d2965c6102e89152feb80aa">aggregate\_group\_by\_ascending</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a36c24d2770a28810482273a91f22fd4a">aggregate\_group\_by\_sort\_by</a>: \[DEPRECATED–use order\_by instead] String determining how the results are sorted. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad7d16752100c9f83d593b34ccb5607fd">aggregate\_group\_by\_key</a>: Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4cd65fb3dc2adc11f3530ec064aa1017">aggregate\_group\_by\_value</a>: Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a4cd65fb3dc2adc11f3530ec064aa1017">aggregate\_group\_by\_value</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#aae3b9fc5c92010497e01226cffd66d35">aggregate\_group\_by\_order\_by</a>: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a786d7acc46f0e596916684816fe99ac9">aggregate\_group\_by\_strategy\_definition</a>: The <a href="/content/rm/concepts/#tier-strategies" target="_top">tier strategy</a> for the table and its columns. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a283bf5545e1025a627ffc16bb45fbb5c">aggregate\_group\_by\_compression\_codec</a>: The default <a href="/content/concepts/column_compression/" target="_top">compression codec</a> for the result table's columns. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">aggregate\_group\_by\_result\_table</a>: The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. Column names (group-by and aggregate fields) need to be given aliases e.g. \["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#abcbd77d1cdc4e52ecc7b6469bedf5b09">aggregate\_group\_by\_result\_table\_persist</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a>, then the result table specified in <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> will be persisted and will not expire unless a <a className="el" href="/content/api/cpp/namespacegpudb#ac183c4d55c255403e1ee55e4260428f3">ttl</a> is specified. If <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">false</a>, then the result table will be an in-memory table and will expire unless a <a className="el" href="/content/api/cpp/namespacegpudb#ac183c4d55c255403e1ee55e4260428f3">ttl</a> is specified otherwise. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#ad1ef320a0013f97a4309b95ff137e493">aggregate\_group\_by\_result\_table\_force\_replicated</a>: Force the result table to be replicated (ignores any sharding). Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#af1498816dff4937520b8e577e239e27c">aggregate\_group\_by\_result\_table\_generate\_pk</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a> then set a primary key for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a1a83f1c180921c89f9f6fe4350a536fd">aggregate\_group\_by\_result\_table\_generate\_soft\_pk</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a> then set a soft primary key for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac183c4d55c255403e1ee55e4260428f3">aggregate\_group\_by\_ttl</a>: Sets the <a href="/content/concepts/ttl/" target="_top">TTL</a> of the table specified in <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#aef9f514701414d995d637921a4ade049">aggregate\_group\_by\_chunk\_size</a>: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab1feac29a89a52bf764820cffea46386">aggregate\_group\_by\_chunk\_column\_max\_memory</a>: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0b3e0377408de3b05d255b3edc96a976">aggregate\_group\_by\_chunk\_max\_memory</a>: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4434c96644b582233256b0522540328a">aggregate\_group\_by\_create\_indexes</a>: Comma-separated list of columns on which to create indexes on the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a0d751187efd41272bee0792978077474">aggregate\_group\_by\_partition\_type</a>: <a href="/content/concepts/tables/#partitioning" target="_top">Partitioning</a> scheme to use for the result table. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a26d5fcfc9ea825b8651ec9e317d1528a">aggregate\_group\_by\_RANGE</a>: Use <a href="/content/concepts/tables/#partitioning-by-range" target="_top">range partitioning</a>. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aaee302741e22b596dc37c0c3a8ec06bb">aggregate\_group\_by\_INTERVAL</a>: Use <a href="/content/concepts/tables/#partitioning-by-interval" target="_top">interval partitioning</a>. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae6d45ba2892299ea06d9192ed7e1496d">aggregate\_group\_by\_LIST</a>: Use <a href="/content/concepts/tables/#partitioning-by-list" target="_top">list partitioning</a>. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#afb419421315aed861fece8885a7feca7">aggregate\_group\_by\_HASH</a>: Use <a href="/content/concepts/tables/#partitioning-by-hash" target="_top">hash partitioning</a>. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a661cf72cfc6a6377ca43d225353f7551">aggregate\_group\_by\_SERIES</a>: Use <a href="/content/concepts/tables/#partitioning-by-series" target="_top">series partitioning</a>. </li>
                      </ul>
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0d25c08cb801736db8117ff232ef56c7">aggregate\_group\_by\_partition\_keys</a>: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by <a className="el" href="/content/api/cpp/namespacegpudb#a63df0982814374c894dae665d26956b1">partition\_definitions</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a63df0982814374c894dae665d26956b1">aggregate\_group\_by\_partition\_definitions</a>: Comma-separated list of partition definitions, whose format depends on the choice of <a className="el" href="/content/api/cpp/namespacegpudb#a0d751187efd41272bee0792978077474">partition\_type</a>. See <a href="/content/concepts/tables/#partitioning-by-range" target="_top">range partitioning</a>, <a href="/content/concepts/tables/#partitioning-by-interval" target="_top">interval partitioning</a>, <a href="/content/concepts/tables/#partitioning-by-list" target="_top">list partitioning</a>, <a href="/content/concepts/tables/#partitioning-by-hash" target="_top">hash partitioning</a>, or <a href="/content/concepts/tables/#partitioning-by-series" target="_top">series partitioning</a> for example formats. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a1720f952b51372d743a2b70f77f6363d">aggregate\_group\_by\_is\_automatic\_partition</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a>, a new partition will be created for values which don't fall into an existing partition. Currently only supported for <a href="/content/concepts/tables/#partitioning-by-list" target="_top">list partitions</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad0d9e690e51f3a9e8fa8349e630bfb2b">aggregate\_group\_by\_view\_id</a>: ID of view of which the result table will be a member. The default value is ''. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a13aa63edf5b20c7afd14622c3779902a">aggregate\_group\_by\_pivot</a>: Pivot column. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad3557de9a0528c4d28c4f9d894d14cea">aggregate\_group\_by\_pivot\_values</a>: Comma-separated list of the values in the <a className="el" href="/content/api/cpp/namespacegpudb#a13aa63edf5b20c7afd14622c3779902a">pivot</a> column. The list provided will become the column header prefixes in the output. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a63a1dc780a0cce215e53547eb67e893e">aggregate\_group\_by\_grouping\_sets</a>: Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operators. The attribute sets should be enclosed in parentheses and can include composite attributes. All attributes specified in the grouping sets must present in the group-by attributes. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a58b20054eea24b15d459d3ccb77ec5a2">aggregate\_group\_by\_rollup</a>: This option is used to specify the multilevel aggregates. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#aab3a0075e85f3ac610e4ef828310b5c8">aggregate\_group\_by\_cube</a>: This option is used to specify the multidimensional aggregates. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1bcc92e6da4ee16c160d648cd4356984">aggregate\_group\_by\_shard\_key</a>: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in <span className="em arg">columnNames\_</span>. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''. </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/aggregate__group__by_8h_source#l00583">583</a> of file <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source">aggregate\_group\_by.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::AggregateGroupByRequest::AggregateGroupByRequest </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 int64\_t</td>
                  <td className="paramname"><span className="paramname"><span className="em">offset\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const int64\_t</td>
                  <td className="paramname"><span className="paramname"><span className="em">limit\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">encoding\_</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 an <a className="el" href="/content/api/cpp/structgpudb_1_1AggregateGroupByRequest" title="A set of parameters for GPUdb::aggregateGroupBy.">AggregateGroupByRequest</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 an existing table or view on which the operation will be performed, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">columnNames\_</td>
                <td>List of one or more column names, expressions, and aggregate expressions. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">offset\_</td>
                <td>A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX\_INT. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">limit\_</td>
                <td>A positive integer indicating the maximum number of results to be returned, or END\_OF\_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the <a href="/content/config/#config-main-general" target="_top">max\_get\_records\_size</a> parameter in the server configuration. Use <a className="el" href="/content/api/cpp/structgpudb_1_1RawAggregateGroupByResponse#ae76c8102a9ebe81fbfe43a04abfe8ada">hasMoreRecords</a> to see if more records exist in the result to be fetched, and <span className="em arg">offset\_</span> and <span className="em arg">limit\_</span> to request subsequent pages of results. The default value is -9999. </td>
              </tr>

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

                <td>
                  Specifies the encoding for returned records. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#adb0fc9035fc18baf1060d97502b44aad">aggregate\_group\_by\_binary</a>: Indicates that the returned records should be binary encoded. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#af6198e9eb36bed744d8498466a0b5851">aggregate\_group\_by\_json</a>: Indicates that the returned records should be JSON-encoded. </li>
                  </ul>

                  The default value is <a className="el" href="/content/api/cpp/namespacegpudb#adb0fc9035fc18baf1060d97502b44aad">aggregate\_group\_by\_binary</a>.
                </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#aa908254d090a87fb897ac0e6dd799163">aggregate\_group\_by\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a>. If <a className="el" href="/content/api/cpp/namespacegpudb#abcbd77d1cdc4e52ecc7b6469bedf5b09">result\_table\_persist</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">false</a> (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a className="el" href="/content/api/cpp/namespacegpudb#a12dc6d6449d7b963ee16706c1a91f08e">qualified\_result\_table\_name</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ccb9fa34308f0415ffd88c3bf069061">aggregate\_group\_by\_collection\_name</a>: \[DEPRECATED–please specify the containing schema as part of <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> and use <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a4aa5990ebebfab30b5961654f546cfd0">GPUdb::createSchema</a> to create the schema if non-existent] Name of a schema which is to contain the table specified in <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a>. If the schema provided is non-existent, it will be automatically created. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#af2c22ab3a12dd44da0c9dc5d26bd453c">aggregate\_group\_by\_expression</a>: Filter expression to apply to the table prior to computing the aggregate group by. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a03b07311fd52d5dff96e305b97a25f30">aggregate\_group\_by\_pipelined\_expression\_evaluation</a>: Evaluate the group-by during last JoinedSet filter plan step. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad1ab7a16358f987414622becec705d1f">aggregate\_group\_by\_having</a>: Filter expression to apply to the aggregated results. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#af106cf07673464dc15d91abbea82799b">aggregate\_group\_by\_sort\_order</a>: \[DEPRECATED–use order\_by instead] String indicating how the returned values should be sorted - ascending or descending. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a28c767d89d2965c6102e89152feb80aa">aggregate\_group\_by\_ascending</a>: Indicates that the returned values should be sorted in ascending order. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1b2fcf7cfa472b96e381ce240b4a3be9">aggregate\_group\_by\_descending</a>: Indicates that the returned values should be sorted in descending order. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a28c767d89d2965c6102e89152feb80aa">aggregate\_group\_by\_ascending</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a36c24d2770a28810482273a91f22fd4a">aggregate\_group\_by\_sort\_by</a>: \[DEPRECATED–use order\_by instead] String determining how the results are sorted. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad7d16752100c9f83d593b34ccb5607fd">aggregate\_group\_by\_key</a>: Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4cd65fb3dc2adc11f3530ec064aa1017">aggregate\_group\_by\_value</a>: Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a4cd65fb3dc2adc11f3530ec064aa1017">aggregate\_group\_by\_value</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#aae3b9fc5c92010497e01226cffd66d35">aggregate\_group\_by\_order\_by</a>: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a786d7acc46f0e596916684816fe99ac9">aggregate\_group\_by\_strategy\_definition</a>: The <a href="/content/rm/concepts/#tier-strategies" target="_top">tier strategy</a> for the table and its columns. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a283bf5545e1025a627ffc16bb45fbb5c">aggregate\_group\_by\_compression\_codec</a>: The default <a href="/content/concepts/column_compression/" target="_top">compression codec</a> for the result table's columns. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">aggregate\_group\_by\_result\_table</a>: The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. Column names (group-by and aggregate fields) need to be given aliases e.g. \["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#abcbd77d1cdc4e52ecc7b6469bedf5b09">aggregate\_group\_by\_result\_table\_persist</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a>, then the result table specified in <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> will be persisted and will not expire unless a <a className="el" href="/content/api/cpp/namespacegpudb#ac183c4d55c255403e1ee55e4260428f3">ttl</a> is specified. If <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">false</a>, then the result table will be an in-memory table and will expire unless a <a className="el" href="/content/api/cpp/namespacegpudb#ac183c4d55c255403e1ee55e4260428f3">ttl</a> is specified otherwise. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#ad1ef320a0013f97a4309b95ff137e493">aggregate\_group\_by\_result\_table\_force\_replicated</a>: Force the result table to be replicated (ignores any sharding). Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#af1498816dff4937520b8e577e239e27c">aggregate\_group\_by\_result\_table\_generate\_pk</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a> then set a primary key for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a1a83f1c180921c89f9f6fe4350a536fd">aggregate\_group\_by\_result\_table\_generate\_soft\_pk</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a> then set a soft primary key for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac183c4d55c255403e1ee55e4260428f3">aggregate\_group\_by\_ttl</a>: Sets the <a href="/content/concepts/ttl/" target="_top">TTL</a> of the table specified in <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#aef9f514701414d995d637921a4ade049">aggregate\_group\_by\_chunk\_size</a>: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab1feac29a89a52bf764820cffea46386">aggregate\_group\_by\_chunk\_column\_max\_memory</a>: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0b3e0377408de3b05d255b3edc96a976">aggregate\_group\_by\_chunk\_max\_memory</a>: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4434c96644b582233256b0522540328a">aggregate\_group\_by\_create\_indexes</a>: Comma-separated list of columns on which to create indexes on the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a0d751187efd41272bee0792978077474">aggregate\_group\_by\_partition\_type</a>: <a href="/content/concepts/tables/#partitioning" target="_top">Partitioning</a> scheme to use for the result table. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a26d5fcfc9ea825b8651ec9e317d1528a">aggregate\_group\_by\_RANGE</a>: Use <a href="/content/concepts/tables/#partitioning-by-range" target="_top">range partitioning</a>. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aaee302741e22b596dc37c0c3a8ec06bb">aggregate\_group\_by\_INTERVAL</a>: Use <a href="/content/concepts/tables/#partitioning-by-interval" target="_top">interval partitioning</a>. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae6d45ba2892299ea06d9192ed7e1496d">aggregate\_group\_by\_LIST</a>: Use <a href="/content/concepts/tables/#partitioning-by-list" target="_top">list partitioning</a>. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#afb419421315aed861fece8885a7feca7">aggregate\_group\_by\_HASH</a>: Use <a href="/content/concepts/tables/#partitioning-by-hash" target="_top">hash partitioning</a>. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a661cf72cfc6a6377ca43d225353f7551">aggregate\_group\_by\_SERIES</a>: Use <a href="/content/concepts/tables/#partitioning-by-series" target="_top">series partitioning</a>. </li>
                      </ul>
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0d25c08cb801736db8117ff232ef56c7">aggregate\_group\_by\_partition\_keys</a>: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by <a className="el" href="/content/api/cpp/namespacegpudb#a63df0982814374c894dae665d26956b1">partition\_definitions</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a63df0982814374c894dae665d26956b1">aggregate\_group\_by\_partition\_definitions</a>: Comma-separated list of partition definitions, whose format depends on the choice of <a className="el" href="/content/api/cpp/namespacegpudb#a0d751187efd41272bee0792978077474">partition\_type</a>. See <a href="/content/concepts/tables/#partitioning-by-range" target="_top">range partitioning</a>, <a href="/content/concepts/tables/#partitioning-by-interval" target="_top">interval partitioning</a>, <a href="/content/concepts/tables/#partitioning-by-list" target="_top">list partitioning</a>, <a href="/content/concepts/tables/#partitioning-by-hash" target="_top">hash partitioning</a>, or <a href="/content/concepts/tables/#partitioning-by-series" target="_top">series partitioning</a> for example formats. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a1720f952b51372d743a2b70f77f6363d">aggregate\_group\_by\_is\_automatic\_partition</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a>, a new partition will be created for values which don't fall into an existing partition. Currently only supported for <a href="/content/concepts/tables/#partitioning-by-list" target="_top">list partitions</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad0d9e690e51f3a9e8fa8349e630bfb2b">aggregate\_group\_by\_view\_id</a>: ID of view of which the result table will be a member. The default value is ''. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a13aa63edf5b20c7afd14622c3779902a">aggregate\_group\_by\_pivot</a>: Pivot column. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad3557de9a0528c4d28c4f9d894d14cea">aggregate\_group\_by\_pivot\_values</a>: Comma-separated list of the values in the <a className="el" href="/content/api/cpp/namespacegpudb#a13aa63edf5b20c7afd14622c3779902a">pivot</a> column. The list provided will become the column header prefixes in the output. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a63a1dc780a0cce215e53547eb67e893e">aggregate\_group\_by\_grouping\_sets</a>: Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operators. The attribute sets should be enclosed in parentheses and can include composite attributes. All attributes specified in the grouping sets must present in the group-by attributes. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a58b20054eea24b15d459d3ccb77ec5a2">aggregate\_group\_by\_rollup</a>: This option is used to specify the multilevel aggregates. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#aab3a0075e85f3ac610e4ef828310b5c8">aggregate\_group\_by\_cube</a>: This option is used to specify the multidimensional aggregates. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1bcc92e6da4ee16c160d648cd4356984">aggregate\_group\_by\_shard\_key</a>: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in <span className="em arg">columnNames\_</span>. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''. </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/aggregate__group__by_8h_source#l01092">1092</a> of file <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source">aggregate\_group\_by.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>List of one or more column names, expressions, and aggregate expressions. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source#l01114">1114</a> of file <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source">aggregate\_group\_by.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a8a3c64e9b9ff9abc201731e54146393d">◆ </a></span>encoding</h2>

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

      <div className="memdoc">
        <p>Specifies the encoding for returned records. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#adb0fc9035fc18baf1060d97502b44aad">aggregate\_group\_by\_binary</a>: Indicates that the returned records should be binary encoded. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#af6198e9eb36bed744d8498466a0b5851">aggregate\_group\_by\_json</a>: Indicates that the returned records should be JSON-encoded. </li>
        </ul>

        <p>The default value is <a className="el" href="/content/api/cpp/namespacegpudb#adb0fc9035fc18baf1060d97502b44aad">aggregate\_group\_by\_binary</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source#l01153">1153</a> of file <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source">aggregate\_group\_by.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a5765d2623bfa7ac83104f43748a8bcb1">◆ </a></span>limit</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">int64\_t gpudb::AggregateGroupByRequest::limit</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A positive integer indicating the maximum number of results to be returned, or END\_OF\_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. </p>
        <p>The number of records returned will never exceed the server's own limit, defined by the <a href="/content/config/#config-main-general" target="_top">max\_get\_records\_size</a> parameter in the server configuration. Use <a className="el" href="/content/api/cpp/structgpudb_1_1RawAggregateGroupByResponse#ae76c8102a9ebe81fbfe43a04abfe8ada">hasMoreRecords</a> to see if more records exist in the result to be fetched, and <a className="el" href="#ad33d5ef5e1c47ab8c549ddad114ee63e">offset</a> and <a className="el" href="#a5765d2623bfa7ac83104f43748a8bcb1">limit</a> to request subsequent pages of results. The default value is -9999. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source#l01137">1137</a> of file <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source">aggregate\_group\_by.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ad33d5ef5e1c47ab8c549ddad114ee63e">◆ </a></span>offset</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">int64\_t gpudb::AggregateGroupByRequest::offset</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). </p>
        <p>The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX\_INT. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source#l01122">1122</a> of file <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source">aggregate\_group\_by.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#aa908254d090a87fb897ac0e6dd799163">aggregate\_group\_by\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a>. If <a className="el" href="/content/api/cpp/namespacegpudb#abcbd77d1cdc4e52ecc7b6469bedf5b09">result\_table\_persist</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">false</a> (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a className="el" href="/content/api/cpp/namespacegpudb#a12dc6d6449d7b963ee16706c1a91f08e">qualified\_result\_table\_name</a>. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ccb9fa34308f0415ffd88c3bf069061">aggregate\_group\_by\_collection\_name</a>: \[DEPRECATED–please specify the containing schema as part of <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> and use <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a4aa5990ebebfab30b5961654f546cfd0">GPUdb::createSchema</a> to create the schema if non-existent] Name of a schema which is to contain the table specified in <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a>. If the schema provided is non-existent, it will be automatically created. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#af2c22ab3a12dd44da0c9dc5d26bd453c">aggregate\_group\_by\_expression</a>: Filter expression to apply to the table prior to computing the aggregate group by. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a03b07311fd52d5dff96e305b97a25f30">aggregate\_group\_by\_pipelined\_expression\_evaluation</a>: Evaluate the group-by during last JoinedSet filter plan step. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad1ab7a16358f987414622becec705d1f">aggregate\_group\_by\_having</a>: Filter expression to apply to the aggregated results. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#af106cf07673464dc15d91abbea82799b">aggregate\_group\_by\_sort\_order</a>: \[DEPRECATED–use order\_by instead] String indicating how the returned values should be sorted - ascending or descending. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a28c767d89d2965c6102e89152feb80aa">aggregate\_group\_by\_ascending</a>: Indicates that the returned values should be sorted in ascending order. </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1b2fcf7cfa472b96e381ce240b4a3be9">aggregate\_group\_by\_descending</a>: Indicates that the returned values should be sorted in descending order. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a28c767d89d2965c6102e89152feb80aa">aggregate\_group\_by\_ascending</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a36c24d2770a28810482273a91f22fd4a">aggregate\_group\_by\_sort\_by</a>: \[DEPRECATED–use order\_by instead] String determining how the results are sorted. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad7d16752100c9f83d593b34ccb5607fd">aggregate\_group\_by\_key</a>: Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc. </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4cd65fb3dc2adc11f3530ec064aa1017">aggregate\_group\_by\_value</a>: Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a4cd65fb3dc2adc11f3530ec064aa1017">aggregate\_group\_by\_value</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#aae3b9fc5c92010497e01226cffd66d35">aggregate\_group\_by\_order\_by</a>: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a786d7acc46f0e596916684816fe99ac9">aggregate\_group\_by\_strategy\_definition</a>: The <a href="/content/rm/concepts/#tier-strategies" target="_top">tier strategy</a> for the table and its columns. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a283bf5545e1025a627ffc16bb45fbb5c">aggregate\_group\_by\_compression\_codec</a>: The default <a href="/content/concepts/column_compression/" target="_top">compression codec</a> for the result table's columns. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">aggregate\_group\_by\_result\_table</a>: The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. Column names (group-by and aggregate fields) need to be given aliases e.g. \["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#abcbd77d1cdc4e52ecc7b6469bedf5b09">aggregate\_group\_by\_result\_table\_persist</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a>, then the result table specified in <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> will be persisted and will not expire unless a <a className="el" href="/content/api/cpp/namespacegpudb#ac183c4d55c255403e1ee55e4260428f3">ttl</a> is specified. If <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">false</a>, then the result table will be an in-memory table and will expire unless a <a className="el" href="/content/api/cpp/namespacegpudb#ac183c4d55c255403e1ee55e4260428f3">ttl</a> is specified otherwise. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#ad1ef320a0013f97a4309b95ff137e493">aggregate\_group\_by\_result\_table\_force\_replicated</a>: Force the result table to be replicated (ignores any sharding). Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#af1498816dff4937520b8e577e239e27c">aggregate\_group\_by\_result\_table\_generate\_pk</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a> then set a primary key for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a1a83f1c180921c89f9f6fe4350a536fd">aggregate\_group\_by\_result\_table\_generate\_soft\_pk</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a> then set a soft primary key for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac183c4d55c255403e1ee55e4260428f3">aggregate\_group\_by\_ttl</a>: Sets the <a href="/content/concepts/ttl/" target="_top">TTL</a> of the table specified in <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a>. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#aef9f514701414d995d637921a4ade049">aggregate\_group\_by\_chunk\_size</a>: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab1feac29a89a52bf764820cffea46386">aggregate\_group\_by\_chunk\_column\_max\_memory</a>: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0b3e0377408de3b05d255b3edc96a976">aggregate\_group\_by\_chunk\_max\_memory</a>: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4434c96644b582233256b0522540328a">aggregate\_group\_by\_create\_indexes</a>: Comma-separated list of columns on which to create indexes on the result table. Must be used in combination with the <a className="el" href="/content/api/cpp/namespacegpudb#a74372aa877ab6529947b269da9d4ae00">result\_table</a> option. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a0d751187efd41272bee0792978077474">aggregate\_group\_by\_partition\_type</a>: <a href="/content/concepts/tables/#partitioning" target="_top">Partitioning</a> scheme to use for the result table. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a26d5fcfc9ea825b8651ec9e317d1528a">aggregate\_group\_by\_RANGE</a>: Use <a href="/content/concepts/tables/#partitioning-by-range" target="_top">range partitioning</a>. </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aaee302741e22b596dc37c0c3a8ec06bb">aggregate\_group\_by\_INTERVAL</a>: Use <a href="/content/concepts/tables/#partitioning-by-interval" target="_top">interval partitioning</a>. </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae6d45ba2892299ea06d9192ed7e1496d">aggregate\_group\_by\_LIST</a>: Use <a href="/content/concepts/tables/#partitioning-by-list" target="_top">list partitioning</a>. </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#afb419421315aed861fece8885a7feca7">aggregate\_group\_by\_HASH</a>: Use <a href="/content/concepts/tables/#partitioning-by-hash" target="_top">hash partitioning</a>. </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a661cf72cfc6a6377ca43d225353f7551">aggregate\_group\_by\_SERIES</a>: Use <a href="/content/concepts/tables/#partitioning-by-series" target="_top">series partitioning</a>. </li>
            </ul>
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0d25c08cb801736db8117ff232ef56c7">aggregate\_group\_by\_partition\_keys</a>: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by <a className="el" href="/content/api/cpp/namespacegpudb#a63df0982814374c894dae665d26956b1">partition\_definitions</a>. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a63df0982814374c894dae665d26956b1">aggregate\_group\_by\_partition\_definitions</a>: Comma-separated list of partition definitions, whose format depends on the choice of <a className="el" href="/content/api/cpp/namespacegpudb#a0d751187efd41272bee0792978077474">partition\_type</a>. See <a href="/content/concepts/tables/#partitioning-by-range" target="_top">range partitioning</a>, <a href="/content/concepts/tables/#partitioning-by-interval" target="_top">interval partitioning</a>, <a href="/content/concepts/tables/#partitioning-by-list" target="_top">list partitioning</a>, <a href="/content/concepts/tables/#partitioning-by-hash" target="_top">hash partitioning</a>, or <a href="/content/concepts/tables/#partitioning-by-series" target="_top">series partitioning</a> for example formats. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a1720f952b51372d743a2b70f77f6363d">aggregate\_group\_by\_is\_automatic\_partition</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">true</a>, a new partition will be created for values which don't fall into an existing partition. Currently only supported for <a href="/content/concepts/tables/#partitioning-by-list" target="_top">list partitions</a>. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5ad437d851707f2d854e8a6351cc963a">aggregate\_group\_by\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a405aa11a3bdf26b1dcacd96cbb6e403e">aggregate\_group\_by\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad0d9e690e51f3a9e8fa8349e630bfb2b">aggregate\_group\_by\_view\_id</a>: ID of view of which the result table will be a member. The default value is ''. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a13aa63edf5b20c7afd14622c3779902a">aggregate\_group\_by\_pivot</a>: Pivot column. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad3557de9a0528c4d28c4f9d894d14cea">aggregate\_group\_by\_pivot\_values</a>: Comma-separated list of the values in the <a className="el" href="/content/api/cpp/namespacegpudb#a13aa63edf5b20c7afd14622c3779902a">pivot</a> column. The list provided will become the column header prefixes in the output. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a63a1dc780a0cce215e53547eb67e893e">aggregate\_group\_by\_grouping\_sets</a>: Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operators. The attribute sets should be enclosed in parentheses and can include composite attributes. All attributes specified in the grouping sets must present in the group-by attributes. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a58b20054eea24b15d459d3ccb77ec5a2">aggregate\_group\_by\_rollup</a>: This option is used to specify the multilevel aggregates. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#aab3a0075e85f3ac610e4ef828310b5c8">aggregate\_group\_by\_cube</a>: This option is used to specify the multidimensional aggregates. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1bcc92e6da4ee16c160d648cd4356984">aggregate\_group\_by\_shard\_key</a>: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in <a className="el" href="#a8e3cb49fb147d79eec5ec008d999a2cd">columnNames</a>. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source#l01469">1469</a> of file <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source">aggregate\_group\_by.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of an existing table or view on which the operation will be performed, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source#l01108">1108</a> of file <a className="el" href="/content/api/cpp/aggregate__group__by_8h_source">aggregate\_group\_by.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/aggregate__group__by_8h_source">aggregate\_group\_by.h</a></li>
    </ul>
  </div>
</div>