> ## 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. # kinetica.GetGraphEntitiesRequest > kinetica.GetGraphEntitiesRequest — Kinetica C# API

A set of parameters for Kinetica.getGraphEntities. More...

Inheritance diagram for kinetica.GetGraphEntitiesRequest:
Collaboration diagram for kinetica.GetGraphEntitiesRequest:

Classes
struct   Options
  A set of string constants for the parameter GetGraphEntitiesRequest.options. More...
 

Public Member Functions
  GetGraphEntitiesRequest ()
  Constructs a GetGraphEntitiesRequest object with default parameters.
 
  GetGraphEntitiesRequest (string graph\_name, long? offset=null, long? limit=null, IDictionary\< string, string > options=null)
  Constructs a GetGraphEntitiesRequest object with the specified parameters.
 
  GetGraphEntitiesRequest ()
  Constructs a GetGraphEntitiesRequest object with default parameters.
 
  GetGraphEntitiesRequest (string graph\_name, long? offset=null, long? limit=null, IDictionary\< string, string > options=null)
  Constructs a GetGraphEntitiesRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  graph\_name \[get, set]
  Name of the graph from which to retrieve entities.
 
long  offset = 0 \[get, set]
  Starting index of the entities to retrieve (0-based).
 
long  limit = 10000 \[get, set]
  Number of entities to retrieve starting from GetGraphEntitiesRequest.offset.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

Additional Inherited Members
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.getGraphEntities.

Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. Use Kinetica.showGraph to obtain the total number of nodes and edges.

Definition at line 18 of file GetGraphEntities.cs.

Constructor & Destructor Documentation

◆ GetGraphEntitiesRequest() \[1/4]

kinetica.GetGraphEntitiesRequest.GetGraphEntitiesRequest ( )
inline

Constructs a GetGraphEntitiesRequest object with default parameters.

Definition at line 278 of file GetGraphEntities.cs.

◆ GetGraphEntitiesRequest() \[2/4]

kinetica.GetGraphEntitiesRequest.GetGraphEntitiesRequest ( string graph\_name,
long? offset = null,
long? limit = null,
IDictionary\< string, string > options = null )
inline

Constructs a GetGraphEntitiesRequest object with the specified parameters.

Parameters
graph\_name Name of the graph from which to retrieve entities.
offset Starting index of the entities to retrieve (0-based). The default value is 0.
limit Number of entities to retrieve starting from offset . A value of -1 returns all entities from the offset to the end. Note: the entities\_int or entities\_string array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.
options Optional parameters.
  • ENTITY\_TYPE: The type of entity to retrieve. Supported values:
    • EDGE: Retrieve edge entities (default).
    • NODE: Retrieve node entities.
    The default value is EDGE.
  • SERVER\_ID: Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is '0'.
  • CONCISE\_EDGE\_CONNECTIVITY: When true, edges are emitted in a compact connectivity form regardless of the graph's identifier type: entities\_int 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 offset from an edge endpoint index to locate it within the returned page. Supported values:
    • TRUE: Compact integer connectivity for edges; deleted node slots included in node output.
    • FALSE: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped.
    The default value is FALSE.
  • INCLUDE\_WEIGHTS: When true and options entity\_type is 'edge', the response entities\_weight array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in entities\_int or entities\_string). Empty when the graph has no weights component or when requesting nodes. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 410 of file GetGraphEntities.cs.

◆ GetGraphEntitiesRequest() \[3/4]

kinetica.GetGraphEntitiesRequest.GetGraphEntitiesRequest ( )
inline

Constructs a GetGraphEntitiesRequest object with default parameters.

Definition at line 278 of file GetGraphEntities.cs.

◆ GetGraphEntitiesRequest() \[4/4]

kinetica.GetGraphEntitiesRequest.GetGraphEntitiesRequest ( string graph\_name,
long? offset = null,
long? limit = null,
IDictionary\< string, string > options = null )
inline

Constructs a GetGraphEntitiesRequest object with the specified parameters.

Parameters
graph\_name Name of the graph from which to retrieve entities.
offset Starting index of the entities to retrieve (0-based). The default value is 0.
limit Number of entities to retrieve starting from offset . A value of -1 returns all entities from the offset to the end. Note: the entities\_int or entities\_string array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.
options Optional parameters.
  • ENTITY\_TYPE: The type of entity to retrieve. Supported values:
    • EDGE: Retrieve edge entities (default).
    • NODE: Retrieve node entities.
    The default value is EDGE.
  • SERVER\_ID: Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is '0'.
  • CONCISE\_EDGE\_CONNECTIVITY: When true, edges are emitted in a compact connectivity form regardless of the graph's identifier type: entities\_int 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 offset from an edge endpoint index to locate it within the returned page. Supported values:
    • TRUE: Compact integer connectivity for edges; deleted node slots included in node output.
    • FALSE: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped.
    The default value is FALSE.
  • INCLUDE\_WEIGHTS: When true and options entity\_type is 'edge', the response entities\_weight array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in entities\_int or entities\_string). Empty when the graph has no weights component or when requesting nodes. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 410 of file GetGraphEntities.cs.

Property Documentation

◆ graph\_name

string kinetica.GetGraphEntitiesRequest.graph\_name
getset

Name of the graph from which to retrieve entities.

Definition at line 141 of file GetGraphEntities.cs.

◆ limit

long kinetica.GetGraphEntitiesRequest.limit = 10000
getset

Number of entities to retrieve starting from GetGraphEntitiesRequest.offset.

A value of -1 returns all entities from the offset to the end. Note: the entities\_int or entities\_string array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.

Definition at line 156 of file GetGraphEntities.cs.

◆ offset

long kinetica.GetGraphEntitiesRequest.offset = 0
getset

Starting index of the entities to retrieve (0-based).

The default value is 0.

Definition at line 146 of file GetGraphEntities.cs.

◆ options

IDictionary\< string, string > kinetica.GetGraphEntitiesRequest.options = new Dictionary\()
getset

Optional parameters.

  • ENTITY\_TYPE: The type of entity to retrieve. Supported values:
    • EDGE: Retrieve edge entities (default).
    • NODE: Retrieve node entities.
    The default value is EDGE.
  • SERVER\_ID: Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is '0'.
  • CONCISE\_EDGE\_CONNECTIVITY: When true, edges are emitted in a compact connectivity form regardless of the graph's identifier type: entities\_int 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 GetGraphEntitiesRequest.offset from an edge endpoint index to locate it within the returned page. Supported values:
    • TRUE: Compact integer connectivity for edges; deleted node slots included in node output.
    • FALSE: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped.
    The default value is FALSE.
  • INCLUDE\_WEIGHTS: When true and options entity\_type is 'edge', the response entities\_weight array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in entities\_int or entities\_string). Empty when the graph has no weights component or when requesting nodes. Supported values: The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 274 of file GetGraphEntities.cs.

The documentation for this class was generated from the following files: