get_graph_entities - Kinetica Docs

get_graph_entities

get_graph_entities(
graph_name: string,
offset?: number,
limit?: number,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<GetGraphEntitiesResponse>
Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. Use show_graph to obtain the total number of nodes and edges.
Parameters
- graph_name: string
  Name of the graph from which to retrieve entities.
- Optionaloffset: number
  Starting index of the entities to retrieve (0-based).
- Optionallimit: number
  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).
- Optionaloptions: Record<string, string>
  Optional parameters.
- Optionalcallback: GPUdbCallback
  Optional callback function
Returns Promise<GetGraphEntitiesResponse>
Promise<Types.GetGraphEntitiesResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:9966

get_graph_entities_request

get_graph_entities_request(
request: GetGraphEntitiesRequest,
callback?: GPUdbCallback,
): Promise<GetGraphEntitiesResponse>
Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. Use show_graph to obtain the total number of nodes and edges.
Parameters
- request: GetGraphEntitiesRequest
  Request object containing the parameters for the operation
- Optionalcallback: GPUdbCallback
  Optional callback function
Returns Promise<GetGraphEntitiesResponse>
Promise<Types.GetGraphEntitiesResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:9937