A set of parameters for GPUdb::getGraphEntities. More...

#include <gpudb/protocol/get_graph_entities.h>

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

	GetGraphEntitiesRequest (const std::string &graphName_, const int64_t offset_, const int64_t limit_, const std::map< std::string, std::string > &options_)
	Constructs a GetGraphEntitiesRequest object with the specified parameters. More...

Public Attributes
std::string	graphName
	Name of the graph from which to retrieve entities. More...

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

int64_t	limit
	Number of entities to retrieve starting from offset. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::getGraphEntities.

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

Definition at line 21 of file get_graph_entities.h.

Constructor & Destructor Documentation

◆ GetGraphEntitiesRequest() [1/2]

gpudb::GetGraphEntitiesRequest::GetGraphEntitiesRequest ( )

inline

Constructs a GetGraphEntitiesRequest object with default parameters.

Definition at line 26 of file get_graph_entities.h.

◆ GetGraphEntitiesRequest() [2/2]

gpudb::GetGraphEntitiesRequest::GetGraphEntitiesRequest	(	const std::string &	graphName_,
		const int64_t	offset_,
		const int64_t	limit_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a GetGraphEntitiesRequest object with the specified parameters.

Parameters

[in]	graphName_	Name of the graph from which to retrieve entities.
[in]	offset_	Starting index of the entities to retrieve (0-based). The default value is 0.
[in]	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.
[in]	options_	Optional parameters. get_graph_entities_entity_type: The type of entity to retrieve. Supported values: get_graph_entities_edge: Retrieve edge entities (default). get_graph_entities_node: Retrieve node entities. The default value is get_graph_entities_edge. get_graph_entities_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'. get_graph_entities_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: get_graph_entities_true: Compact integer connectivity for edges; deleted node slots included in node output. get_graph_entities_false: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped. The default value is get_graph_entities_false. get_graph_entities_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: get_graph_entities_true: Populate entitiesWeight with per-edge weights (edge requests only). get_graph_entities_false: Default: entitiesWeight is empty. The default value is get_graph_entities_false. The default value is an empty map.

Definition at line 160 of file get_graph_entities.h.

Member Data Documentation

◆ graphName

std::string gpudb::GetGraphEntitiesRequest::graphName

Name of the graph from which to retrieve entities.

Definition at line 171 of file get_graph_entities.h.

◆ limit

int64_t gpudb::GetGraphEntitiesRequest::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.

Definition at line 187 of file get_graph_entities.h.

◆ offset

int64_t gpudb::GetGraphEntitiesRequest::offset

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

The default value is 0.

Definition at line 177 of file get_graph_entities.h.

◆ options

std::map<std::string, std::string> gpudb::GetGraphEntitiesRequest::options

Optional parameters.

get_graph_entities_entity_type: The type of entity to retrieve. Supported values:
- get_graph_entities_edge: Retrieve edge entities (default).
- get_graph_entities_node: Retrieve node entities.
The default value is get_graph_entities_edge.
get_graph_entities_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'.
get_graph_entities_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:
- get_graph_entities_true: Compact integer connectivity for edges; deleted node slots included in node output.
- get_graph_entities_false: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped.
The default value is get_graph_entities_false.
get_graph_entities_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:
- get_graph_entities_true: Populate entitiesWeight with per-edge weights (edge requests only).
- get_graph_entities_false: Default: entitiesWeight is empty.
The default value is get_graph_entities_false.

The default value is an empty map.

Definition at line 265 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