Skip to main content

A set of parameters for GPUdb::repartitionGraph. More…

#include <gpudb/protocol/repartition_graph.h>

​
Public Member Functions

 RepartitionGraphRequest ()
 Constructs a RepartitionGraphRequest object with default parameters.
 
 RepartitionGraphRequest (const std::string &graphName_, const std::map< std::string, std::string > &options_)
 Constructs a RepartitionGraphRequest object with the specified parameters.
 

​
Public Attributes

std::string graphName
 Name of the graph resource to rebalance.
 
std::map< std::string, std::string > options
 Optional parameters.
 

​
Detailed Description

A set of parameters for GPUdb::repartitionGraph.

Rebalances an existing partitioned graph.

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

Definition at line 25 of file repartition_graph.h.

​
Constructor & Destructor Documentation

​
◆ RepartitionGraphRequest() [1/2]

gpudb::RepartitionGraphRequest::RepartitionGraphRequest ()
 inline

Constructs a RepartitionGraphRequest object with default parameters.

Definition at line 30 of file repartition_graph.h.

​
◆ RepartitionGraphRequest() [2/2]

gpudb::RepartitionGraphRequest::RepartitionGraphRequest (const std::string &graphName_,
const std::map< std::string, std::string > &options_ )
 inline

Constructs a RepartitionGraphRequest object with the specified parameters.

Parameters
[in]graphName_Name of the graph resource to rebalance.
[in]options_Optional parameters.
  • repartition_graph_new_graph_name: If a non-empty value is specified, the original graph will be kept (non-default behavior) and a new balanced graph will be created under this given name. When the value is empty (default), the generated ‘balanced’ graph will replace the original ‘unbalanced’ graph under the same graph name. The default value is ”.
  • repartition_graph_source_node: The distributed shortest path solve is run from this source node to all the nodes in the graph to create balanced partitions using the iso-distance levels of the solution. The source node is selected by the rebalance algorithm automatically (default case when the value is an empty string). Otherwise, the user specified node is used as the source. The default value is ”.
The default value is an empty map.

Definition at line 73 of file repartition_graph.h.

​
Member Data Documentation

​
◆ graphName

std::string gpudb::RepartitionGraphRequest::graphName

Name of the graph resource to rebalance.

Definition at line 82 of file repartition_graph.h.

​
◆ options

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

Optional parameters.

  • repartition_graph_new_graph_name: If a non-empty value is specified, the original graph will be kept (non-default behavior) and a new balanced graph will be created under this given name. When the value is empty (default), the generated ‘balanced’ graph will replace the original ‘unbalanced’ graph under the same graph name. The default value is ”.
  • repartition_graph_source_node: The distributed shortest path solve is run from this source node to all the nodes in the graph to create balanced partitions using the iso-distance levels of the solution. The source node is selected by the rebalance algorithm automatically (default case when the value is an empty string). Otherwise, the user specified node is used as the source. The default value is ”.

The default value is an empty map.

Definition at line 107 of file repartition_graph.h.

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