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

# getGraphEntities

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

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

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname"><a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse">GetGraphEntitiesResponse</a> kinetica.Kinetica.getGraphEntities </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesRequest">GetGraphEntitiesRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
                <td>)</td>

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

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

    <div className="memdoc">
      <p>Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. </p>
      <p>Use <a className="el" href="#a58f4cd71a9f4d877d262fbf790d31a3c">showGraph</a> to obtain the total number of nodes and edges.</p>

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

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

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

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

  <div id="a5a0bac1a6a6ac7413278ca9a881a1fe6" />

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

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

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

                <td />

                <td className="paramtype">long</td>
                <td className="paramname"><span className="paramname"><span className="em">offset</span></span><span className="paramdefsep"> = </span><span className="paramdefval">0</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">long</td>
                <td className="paramname"><span className="paramname"><span className="em">limit</span></span><span className="paramdefsep"> = </span><span className="paramdefval">10000</span>, </td>
              </tr>

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

                <td />

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

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

    <div className="memdoc">
      <p>Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. </p>
      <p>Use <a className="el" href="#a58f4cd71a9f4d877d262fbf790d31a3c">showGraph</a> to obtain the total number of nodes and edges.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">graph\_name</td>
              <td>Name of the graph from which to retrieve entities.</td>
            </tr>

            <tr>
              <td className="paramname">offset</td>
              <td>Starting index of the entities to retrieve (0-based). The default value is 0.</td>
            </tr>

            <tr>
              <td className="paramname">limit</td>
              <td>Number of entities to retrieve starting from <span className="em">offset</span> . A value of -1 returns all entities from the offset to the end. Note: the <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a0918e0b3dc528a9f583b47100dba0050">entities\_int</a> or <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a6edb5534e9fe54d3bebec5c2bc5a9ce1">entities\_string</a> array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.</td>
            </tr>

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

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a957419437655c30894d20c22c7cfd72f">ENTITY\_TYPE</a>: The type of entity to retrieve. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#ad94a349f438817c9d17a02cde081e2bd">EDGE</a>: Retrieve edge entities (default). </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a1ee16bd661daa23f5f3fedf0fb558908">NODE</a>: Retrieve node entities. </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#ad94a349f438817c9d17a02cde081e2bd">EDGE</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#afc2a88101123aa8c065be1658c2d5503">SERVER\_ID</a>: Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is '0'. </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a942e4039459dcd0e4d59a6dda7f034ba">CONCISE\_EDGE\_CONNECTIVITY</a>: When true, edges are emitted in a compact connectivity form regardless of the graph's identifier type: <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a0918e0b3dc528a9f583b47100dba0050">entities\_int</a> contains stride-4 records \[edge\_id, node1\_index, node2\_index, edge\_label\_index] where node1\_index/node2\_index are 0-based positions into the node array (obtained from a node-entity call on the same graph). When requesting nodes with this option, the response includes tombstoned (deleted) slots in order to keep position indices stable so edge indices resolve correctly; deleted slots carry id=0 for integer graphs or an empty identifier for string/WKT graphs. For paginated node calls, subtract <span className="em">offset</span> from an edge endpoint index to locate it within the returned page. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a729881db863cd441669109e620b04f09">TRUE</a>: Compact integer connectivity for edges; deleted node slots included in node output. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped. </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#ae23ba6e89ce7293c44bd42e1ef9a553b">INCLUDE\_WEIGHTS</a>: When true and <code>options entity\_type</code> is 'edge', the response <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a77b8de25ab1fef8f651930dd62cfdf2f">entities\_weight</a> array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a0918e0b3dc528a9f583b47100dba0050">entities\_int</a> or <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a6edb5534e9fe54d3bebec5c2bc5a9ce1">entities\_string</a>). Empty when the graph has no weights component or when requesting nodes. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a729881db863cd441669109e620b04f09">TRUE</a>: Populate <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a77b8de25ab1fef8f651930dd62cfdf2f">entities\_weight</a> with per-edge weights (edge requests only). </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>: Default: <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a77b8de25ab1fef8f651930dd62cfdf2f">entities\_weight</a> is empty. </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>.
                  </li>
                </ul>

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

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

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

  <div id="aced3152ea86bc99240e805bd5e1b8812" />

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

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse">GetGraphEntitiesResponse</a> > kinetica.Kinetica.GetGraphEntitiesAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesRequest">GetGraphEntitiesRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</span> )</td>
              </tr>
            </table>
          </td>

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

    <div className="memdoc">
      <p>Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. </p>
      <p>(async) </p>
      <p>Use <a className="el" href="#a58f4cd71a9f4d877d262fbf790d31a3c">showGraph</a> to obtain the total number of nodes and edges.</p>

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

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

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

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

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

  <div id="a8830687a8b45e59913577d425afeb715" />

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

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

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

                <td />

                <td className="paramtype">long</td>
                <td className="paramname"><span className="paramname"><span className="em">offset</span></span><span className="paramdefsep"> = </span><span className="paramdefval">0</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">long</td>
                <td className="paramname"><span className="paramname"><span className="em">limit</span></span><span className="paramdefsep"> = </span><span className="paramdefval">10000</span>, </td>
              </tr>

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

                <td />

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

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</span> )</td>
              </tr>
            </table>
          </td>

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

    <div className="memdoc">
      <p>Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. </p>
      <p>(async) </p>
      <p>Use <a className="el" href="#a58f4cd71a9f4d877d262fbf790d31a3c">showGraph</a> to obtain the total number of nodes and edges.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">graph\_name</td>
              <td>Name of the graph from which to retrieve entities.</td>
            </tr>

            <tr>
              <td className="paramname">offset</td>
              <td>Starting index of the entities to retrieve (0-based). The default value is 0.</td>
            </tr>

            <tr>
              <td className="paramname">limit</td>
              <td>Number of entities to retrieve starting from <span className="em">offset</span> . A value of -1 returns all entities from the offset to the end. Note: the <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a0918e0b3dc528a9f583b47100dba0050">entities\_int</a> or <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a6edb5534e9fe54d3bebec5c2bc5a9ce1">entities\_string</a> array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.</td>
            </tr>

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

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a957419437655c30894d20c22c7cfd72f">ENTITY\_TYPE</a>: The type of entity to retrieve. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#ad94a349f438817c9d17a02cde081e2bd">EDGE</a>: Retrieve edge entities (default). </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a1ee16bd661daa23f5f3fedf0fb558908">NODE</a>: Retrieve node entities. </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#ad94a349f438817c9d17a02cde081e2bd">EDGE</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#afc2a88101123aa8c065be1658c2d5503">SERVER\_ID</a>: Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is '0'. </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a942e4039459dcd0e4d59a6dda7f034ba">CONCISE\_EDGE\_CONNECTIVITY</a>: When true, edges are emitted in a compact connectivity form regardless of the graph's identifier type: <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a0918e0b3dc528a9f583b47100dba0050">entities\_int</a> contains stride-4 records \[edge\_id, node1\_index, node2\_index, edge\_label\_index] where node1\_index/node2\_index are 0-based positions into the node array (obtained from a node-entity call on the same graph). When requesting nodes with this option, the response includes tombstoned (deleted) slots in order to keep position indices stable so edge indices resolve correctly; deleted slots carry id=0 for integer graphs or an empty identifier for string/WKT graphs. For paginated node calls, subtract <span className="em">offset</span> from an edge endpoint index to locate it within the returned page. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a729881db863cd441669109e620b04f09">TRUE</a>: Compact integer connectivity for edges; deleted node slots included in node output. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped. </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#ae23ba6e89ce7293c44bd42e1ef9a553b">INCLUDE\_WEIGHTS</a>: When true and <code>options entity\_type</code> is 'edge', the response <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a77b8de25ab1fef8f651930dd62cfdf2f">entities\_weight</a> array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a0918e0b3dc528a9f583b47100dba0050">entities\_int</a> or <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a6edb5534e9fe54d3bebec5c2bc5a9ce1">entities\_string</a>). Empty when the graph has no weights component or when requesting nodes. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a729881db863cd441669109e620b04f09">TRUE</a>: Populate <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a77b8de25ab1fef8f651930dd62cfdf2f">entities\_weight</a> with per-edge weights (edge requests only). </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>: Default: <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a77b8de25ab1fef8f651930dd62cfdf2f">entities\_weight</a> is empty. </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>.
                  </li>
                </ul>

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

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

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

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