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

# aggregateHistogram

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

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

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname"><a className="el" href="/content/api/cs/classkinetica_1_1AggregateHistogramResponse">AggregateHistogramResponse</a> kinetica.Kinetica.aggregateHistogram </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AggregateHistogramRequest">AggregateHistogramRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></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>Performs a histogram calculation given a table, a column, and an interval function. </p>
      <p>The <a className="el" href="/content/api/cs/classkinetica_1_1AggregateHistogramRequest#a72e7aa78ef8428301ed557fa72f664f2">interval</a> is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a>. In this latter case the sum of the values corresponding to the <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a> is used as the result instead. The total number of bins requested cannot exceed 10,000.</p>
      <p>NOTE: The <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a> instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a>. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L5144">5144</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a430eeae40653dc8a2562660caa7e31a7" />

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

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname"><a className="el" href="/content/api/cs/classkinetica_1_1AggregateHistogramResponse">AggregateHistogramResponse</a> kinetica.Kinetica.aggregateHistogram </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">table\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">column\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">double</td>
                <td className="paramname"><span className="paramname"><span className="em">start</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">double</td>
                <td className="paramname"><span className="paramname"><span className="em">end</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">double</td>
                <td className="paramname"><span className="paramname"><span className="em">interval</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</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>Performs a histogram calculation given a table, a column, and an interval function. </p>
      <p>The <span className="em">interval</span> is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a>. In this latter case the sum of the values corresponding to the <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a> is used as the result instead. The total number of bins requested cannot exceed 10,000.</p>
      <p>NOTE: The <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a> instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a>. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">table\_name</td>
              <td>Name of the table on which the operation will be performed. Must be an existing table, 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="paramname">column\_name</td>
              <td>Name of a column or an expression of one or more column names over which the histogram will be calculated.</td>
            </tr>

            <tr>
              <td className="paramname">start</td>
              <td>Lower end value of the histogram interval, inclusive.</td>
            </tr>

            <tr>
              <td className="paramname">end</td>
              <td>Upper end value of the histogram interval, inclusive. </td>
            </tr>

            <tr>
              <td className="paramname">interval</td>
              <td>The size of each bin within the start and end parameters.</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a>: The name of the column to use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float). </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#aa671d7f235143864055b156dd1c878b2">START</a>: The start parameter for char types. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#acbf9d73ebc9ee39592e64d7f4ad2ce6d">END</a>: The end parameter for char types. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1940ac05cb7bdb0dfe31eb658e82ea71">INTERVAL</a>: The interval parameter for char types. </li>
                </ul>

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

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L5249">5249</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="ad072ffb3d2eaf1f61185bd16bc61e690" />

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

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1AggregateHistogramResponse">AggregateHistogramResponse</a> > kinetica.Kinetica.AggregateHistogramAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AggregateHistogramRequest">AggregateHistogramRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Performs a histogram calculation given a table, a column, and an interval function. </p>
      <p>(async) </p>
      <p>The <a className="el" href="/content/api/cs/classkinetica_1_1AggregateHistogramRequest#a72e7aa78ef8428301ed557fa72f664f2">interval</a> is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a>. In this latter case the sum of the values corresponding to the <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a> is used as the result instead. The total number of bins requested cannot exceed 10,000.</p>
      <p>NOTE: The <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a> instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a>. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L5177">5177</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a72c05f0e2509d0a8bbade0cb280bcc77" />

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

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1AggregateHistogramResponse">AggregateHistogramResponse</a> > kinetica.Kinetica.AggregateHistogramAsync </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">table\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">column\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">double</td>
                <td className="paramname"><span className="paramname"><span className="em">start</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">double</td>
                <td className="paramname"><span className="paramname"><span className="em">end</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">double</td>
                <td className="paramname"><span className="paramname"><span className="em">interval</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Performs a histogram calculation given a table, a column, and an interval function. </p>
      <p>(async) </p>
      <p>The <span className="em">interval</span> is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a>. In this latter case the sum of the values corresponding to the <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a> is used as the result instead. The total number of bins requested cannot exceed 10,000.</p>
      <p>NOTE: The <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a> instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a>. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">table\_name</td>
              <td>Name of the table on which the operation will be performed. Must be an existing table, 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="paramname">column\_name</td>
              <td>Name of a column or an expression of one or more column names over which the histogram will be calculated.</td>
            </tr>

            <tr>
              <td className="paramname">start</td>
              <td>Lower end value of the histogram interval, inclusive.</td>
            </tr>

            <tr>
              <td className="paramname">end</td>
              <td>Upper end value of the histogram interval, inclusive. </td>
            </tr>

            <tr>
              <td className="paramname">interval</td>
              <td>The size of each bin within the start and end parameters.</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1e6547626070ded64a5d8a27d98a9978">VALUE\_COLUMN</a>: The name of the column to use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float). </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#aa671d7f235143864055b156dd1c878b2">START</a>: The start parameter for char types. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#acbf9d73ebc9ee39592e64d7f4ad2ce6d">END</a>: The end parameter for char types. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AggregateHistogramRequest_1_1Options#a1940ac05cb7bdb0dfe31eb658e82ea71">INTERVAL</a>: The interval parameter for char types. </li>
                </ul>

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

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L5327">5327</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>
</div>