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

#include <gpudb/protocol/query_graph.h>

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

	QueryGraphRequest (const std::string &graphName_, const std::vector< std::string > &queries_, const std::vector< std::string > &restrictions_, const std::string &adjacencyTable_, const int32_t rings_, const std::map< std::string, std::string > &options_)
	Constructs a QueryGraphRequest object with the specified parameters. More...

Public Attributes
std::string	graphName
	Name of the graph resource to query. More...

std::vector< std::string >	queries
	Nodes or edges to be queried specified using query identifiers. More...

std::vector< std::string >	restrictions
	Additional restrictions to apply to the nodes/edges of an existing graph. More...

std::string	adjacencyTable
	Name of the table to store the resulting adjacencies, in [ schema_name. ]table_name format, using standard name resolution rules and meeting table naming criteria. More...

int32_t	rings
	Sets the number of rings around the node to query for adjacency, with '1' being the edges directly attached to the queried node. More...

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

Detailed Description

A set of parameters for GPUdb::queryGraph.

Employs a topological query on a graph generated a-priori by GPUdb::createGraph 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.

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

Definition at line 38 of file query_graph.h.

Constructor & Destructor Documentation

◆ QueryGraphRequest() [1/2]

gpudb::QueryGraphRequest::QueryGraphRequest ( )

inline

Constructs a QueryGraphRequest object with default parameters.

Definition at line 43 of file query_graph.h.

◆ QueryGraphRequest() [2/2]

