Skip to main content

  • ​
    getGraphEntities

    public GetGraphEntitiesResponse getGraphEntities(GetGraphEntitiesRequest request) throws GPUdbException
    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 results of the operation.
    Throws:
    GPUdbException - if an error occurs during the operation.

  • ​
    getGraphEntities

    public GetGraphEntitiesResponse getGraphEntities(String graphName, long offset, long limit, Map<String,String> options) throws GPUdbException
    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:
    graphName - 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 entitiesInt or entitiesString 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: entitiesInt 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 entityType is ‘edge’, the response entitiesWeight array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in entitiesInt or entitiesString). 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 Map.
    Returns:
    Response object containing the results of the operation.
    Throws:
    GPUdbException - if an error occurs during the operation.