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

> gpudb::GetRecordsRequest — 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#a32de6c3fa89b56e5c573cf04bbbafabb">GPUdb::getRecords</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/get__records_8h_source">gpudb/protocol/get\_records.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:aeb1e7acce947f837d3988dd35a79cf47" id="r_aeb1e7acce947f837d3988dd35a79cf47">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aeb1e7acce947f837d3988dd35a79cf47">GetRecordsRequest</a> ()</td>
      </tr>

      <tr className="memdesc:aeb1e7acce947f837d3988dd35a79cf47">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsRequest" title="A set of parameters for GPUdb::getRecords.">GetRecordsRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

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

      <tr className="memitem:abb74567f179afa7f365d445da1744f9a" id="r_abb74567f179afa7f365d445da1744f9a">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#abb74567f179afa7f365d445da1744f9a">GetRecordsRequest</a> (const std::string \&tableName\_, 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:abb74567f179afa7f365d445da1744f9a">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsRequest" title="A set of parameters for GPUdb::getRecords.">GetRecordsRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

      <tr className="memdesc:ac55e55a178f843d86a53ee5ebaf181a5">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the table or view from which the records will be fetched, 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:ac55e55a178f843d86a53ee5ebaf181a5">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:a6f8fde526abfe2adc4845bd4582f96a5">
        <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:a6f8fde526abfe2adc4845bd4582f96a5">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:a88646356abf331176d438e0e435cae79">
        <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:a88646356abf331176d438e0e435cae79">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:ad535fa3977f6dba1a112176e84864aa1">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Specifies the encoding for returned records; one of <a className="el" href="/content/api/cpp/namespacegpudb#a86cef1322c6135769934e22d65a458ee">binary</a>, <a className="el" href="/content/api/cpp/namespacegpudb#a29ef94c5d9875d91d172de8b38d6819c">json</a>, or <a className="el" href="/content/api/cpp/namespacegpudb#a125296c239cde3af182dff2af9a65708">geojson</a>. <br /></td>
      </tr>

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

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

      <tr className="separator:a34154120f855b301a836e850f39582dd">
        <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#a32de6c3fa89b56e5c573cf04bbbafabb">GPUdb::getRecords</a>. </p>
      <p>Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables and views. Records can be returned encoded as binary, json, or geojson.</p>
      <p>This operation supports paging through the data via the <a className="el" href="#a6f8fde526abfe2adc4845bd4582f96a5">offset</a> and <a className="el" href="#a88646356abf331176d438e0e435cae79">limit</a> parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records_8h_source#l00026">26</a> of file <a className="el" href="/content/api/cpp/get__records_8h_source">get\_records.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#aeb1e7acce947f837d3988dd35a79cf47">◆ </a></span>GetRecordsRequest() <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::GetRecordsRequest::GetRecordsRequest </td>
                  <td>(</td>

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

                  <td>)</td>

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

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

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsRequest" title="A set of parameters for GPUdb::getRecords.">GetRecordsRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records_8h_source#l00031">31</a> of file <a className="el" href="/content/api/cpp/get__records_8h_source">get\_records.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ab48f023721434d2821b3d8890651117f">◆ </a></span>GetRecordsRequest() <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::GetRecordsRequest::GetRecordsRequest </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 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 a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsRequest" title="A set of parameters for GPUdb::getRecords.">GetRecordsRequest</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 the table or view from which the records will be fetched, 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">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_1RawGetRecordsResponse#addc876a47152c62651f0ea49a111aa01">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>
                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa8ba8bada1e52234e73e49baae769873">get\_records\_expression</a>: Filter expression to apply to the table. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a9c995a38a96b7de5d4226fa88f1f2db1">get\_records\_fast\_index\_lookup</a>: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from \[0 to END\_OF\_SET]. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6cfed3eb927ab25c3d84e9bc0f397fa7">get\_records\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0871a7dadb765359372fbf2092aa6aa9">get\_records\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6cfed3eb927ab25c3d84e9bc0f397fa7">get\_records\_true</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6d56a39a602bbd41f34dd180c79b7861">get\_records\_sort\_by</a>: Column that the data should be sorted by. Empty by default (i.e. no sorting is applied). </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a3c6e717cdfc28d37c01f81ec1d4b3644">get\_records\_sort\_order</a>: String indicating how the returned values should be sorted - ascending or descending. If sort\_order is provided, sort\_by has to be provided. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a252c2b87591ffcea13037694610628da">get\_records\_ascending</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a20834c9af1c9f43ff9c6fd9f9695fb17">get\_records\_descending</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a252c2b87591ffcea13037694610628da">get\_records\_ascending</a>.
                    </li>
                  </ul>

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

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records_8h_source#l00118">118</a> of file <a className="el" href="/content/api/cpp/get__records_8h_source">get\_records.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#abb74567f179afa7f365d445da1744f9a">◆ </a></span>GetRecordsRequest() <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::GetRecordsRequest::GetRecordsRequest </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 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 a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsRequest" title="A set of parameters for GPUdb::getRecords.">GetRecordsRequest</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 the table or view from which the records will be fetched, 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">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_1RawGetRecordsResponse#addc876a47152c62651f0ea49a111aa01">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; one of <a className="el" href="/content/api/cpp/namespacegpudb#a86cef1322c6135769934e22d65a458ee">binary</a>, <a className="el" href="/content/api/cpp/namespacegpudb#a29ef94c5d9875d91d172de8b38d6819c">json</a>, or <a className="el" href="/content/api/cpp/namespacegpudb#a125296c239cde3af182dff2af9a65708">geojson</a>. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a86cef1322c6135769934e22d65a458ee">get\_records\_binary</a> </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a29ef94c5d9875d91d172de8b38d6819c">get\_records\_json</a> </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a125296c239cde3af182dff2af9a65708">get\_records\_geojson</a> </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#af1c3453a024d5c4fb897e5928b8f506f">get\_records\_arrow</a> </li>
                  </ul>

                  The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a86cef1322c6135769934e22d65a458ee">get\_records\_binary</a>.
                </td>
              </tr>

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

                <td>
                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa8ba8bada1e52234e73e49baae769873">get\_records\_expression</a>: Filter expression to apply to the table. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a9c995a38a96b7de5d4226fa88f1f2db1">get\_records\_fast\_index\_lookup</a>: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from \[0 to END\_OF\_SET]. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6cfed3eb927ab25c3d84e9bc0f397fa7">get\_records\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0871a7dadb765359372fbf2092aa6aa9">get\_records\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6cfed3eb927ab25c3d84e9bc0f397fa7">get\_records\_true</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6d56a39a602bbd41f34dd180c79b7861">get\_records\_sort\_by</a>: Column that the data should be sorted by. Empty by default (i.e. no sorting is applied). </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a3c6e717cdfc28d37c01f81ec1d4b3644">get\_records\_sort\_order</a>: String indicating how the returned values should be sorted - ascending or descending. If sort\_order is provided, sort\_by has to be provided. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a252c2b87591ffcea13037694610628da">get\_records\_ascending</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a20834c9af1c9f43ff9c6fd9f9695fb17">get\_records\_descending</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a252c2b87591ffcea13037694610628da">get\_records\_ascending</a>.
                    </li>
                  </ul>

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

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records_8h_source#l00223">223</a> of file <a className="el" href="/content/api/cpp/get__records_8h_source">get\_records.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Specifies the encoding for returned records; one of <a className="el" href="/content/api/cpp/namespacegpudb#a86cef1322c6135769934e22d65a458ee">binary</a>, <a className="el" href="/content/api/cpp/namespacegpudb#a29ef94c5d9875d91d172de8b38d6819c">json</a>, or <a className="el" href="/content/api/cpp/namespacegpudb#a125296c239cde3af182dff2af9a65708">geojson</a>. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a86cef1322c6135769934e22d65a458ee">get\_records\_binary</a> </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a29ef94c5d9875d91d172de8b38d6819c">get\_records\_json</a> </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a125296c239cde3af182dff2af9a65708">get\_records\_geojson</a> </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#af1c3453a024d5c4fb897e5928b8f506f">get\_records\_arrow</a> </li>
        </ul>

        <p>The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a86cef1322c6135769934e22d65a458ee">get\_records\_binary</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records_8h_source#l00276">276</a> of file <a className="el" href="/content/api/cpp/get__records_8h_source">get\_records.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">int64\_t gpudb::GetRecordsRequest::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_1RawGetRecordsResponse#addc876a47152c62651f0ea49a111aa01">hasMoreRecords</a> to see if more records exist in the result to be fetched, and <a className="el" href="#a6f8fde526abfe2adc4845bd4582f96a5">offset</a> and <a className="el" href="#a88646356abf331176d438e0e435cae79">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/get__records_8h_source#l00260">260</a> of file <a className="el" href="/content/api/cpp/get__records_8h_source">get\_records.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">int64\_t gpudb::GetRecordsRequest::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/get__records_8h_source#l00246">246</a> of file <a className="el" href="/content/api/cpp/get__records_8h_source">get\_records.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa8ba8bada1e52234e73e49baae769873">get\_records\_expression</a>: Filter expression to apply to the table. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a9c995a38a96b7de5d4226fa88f1f2db1">get\_records\_fast\_index\_lookup</a>: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from \[0 to END\_OF\_SET]. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6cfed3eb927ab25c3d84e9bc0f397fa7">get\_records\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0871a7dadb765359372fbf2092aa6aa9">get\_records\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6cfed3eb927ab25c3d84e9bc0f397fa7">get\_records\_true</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6d56a39a602bbd41f34dd180c79b7861">get\_records\_sort\_by</a>: Column that the data should be sorted by. Empty by default (i.e. no sorting is applied). </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a3c6e717cdfc28d37c01f81ec1d4b3644">get\_records\_sort\_order</a>: String indicating how the returned values should be sorted - ascending or descending. If sort\_order is provided, sort\_by has to be provided. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a252c2b87591ffcea13037694610628da">get\_records\_ascending</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a20834c9af1c9f43ff9c6fd9f9695fb17">get\_records\_descending</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a252c2b87591ffcea13037694610628da">get\_records\_ascending</a>.
          </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records_8h_source#l00315">315</a> of file <a className="el" href="/content/api/cpp/get__records_8h_source">get\_records.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the table or view from which the records will be fetched, 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/get__records_8h_source#l00238">238</a> of file <a className="el" href="/content/api/cpp/get__records_8h_source">get\_records.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/get__records_8h_source">get\_records.h</a></li>
    </ul>
  </div>
</div>