> ## 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::GetRecordsFromCollectionResponse< T >

> gpudb::GetRecordsFromCollectionResponse< T > — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of results returned by <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:adb2f79d0bd81e8be21773f686e03107e" id="r_adb2f79d0bd81e8be21773f686e03107e">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#adb2f79d0bd81e8be21773f686e03107e">GetRecordsFromCollectionResponse</a> ()</td>
      </tr>

      <tr className="memdesc:adb2f79d0bd81e8be21773f686e03107e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionResponse" title="A set of results returned by GPUdb::getRecordsFromCollection.">GetRecordsFromCollectionResponse</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memdesc:ab0cd516da6418f3f33d17cde04b4f14a">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Value of <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionRequest#a51032d54aad17b71ca959b55e02fad84">tableName</a>. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a1a2112a173f9e830a42dd27eb13428e2">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The type IDs of the corresponding records in <a className="el" href="#a762d7ce9018391984cf7ff360e2dfc6b">data</a> or <span className="em arg">recordsJson</span>. <br /></td>
      </tr>

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

      <tr className="memitem:a762d7ce9018391984cf7ff360e2dfc6b" id="r_a762d7ce9018391984cf7ff360e2dfc6b">
        <td className="memItemLeft" align="right" valign="top">std::vector\< T > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a762d7ce9018391984cf7ff360e2dfc6b">data</a></td>
      </tr>

      <tr className="memdesc:a762d7ce9018391984cf7ff360e2dfc6b">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a4bf1a64ca5d43262529cbc82e75a0a10">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If the 'return\_record\_ids' option of the request was 'true', then this list contains the internal ID for each object. <br /></td>
      </tr>

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

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

      <tr className="memdesc:ac6da055e4515fcfd66744b38feae583b">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Additional information. <br /></td>
      </tr>

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

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <div className="compoundTemplParams">template\<typename T><br /> struct gpudb::GetRecordsFromCollectionResponse\< T ></div>
      <p>A set of results returned by <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#ae32bea3bdbfef60b21d2fb7506439ca5">GPUdb::getRecordsFromCollection</a>. </p>

      <div className="dl tparams">
        <div className="dt">Template Parameters</div>

        <div className="dd">
          <table className="tparams">
            <tr>
              <td className="paramname">T</td>
              <td>The type of object being processed. </td>
            </tr>
          </table>
        </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source#l00479">479</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="#adb2f79d0bd81e8be21773f686e03107e">◆ </a></span>GetRecordsFromCollectionResponse()</h2>

    <div className="memitem">
      <div className="memproto">
        <div className="memtemplate"> template\<typename T> </div>

        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionResponse">gpudb::GetRecordsFromCollectionResponse</a>\< T >::GetRecordsFromCollectionResponse </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_1GetRecordsFromCollectionResponse" title="A set of results returned by GPUdb::getRecordsFromCollection.">GetRecordsFromCollectionResponse</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#l00485">485</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="#a762d7ce9018391984cf7ff360e2dfc6b">◆ </a></span>data</h2>

    <div className="memitem">
      <div className="memproto">
        <div className="memtemplate"> template\<typename T> </div>

        <table className="memname">
          <tr>
            <td className="memname">std::vector\<T> <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionResponse">gpudb::GetRecordsFromCollectionResponse</a>\< T >::data</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection. </p>
        <p>Otherwise, empty list. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source#l00514">514</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="#ac6da055e4515fcfd66744b38feae583b">◆ </a></span>info</h2>

    <div className="memitem">
      <div className="memproto">
        <div className="memtemplate"> template\<typename T> </div>

        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionResponse">gpudb::GetRecordsFromCollectionResponse</a>\< T >::info</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Additional information. </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#aaaf2979f3f5c16d1b04c2d7362d163a1">get\_records\_from\_collection\_total\_number\_of\_records</a>: Total number of records. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a6b118aae24a2334493e5f32e5acfc276">get\_records\_from\_collection\_has\_more\_records</a>: Too many records. Returned a partial set. 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>
          </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#l00543">543</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="#a4bf1a64ca5d43262529cbc82e75a0a10">◆ </a></span>recordIds</h2>

    <div className="memitem">
      <div className="memproto">
        <div className="memtemplate"> template\<typename T> </div>

        <table className="memname">
          <tr>
            <td className="memname">std::vector\<std::string> <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionResponse">gpudb::GetRecordsFromCollectionResponse</a>\< T >::recordIds</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>If the 'return\_record\_ids' option of the request was 'true', then this list contains the internal ID for each object. </p>
        <p>Otherwise it will be empty. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source#l00521">521</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="#ab0cd516da6418f3f33d17cde04b4f14a">◆ </a></span>tableName</h2>

    <div className="memitem">
      <div className="memproto">
        <div className="memtemplate"> template\<typename T> </div>

        <table className="memname">
          <tr>
            <td className="memname">std::string <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionResponse">gpudb::GetRecordsFromCollectionResponse</a>\< T >::tableName</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Value of <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionRequest#a51032d54aad17b71ca959b55e02fad84">tableName</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source#l00498">498</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="#a1a2112a173f9e830a42dd27eb13428e2">◆ </a></span>typeNames</h2>

    <div className="memitem">
      <div className="memproto">
        <div className="memtemplate"> template\<typename T> </div>

        <table className="memname">
          <tr>
            <td className="memname">std::vector\<std::string> <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionResponse">gpudb::GetRecordsFromCollectionResponse</a>\< T >::typeNames</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The type IDs of the corresponding records in <a className="el" href="#a762d7ce9018391984cf7ff360e2dfc6b">data</a> or <span className="em arg">recordsJson</span>. </p>
        <p>This is useful when <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsFromCollectionRequest#a51032d54aad17b71ca959b55e02fad84">tableName</a> is a heterogeneous collection (collections containing tables of different types). </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__from__collection_8h_source#l00507">507</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>