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

> gpudb::GetRecordsFromCollectionRequest — 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#ae32bea3bdbfef60b21d2fb7506439ca5">GPUdb::getRecordsFromCollection</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/get__records__from__collection_8h_source">gpudb/protocol/get\_records\_from\_collection.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:ae38c46250e9f1be45972dc286d70a6e2" id="r_ae38c46250e9f1be45972dc286d70a6e2">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ae38c46250e9f1be45972dc286d70a6e2">GetRecordsFromCollectionRequest</a> ()</td>
      </tr>

      <tr className="memdesc:ae38c46250e9f1be45972dc286d70a6e2">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionRequest" title="A set of parameters for GPUdb::getRecordsFromCollection.">GetRecordsFromCollectionRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a18bb59b6fa8ebdcb83128a89ad5589a0" id="r_a18bb59b6fa8ebdcb83128a89ad5589a0">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a18bb59b6fa8ebdcb83128a89ad5589a0">GetRecordsFromCollectionRequest</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:a18bb59b6fa8ebdcb83128a89ad5589a0">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionRequest" title="A set of parameters for GPUdb::getRecordsFromCollection.">GetRecordsFromCollectionRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a648404aeafedb0d3b585390dac2317ea" id="r_a648404aeafedb0d3b585390dac2317ea">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a648404aeafedb0d3b585390dac2317ea">GetRecordsFromCollectionRequest</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:a648404aeafedb0d3b585390dac2317ea">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionRequest" title="A set of parameters for GPUdb::getRecordsFromCollection.">GetRecordsFromCollectionRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

      <tr className="memdesc:a51032d54aad17b71ca959b55e02fad84">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the collection or table from which records are to be retrieved, 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:a51032d54aad17b71ca959b55e02fad84">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

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

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

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

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

      <tr className="memdesc:ac5d73705f6174b1d50a9c7e10debbc92">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Specifies the encoding for returned records; either <a className="el" href="/content/api/cpp/namespacegpudb#a83d4f6ef6ed4a7f5c425e8cd35ab1d6c">binary</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a2915b5a084a3d01b58c6c37cf27814c7">json</a>. <br /></td>
      </tr>

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

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

      <tr className="separator:a75ee42b427be1ac96f68a75444f0dcc1">
        <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#ae32bea3bdbfef60b21d2fb7506439ca5">GPUdb::getRecordsFromCollection</a>. </p>
      <p>Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a737a76b0c9fdd8d091dc6d02e9fcac78">GPUdb::deleteRecords</a>.</p>
      <p>This operation supports paging through the data via the <a className="el" href="#a80af610012202241c80bcc0a23466f76">offset</a> and <a className="el" href="#af08501c9b67fbbee5a8195313d7e7120">limit</a> parameters.</p>
      <p>Note that when using the Java API, it is not possible to retrieve records from join views using this operation. (DEPRECATED) </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source#l00028">28</a> of file <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source">get\_records\_from\_collection.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#ae38c46250e9f1be45972dc286d70a6e2">◆ </a></span>GetRecordsFromCollectionRequest() <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::GetRecordsFromCollectionRequest::GetRecordsFromCollectionRequest </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_1GetRecordsFromCollectionRequest" title="A set of parameters for GPUdb::getRecordsFromCollection.">GetRecordsFromCollectionRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source#l00034">34</a> of file <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source">get\_records\_from\_collection.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a18bb59b6fa8ebdcb83128a89ad5589a0">◆ </a></span>GetRecordsFromCollectionRequest() <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::GetRecordsFromCollectionRequest::GetRecordsFromCollectionRequest </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_1GetRecordsFromCollectionRequest" title="A set of parameters for GPUdb::getRecordsFromCollection.">GetRecordsFromCollectionRequest</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 collection or table from which records are to be retrieved, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing collection or table. </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 <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#ac6da5094c030db5012a21b0b4a8aca2b">get\_records\_from\_collection\_return\_record\_ids</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a335c36c8beee7ace6f681927cce8e277">true</a> then return the internal record ID along with each returned record. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a335c36c8beee7ace6f681927cce8e277">get\_records\_from\_collection\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6f96653f15171fb8f903b09c84db00e8">get\_records\_from\_collection\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6f96653f15171fb8f903b09c84db00e8">get\_records\_from\_collection\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a606a950809142651cd4f726d43c5ee4d">get\_records\_from\_collection\_expression</a>: Filter expression to apply to the table. 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/get__records__from__collection_8h_source#l00098">98</a> of file <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source">get\_records\_from\_collection.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a648404aeafedb0d3b585390dac2317ea">◆ </a></span>GetRecordsFromCollectionRequest() <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::GetRecordsFromCollectionRequest::GetRecordsFromCollectionRequest </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_1GetRecordsFromCollectionRequest" title="A set of parameters for GPUdb::getRecordsFromCollection.">GetRecordsFromCollectionRequest</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 collection or table from which records are to be retrieved, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing collection or table. </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 <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; either <a className="el" href="/content/api/cpp/namespacegpudb#a83d4f6ef6ed4a7f5c425e8cd35ab1d6c">binary</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a2915b5a084a3d01b58c6c37cf27814c7">json</a>. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a83d4f6ef6ed4a7f5c425e8cd35ab1d6c">get\_records\_from\_collection\_binary</a> </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a2915b5a084a3d01b58c6c37cf27814c7">get\_records\_from\_collection\_json</a> </li>
                  </ul>

                  The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a83d4f6ef6ed4a7f5c425e8cd35ab1d6c">get\_records\_from\_collection\_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#ac6da5094c030db5012a21b0b4a8aca2b">get\_records\_from\_collection\_return\_record\_ids</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a335c36c8beee7ace6f681927cce8e277">true</a> then return the internal record ID along with each returned record. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a335c36c8beee7ace6f681927cce8e277">get\_records\_from\_collection\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6f96653f15171fb8f903b09c84db00e8">get\_records\_from\_collection\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6f96653f15171fb8f903b09c84db00e8">get\_records\_from\_collection\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a606a950809142651cd4f726d43c5ee4d">get\_records\_from\_collection\_expression</a>: Filter expression to apply to the table. 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/get__records__from__collection_8h_source#l00180">180</a> of file <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source">get\_records\_from\_collection.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Specifies the encoding for returned records; either <a className="el" href="/content/api/cpp/namespacegpudb#a83d4f6ef6ed4a7f5c425e8cd35ab1d6c">binary</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a2915b5a084a3d01b58c6c37cf27814c7">json</a>. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a83d4f6ef6ed4a7f5c425e8cd35ab1d6c">get\_records\_from\_collection\_binary</a> </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a2915b5a084a3d01b58c6c37cf27814c7">get\_records\_from\_collection\_json</a> </li>
        </ul>

        <p>The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a83d4f6ef6ed4a7f5c425e8cd35ab1d6c">get\_records\_from\_collection\_binary</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source#l00232">232</a> of file <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source">get\_records\_from\_collection.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">int64\_t gpudb::GetRecordsFromCollectionRequest::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="#a80af610012202241c80bcc0a23466f76">offset</a> and <a className="el" href="#af08501c9b67fbbee5a8195313d7e7120">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__from__collection_8h_source#l00216">216</a> of file <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source">get\_records\_from\_collection.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">int64\_t gpudb::GetRecordsFromCollectionRequest::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__from__collection_8h_source#l00204">204</a> of file <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source">get\_records\_from\_collection.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#ac6da5094c030db5012a21b0b4a8aca2b">get\_records\_from\_collection\_return\_record\_ids</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a335c36c8beee7ace6f681927cce8e277">true</a> then return the internal record ID along with each returned record. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a335c36c8beee7ace6f681927cce8e277">get\_records\_from\_collection\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6f96653f15171fb8f903b09c84db00e8">get\_records\_from\_collection\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6f96653f15171fb8f903b09c84db00e8">get\_records\_from\_collection\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a606a950809142651cd4f726d43c5ee4d">get\_records\_from\_collection\_expression</a>: Filter expression to apply to the table. 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/get__records__from__collection_8h_source#l00256">256</a> of file <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source">get\_records\_from\_collection.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the collection or table from which records are to be retrieved, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </p>
        <p>Must be an existing collection or table. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source#l00196">196</a> of file <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source">get\_records\_from\_collection.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__from__collection_8h_source">get\_records\_from\_collection.h</a></li>
    </ul>
  </div>
</div>