gpudb::QueryGraphResponse Struct Reference

A set of output parameters for const. More...

#include <gpudb/protocol/query_graph.h>

Public Member Functions
	QueryGraphResponse ()
	Constructs a QueryGraphResponse object with default parameter values. More...

Public Attributes
bool	result
std::vector< int64_t >	adjacencyListIntArray
std::vector< std::string >	adjacencyListStringArray
std::vector< std::string >	adjacencyListWktArray
std::map< std::string, std::string >	info

Detailed Description

A set of output parameters for const.

Employs a topological query on a network graph generated a-priori by const and returns a list of adjacent edge(s) or node(s), also known as an adjacency list, depending on what's been provided to the endpoint; providing edges will return nodes and providing nodes will return edges.

To determine the node(s) or edge(s) adjacent to a value from a given column, provide a list of values to queries. This field can be populated with column values from any table as long as the type is supported by the given identifier. See Query Identifiers for more information.

To return the adjacency list in the response, leave adjacencyTable empty. To return the adjacency list in a table and not in the response, provide a value to adjacencyTable and set export_query_results to false. To return the adjacency list both in a table and the response, provide a value to adjacencyTable and set export_query_results to true.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /query/graph examples before using this endpoint.

Definition at line 325 of file query_graph.h.

Constructor & Destructor Documentation

gpudb::QueryGraphResponse::QueryGraphResponse ( )

inline

Constructs a QueryGraphResponse object with default parameter values.

Definition at line 332 of file query_graph.h.

Member Data Documentation

std::vector<int64_t> gpudb::QueryGraphResponse::adjacencyListIntArray

Definition at line 342 of file query_graph.h.

std::vector<std::string> gpudb::QueryGraphResponse::adjacencyListStringArray

Definition at line 343 of file query_graph.h.

std::vector<std::string> gpudb::QueryGraphResponse::adjacencyListWktArray

Definition at line 344 of file query_graph.h.

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

Definition at line 345 of file query_graph.h.

bool gpudb::QueryGraphResponse::result

Definition at line 341 of file query_graph.h.

---

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

• gpudb/protocol/query_graph.h