Skip to main content

​
◆ getGraphEntities() [1/2]

GetGraphEntitiesResponse kinetica.Kinetica.getGraphEntities (GetGraphEntitiesRequestrequest_)
 inline

Retrieves node or edge entities from an existing graph, with pagination support via offset and limit.

Use showGraph to obtain the total number of nodes and edges.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 40196 of file KineticaFunctions.cs.

​
◆ getGraphEntities() [2/2]

GetGraphEntitiesResponse kinetica.Kinetica.getGraphEntities (stringgraph_name,
longoffset = 0,
longlimit = 10000,
IDictionary< string, string >options = null )
 inline

Retrieves node or edge entities from an existing graph, with pagination support via offset and limit.

Use showGraph to obtain the total number of nodes and edges.

Parameters
graph_nameName of the graph from which to retrieve entities.
offsetStarting index of the entities to retrieve (0-based). The default value is 0.
limitNumber 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.
optionsOptional 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.
Returns
Response object containing the result of the operation.

Definition at line 40358 of file KineticaFunctions.cs.

​
◆ GetGraphEntitiesAsync() [1/2]

async System.Threading.Tasks.Task< GetGraphEntitiesResponse > kinetica.Kinetica.GetGraphEntitiesAsync (GetGraphEntitiesRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Retrieves node or edge entities from an existing graph, with pagination support via offset and limit.

(async)

Use showGraph to obtain the total number of nodes and edges.

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 40215 of file KineticaFunctions.cs.

​
◆ GetGraphEntitiesAsync() [2/2]

async System.Threading.Tasks.Task< GetGraphEntitiesResponse > kinetica.Kinetica.GetGraphEntitiesAsync (stringgraph_name,
longoffset = 0,
longlimit = 10000,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Retrieves node or edge entities from an existing graph, with pagination support via offset and limit.

(async)

Use showGraph to obtain the total number of nodes and edges.

Parameters
graph_nameName of the graph from which to retrieve entities.
offsetStarting index of the entities to retrieve (0-based). The default value is 0.
limitNumber 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.
optionsOptional 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.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 40504 of file KineticaFunctions.cs.