A set of results returned by GPUdb::getGraphEntities. More...

#include <gpudb/protocol/get_graph_entities.h>

Public Member Functions
	GetGraphEntitiesResponse ()
	Constructs a GetGraphEntitiesResponse object with default parameters. More...

Public Attributes
bool	result
	Indicates a successful retrieval. More...

std::vector< int64_t >	entitiesInt
	Flat array of entity data for integer-identifier graphs with a repeating stride. More...

std::vector< std::string >	entitiesString
	Flat array of entity data for name-identifier or WKT-identifier (geo/XY) graphs with a repeating stride. More...

std::vector< std::string >	labels
	Array of distinct label strings. More...

std::map< std::string, std::string >	info
	Additional information map. More...

Detailed Description

A set of results returned by GPUdb::getGraphEntities.

Definition at line 200 of file get_graph_entities.h.

Constructor & Destructor Documentation

◆ GetGraphEntitiesResponse()

gpudb::GetGraphEntitiesResponse::GetGraphEntitiesResponse ( )

inline

Constructs a GetGraphEntitiesResponse object with default parameters.

Definition at line 206 of file get_graph_entities.h.

Member Data Documentation

◆ entitiesInt

std::vector<int64_t> gpudb::GetGraphEntitiesResponse::entitiesInt

Flat array of entity data for integer-identifier graphs with a repeating stride.

For node entities (stride 2): [ node_id, label_index, ... ]. For edge entities (stride 4): [ edge_id, node1_id, node2_id, label_index, ... ]. Populated when the graph uses integer identifiers; empty otherwise. The label_index is a 1-based index into the labels array; 0 indicates no label.

Definition at line 228 of file get_graph_entities.h.

◆ entitiesString

std::vector<std::string> gpudb::GetGraphEntitiesResponse::entitiesString

Flat array of entity data for name-identifier or WKT-identifier (geo/XY) graphs with a repeating stride.

For node entities (stride 2): [ node_name, label_index, ... ] or [ wkt_point, label_index, ... ]. For edge entities (stride 4): [ edge_id, node1_name, node2_name, label_index, ... ] or [ edge_id, node1_wkt, node2_wkt, label_index, ... ]. Populated when the graph uses string/name identifiers or geo/XY coordinate identifiers; empty otherwise. For geo/XY graphs, node identifiers are formatted as 'POINT(x y)' WKT strings. The label_index is a string representation of a 1-based index into the labels array; '0' indicates no label.

Definition at line 242 of file get_graph_entities.h.

◆ info

std::map<std::string, std::string> gpudb::GetGraphEntitiesResponse::info

Additional information map.

Contains the following keys: 'identifier_type' — set to 'int' (integer node IDs in entitiesInt), 'string' (name-based node IDs in entitiesString), or 'wkt' (geo/XY graph with 'POINT(x y)' node identifiers in entitiesString). 'total_count' — total number of live (non-deleted) entities available in the graph for the requested entity_type, used for pagination. 'status_message' — set to 'Cancelled' if the request was cancelled mid-iteration (with result set to false).

Definition at line 261 of file get_graph_entities.h.

◆ labels

std::vector<std::string> gpudb::GetGraphEntitiesResponse::labels

Array of distinct label strings.

The label_index values in entitiesInt or entitiesString are 1-based indexes into this array; index 0 means no label.

Definition at line 249 of file get_graph_entities.h.

◆ result

bool gpudb::GetGraphEntitiesResponse::result

Indicates a successful retrieval.

Definition at line 218 of file get_graph_entities.h.

The documentation for this struct was generated from the following file:

gpudb/protocol/get_graph_entities.h

Public Member Functions

Public Attributes