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

> gpudb::GetGraphEntitiesResponse — 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#a6646fdaddf14aa7d9857ec0636fa204f">GPUdb::getGraphEntities</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/get__graph__entities_8h_source">gpudb/protocol/get\_graph\_entities.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:a3b926c7ea2afffb605b1ef832a590d50" id="r_a3b926c7ea2afffb605b1ef832a590d50">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a3b926c7ea2afffb605b1ef832a590d50">GetGraphEntitiesResponse</a> ()</td>
      </tr>

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

      <tr className="separator:a3b926c7ea2afffb605b1ef832a590d50">
        <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:ab3a3af3366528d0437d2e4cd87b2b33e" id="r_ab3a3af3366528d0437d2e4cd87b2b33e">
        <td className="memItemLeft" align="right" valign="top">bool </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ab3a3af3366528d0437d2e4cd87b2b33e">result</a></td>
      </tr>

      <tr className="memdesc:ab3a3af3366528d0437d2e4cd87b2b33e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Indicates a successful retrieval. <br /></td>
      </tr>

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

      <tr className="memitem:a44bf7d173a8d88f14d3589ab46f37b65" id="r_a44bf7d173a8d88f14d3589ab46f37b65">
        <td className="memItemLeft" align="right" valign="top">std::vector\< int64\_t > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a44bf7d173a8d88f14d3589ab46f37b65">entitiesInt</a></td>
      </tr>

      <tr className="memdesc:a44bf7d173a8d88f14d3589ab46f37b65">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Flat array of entity data for integer-identifier graphs with a repeating stride. <br /></td>
      </tr>

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

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

      <tr className="memdesc:aeb990f1a1e8c5d3b326cd9a25e72278e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Flat array of entity data for name-identifier (string) graphs only. <br /></td>
      </tr>

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

      <tr className="memitem:a9e8a63a55cad378a8ec213f8f35e8775" id="r_a9e8a63a55cad378a8ec213f8f35e8775">
        <td className="memItemLeft" align="right" valign="top">std::vector\< double > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a9e8a63a55cad378a8ec213f8f35e8775">entitiesDouble</a></td>
      </tr>

      <tr className="memdesc:a9e8a63a55cad378a8ec213f8f35e8775">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Compact double-packed payload for WKT (geo/XY) graphs. <br /></td>
      </tr>

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

      <tr className="memitem:acddf7d172e34c1d5dba5970ebfd1501a" id="r_acddf7d172e34c1d5dba5970ebfd1501a">
        <td className="memItemLeft" align="right" valign="top">std::vector\< float > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#acddf7d172e34c1d5dba5970ebfd1501a">entitiesWeight</a></td>
      </tr>

      <tr className="memdesc:acddf7d172e34c1d5dba5970ebfd1501a">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Per-edge weight values, populated only when the request option 'include\_weights' is 'true' and <span className="em arg">options</span> entityType is 'edge'. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a8bec4fac8d1d1e1ea744856b09661387">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Array of distinct label strings. <br /></td>
      </tr>

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

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

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

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

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

    <div className="textblock">
      <p>A set of results returned by <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a6646fdaddf14aa7d9857ec0636fa204f">GPUdb::getGraphEntities</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__graph__entities_8h_source#l00330">330</a> of file <a className="el" href="/content/api/cpp/get__graph__entities_8h_source">get\_graph\_entities.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a3b926c7ea2afffb605b1ef832a590d50">◆ </a></span>GetGraphEntitiesResponse()</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::GetGraphEntitiesResponse::GetGraphEntitiesResponse </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_1GetGraphEntitiesResponse" title="A set of results returned by GPUdb::getGraphEntities.">GetGraphEntitiesResponse</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__graph__entities_8h_source#l00336">336</a> of file <a className="el" href="/content/api/cpp/get__graph__entities_8h_source">get\_graph\_entities.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<double> gpudb::GetGraphEntitiesResponse::entitiesDouble</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Compact double-packed payload for WKT (geo/XY) graphs. </p>
        <p>WKT graphs ALWAYS use this array — 'POINT(x y)' strings are never emitted anywhere. Stride 3 for nodes: \[ x, y, label\_index, ... ]. Stride 6 for edges (non-concise): \[ edge\_id, x0, y0, x1, y1, label\_index, ... ]. Empty for non-WKT graphs and when concise mode emits edges into <a className="el" href="#a44bf7d173a8d88f14d3589ab46f37b65">entitiesInt</a> instead. label\_index/edge\_id occupy double slots (representable exactly up to 2^53). When 'concise\_edge\_connectivity' is 'true' and entity\_type is 'node', tombstoned (deleted) WKT slots emit \[0.0, 0.0, 0.0] to keep position indices stable. Roughly 4x smaller on the wire than 'POINT(x y)' strings and avoids any client-side regex parse. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__graph__entities_8h_source#l00393">393</a> of file <a className="el" href="/content/api/cpp/get__graph__entities_8h_source">get\_graph\_entities.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a44bf7d173a8d88f14d3589ab46f37b65">◆ </a></span>entitiesInt</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<int64\_t> gpudb::GetGraphEntitiesResponse::entitiesInt</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Flat array of entity data for integer-identifier graphs with a repeating stride. </p>
        <p>For node entities (stride 2): \[ node\_id, label\_index, ... ]. For edge entities (stride 4): \[ edge\_id, node1\_id, node2\_id, label\_index, ... ]. Populated when the graph uses integer identifiers; empty otherwise. The label\_index is a 1-based index into the <a className="el" href="#a8bec4fac8d1d1e1ea744856b09661387">labels</a> array; 0 indicates no label. When the request option 'concise\_edge\_connectivity' is 'true', this array is also used (regardless of graph identifier type) for edge entities and carries \[edge\_id, node1\_index, node2\_index, edge\_label\_index] where node1\_index/node2\_index are 0-based positions into the node array returned from a paired node call on the same graph. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__graph__entities_8h_source#l00365">365</a> of file <a className="el" href="/content/api/cpp/get__graph__entities_8h_source">get\_graph\_entities.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aeb990f1a1e8c5d3b326cd9a25e72278e">◆ </a></span>entitiesString</h2>

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

      <div className="memdoc">
        <p>Flat array of entity data for name-identifier (string) graphs only. </p>
        <p>For node entities (stride 2): \[ node\_name, label\_index, ... ]. For edge entities (stride 4): \[ edge\_id, node1\_name, node2\_name, label\_index, ... ]. Populated only when the graph uses string identifiers. Empty for integer-identifier graphs (data goes to <a className="el" href="#a44bf7d173a8d88f14d3589ab46f37b65">entitiesInt</a>) and for WKT/geo-XY graphs (data always goes to <a className="el" href="#a9e8a63a55cad378a8ec213f8f35e8775">entitiesDouble</a> — 'POINT(x y)' strings are never emitted). The label\_index is a string representation of a 1-based index into the <a className="el" href="#a8bec4fac8d1d1e1ea744856b09661387">labels</a> array; '0' indicates no label. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__graph__entities_8h_source#l00378">378</a> of file <a className="el" href="/content/api/cpp/get__graph__entities_8h_source">get\_graph\_entities.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#acddf7d172e34c1d5dba5970ebfd1501a">◆ </a></span>entitiesWeight</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<float> gpudb::GetGraphEntitiesResponse::entitiesWeight</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Per-edge weight values, populated only when the request option 'include\_weights' is 'true' and <span className="em arg">options</span> entityType is 'edge'. </p>
        <p>Stride 1, aligned 1:1 with the edge records emitted in <a className="el" href="#a44bf7d173a8d88f14d3589ab46f37b65">entitiesInt</a> or <a className="el" href="#aeb990f1a1e8c5d3b326cd9a25e72278e">entitiesString</a> (i.e. the i-th weight corresponds to the i-th edge record). Empty when the graph has no weights component, when requesting nodes, or when the option is not set. Single-precision float matches the graph server's native weight storage. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__graph__entities_8h_source#l00405">405</a> of file <a className="el" href="/content/api/cpp/get__graph__entities_8h_source">get\_graph\_entities.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a91315a9a1a2d25c7f73c2725257a3b49">◆ </a></span>info</h2>

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

      <div className="memdoc">
        <p>Additional information map. </p>
        <p>Contains the following keys: 'identifier\_type' — describes the graph's native node identifier type: 'int', 'string', or 'wkt' (geo/XY graph). 'payload\_type' — describes which array actually holds this response payload: 'int' (<a className="el" href="#a44bf7d173a8d88f14d3589ab46f37b65">entitiesInt</a>), 'string' (<a className="el" href="#aeb990f1a1e8c5d3b326cd9a25e72278e">entitiesString</a>), or 'double' (<a className="el" href="#a9e8a63a55cad378a8ec213f8f35e8775">entitiesDouble</a>). WKT graphs ALWAYS use 'double' for both nodes and edges — 'POINT(x y)' strings are never emitted. In concise edge mode payload\_type is 'int' regardless of graph type. Clients should dispatch on 'payload\_type', not 'identifier\_type', to parse the response. 'total\_count' — total number of entities available in the graph for the requested entity\_type, used for pagination; this is the live (non-deleted) count by default, or the raw count (including deleted slots) when 'concise\_edge\_connectivity' is true for a node request. 'status\_message' — set to 'Cancelled' if the request was cancelled mid-iteration (with <a className="el" href="#ab3a3af3366528d0437d2e4cd87b2b33e">result</a> set to false). 'concise\_edge\_connectivity' — set to 'true' when the response was produced with the concise option (edges emitted as \[edge\_id, v0\_index, v1\_index, label\_idx] in <a className="el" href="#a44bf7d173a8d88f14d3589ab46f37b65">entitiesInt</a>; WKT-graph nodes emitted as \[x, y, label\_idx] in <a className="el" href="#a9e8a63a55cad378a8ec213f8f35e8775">entitiesDouble</a>; non-WKT nodes still in their native array; node output includes deleted slots to keep indices stable). 'include\_weights' — set to 'true' when <a className="el" href="#acddf7d172e34c1d5dba5970ebfd1501a">entitiesWeight</a> is populated. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__graph__entities_8h_source#l00438">438</a> of file <a className="el" href="/content/api/cpp/get__graph__entities_8h_source">get\_graph\_entities.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a8bec4fac8d1d1e1ea744856b09661387">◆ </a></span>labels</h2>

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

      <div className="memdoc">
        <p>Array of distinct label strings. </p>
        <p>The label\_index values in <a className="el" href="#a44bf7d173a8d88f14d3589ab46f37b65">entitiesInt</a>, <a className="el" href="#aeb990f1a1e8c5d3b326cd9a25e72278e">entitiesString</a>, or <a className="el" href="#a9e8a63a55cad378a8ec213f8f35e8775">entitiesDouble</a> are 1-based indexes into this array; index 0 means no label. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__graph__entities_8h_source#l00412">412</a> of file <a className="el" href="/content/api/cpp/get__graph__entities_8h_source">get\_graph\_entities.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ab3a3af3366528d0437d2e4cd87b2b33e">◆ </a></span>result</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">bool gpudb::GetGraphEntitiesResponse::result</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Indicates a successful retrieval. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__graph__entities_8h_source#l00350">350</a> of file <a className="el" href="/content/api/cpp/get__graph__entities_8h_source">get\_graph\_entities.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__graph__entities_8h_source">get\_graph\_entities.h</a></li>
    </ul>
  </div>
</div>