gpudb::QueryGraphRequest::QueryGraphRequest	(	const std::string &	graphName_,
		const std::vector< std::string > &	queries_,
		const std::vector< std::string > &	restrictions_,
		const std::string &	adjacencyTable_,
		const int32_t	rings_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a QueryGraphRequest object with the specified parameters.

Parameters

[in]	graphName_	Name of the graph resource to query.
[in]	queries_	Nodes or edges to be queried specified using query identifiers. Identifiers can be used with existing column names, e.g., 'table.column AS QUERY_NODE_ID', raw values, e.g., '{0, 2} AS QUERY_NODE_ID', or expressions, e.g., 'ST_MAKEPOINT(table.x, table.y) AS QUERY_NODE_WKTPOINT'. Multiple values can be provided as long as the same identifier is used for all values. If using raw values in an identifier combination, the number of values specified must match across the combination.
[in]	restrictions_	Additional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or raw values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using raw values in an identifier combination, the number of values specified must match across the combination. The default value is an empty vector.
[in]	adjacencyTable_	Name of the table to store the resulting adjacencies, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If left blank, the query results are instead returned in the response. If the 'QUERY_TARGET_NODE_LABEL' query identifier is used in queries_, then two additional columns will be available: 'PATH_ID' and 'RING_ID'. See Using Labels for more information. The default value is ''.
[in]	rings_	Sets the number of rings around the node to query for adjacency, with '1' being the edges directly attached to the queried node. Also known as number of hops. For example, if it is set to '2', the edge(s) directly attached to the queried node(s) will be returned; in addition, the edge(s) attached to the node(s) attached to the initial ring of edge(s) surrounding the queried node(s) will be returned. If the value is set to '0', any nodes that meet the criteria in queries_ and restrictions_ will be returned. This parameter is only applicable when querying nodes. The default value is 1.
[in]	options_	Additional parameters. query_graph_force_undirected: If set to true, all inbound edges and outbound edges relative to the node will be returned. If set to false, only outbound edges relative to the node will be returned. This parameter is only applicable if the queried graph graphName_ is directed and when querying nodes. Consult Directed Graphs for more details. Supported values: query_graph_true query_graph_false The default value is query_graph_false. query_graph_limit: When specified (>0), limits the number of query results. The size of the nodes table will be limited by the limit value. The default value is '0'. query_graph_output_wkt_path: If true then concatenated wkt line segments will be added as the WKT column of the adjacency table. Supported values: query_graph_true query_graph_false The default value is query_graph_false. query_graph_and_labels: If set to true, the result of the query has entities that satisfy all of the target labels, instead of any. Supported values: query_graph_true query_graph_false The default value is query_graph_false. query_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth. query_graph_output_charn_length: When specified (>0 and <=256), limits the number of char length on the output tables for string based nodes. The default length is 64. The default value is '64'. query_graph_find_common_labels: If set to true, for many-to-many queries or multi-level traversals, it lists the common labels between the source and target nodes and edge labels in each path. Otherwise (zero rings), it'll list all labels of the node(s) queried. Supported values: query_graph_true query_graph_false The default value is query_graph_false. The default value is an empty map.

Definition at line 222 of file query_graph.h.

Member Data Documentation

◆ adjacencyTable

std::string gpudb::QueryGraphRequest::adjacencyTable

Name of the table to store the resulting adjacencies, in [ schema_name. ]table_name format, using standard name resolution rules and meeting table naming criteria.

If left blank, the query results are instead returned in the response. If the 'QUERY_TARGET_NODE_LABEL' query identifier is used in queries, then two additional columns will be available: 'PATH_ID' and 'RING_ID'. See Using Labels for more information. The default value is ''.

Definition at line 282 of file query_graph.h.

◆ graphName

std::string gpudb::QueryGraphRequest::graphName

Name of the graph resource to query.

Definition at line 235 of file query_graph.h.

◆ options

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

Additional parameters.

query_graph_force_undirected: If set to true, all inbound edges and outbound edges relative to the node will be returned. If set to false, only outbound edges relative to the node will be returned. This parameter is only applicable if the queried graph graphName is directed and when querying nodes. Consult Directed Graphs for more details. Supported values:
- query_graph_true
- query_graph_false
The default value is query_graph_false.
query_graph_limit: When specified (>0), limits the number of query results. The size of the nodes table will be limited by the limit value. The default value is '0'.
query_graph_output_wkt_path: If true then concatenated wkt line segments will be added as the WKT column of the adjacency table. Supported values:
- query_graph_true
- query_graph_false
The default value is query_graph_false.
query_graph_and_labels: If set to true, the result of the query has entities that satisfy all of the target labels, instead of any. Supported values:
- query_graph_true
- query_graph_false
The default value is query_graph_false.
query_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth.
query_graph_output_charn_length: When specified (>0 and <=256), limits the number of char length on the output tables for string based nodes. The default length is 64. The default value is '64'.
query_graph_find_common_labels: If set to true, for many-to-many queries or multi-level traversals, it lists the common labels between the source and target nodes and edge labels in each path. Otherwise (zero rings), it'll list all labels of the node(s) queried. Supported values:
- query_graph_true
- query_graph_false
The default value is query_graph_false.

The default value is an empty map.

Definition at line 371 of file query_graph.h.

◆ queries

std::vector<std::string> gpudb::QueryGraphRequest::queries

Nodes or edges to be queried specified using query identifiers.

Identifiers can be used with existing column names, e.g., 'table.column AS QUERY_NODE_ID', raw values, e.g., '{0, 2} AS QUERY_NODE_ID', or expressions, e.g., 'ST_MAKEPOINT(table.x, table.y) AS QUERY_NODE_WKTPOINT'. Multiple values can be provided as long as the same identifier is used for all values. If using raw values in an identifier combination, the number of values specified must match across the combination.

Definition at line 248 of file query_graph.h.

◆ restrictions

std::vector<std::string> gpudb::QueryGraphRequest::restrictions

Additional restrictions to apply to the nodes/edges of an existing graph.

Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or raw values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using raw values in an identifier combination, the number of values specified must match across the combination. The default value is an empty vector.

Definition at line 264 of file query_graph.h.

◆ rings

int32_t gpudb::QueryGraphRequest::rings

Sets the number of rings around the node to query for adjacency, with '1' being the edges directly attached to the queried node.

Also known as number of hops. For example, if it is set to '2', the edge(s) directly attached to the queried node(s) will be returned; in addition, the edge(s) attached to the node(s) attached to the initial ring of edge(s) surrounding the queried node(s) will be returned. If the value is set to '0', any nodes that meet the criteria in queries and restrictions will be returned. This parameter is only applicable when querying nodes. The default value is 1.

Definition at line 296 of file query_graph.h.

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

gpudb/protocol/query_graph.h

Public Member Functions

Public Attributes