com.gpudb.protocol

Class CreateGraphRequest

java.lang.Object

com.gpudb.protocol.CreateGraphRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class CreateGraphRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.createGraph.

Creates a new graph network using given nodes, edges, weights, and restrictions.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateGraphRequest.DirectedGraph A set of string constants for the CreateGraphRequest parameter directedGraph.
static class	CreateGraphRequest.Options A set of string constants for the CreateGraphRequest parameter options.

Constructor Summary

Constructors

Constructor and Description
CreateGraphRequest() Constructs a CreateGraphRequest object with default parameters.
CreateGraphRequest(String graphName, boolean directedGraph, List<String> nodes, List<String> edges, List<String> weights, List<String> restrictions, Map<String,String> options) Constructs a CreateGraphRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
boolean	getDirectedGraph() If set to TRUE, the graph will be directed.
List<String>	getEdges() Edges represent the required fundamental topological unit of a graph that typically connect nodes.
String	getGraphName() Name of the graph resource to generate.
List<String>	getNodes() Nodes represent fundamental topological units of a graph.
Map<String,String>	getOptions() Optional parameters.
List<String>	getRestrictions() Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution.
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
List<String>	getWeights() Weights represent a method of informing the graph solver of the cost of including a given edge in a solution.
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
CreateGraphRequest	setDirectedGraph(boolean directedGraph) If set to TRUE, the graph will be directed.
CreateGraphRequest	setEdges(List<String> edges) Edges represent the required fundamental topological unit of a graph that typically connect nodes.
CreateGraphRequest	setGraphName(String graphName) Name of the graph resource to generate.
CreateGraphRequest	setNodes(List<String> nodes) Nodes represent fundamental topological units of a graph.
CreateGraphRequest	setOptions(Map<String,String> options) Optional parameters.
CreateGraphRequest	setRestrictions(List<String> restrictions) Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution.
CreateGraphRequest	setWeights(List<String> weights) Weights represent a method of informing the graph solver of the cost of including a given edge in a solution.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateGraphRequest

public CreateGraphRequest()

Constructs a CreateGraphRequest object with default parameters.

CreateGraphRequest

public CreateGraphRequest(String graphName,
                          boolean directedGraph,
                          List<String> nodes,
                          List<String> edges,
                          List<String> weights,
                          List<String> restrictions,
                          Map<String,String> options)

Constructs a CreateGraphRequest object with the specified parameters.

Parameters:

graphName - Name of the graph resource to generate.

directedGraph - If set to TRUE, the graph will be directed. If set to FALSE, the graph will not be directed. Consult Directed Graphs for more details. Supported values:

• true
• false

The default value is true.

nodes - Nodes represent fundamental topological units of a graph. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or constant values, e.g., '{9, 10, 11} AS NODE_ID'. If using constant values in an identifier combination, the number of values specified must match across the combination.

edges - Edges represent the required fundamental topological unit of a graph that typically connect nodes. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or constant values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using constant values in an identifier combination, the number of values specified must match across the combination.

weights - Weights represent a method of informing the graph solver of the cost of including a given edge in a solution. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using constant values in an identifier combination, the number of values specified must match across the combination.

restrictions - Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. 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 constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination.

options - Optional parameters.

• MERGE_TOLERANCE: If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. If nodes are within the tolerance of each other, they will be merged as a single node. The default value is '1.0E-5'.
• RECREATE: If set to TRUE and the graph (using graphName) already exists, the graph is deleted and recreated. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SAVE_PERSIST: If set to TRUE, the graph will be saved in the persist directory (see the config reference for more information). If set to FALSE, the graph will be removed when the graph server is shutdown. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ADD_TABLE_MONITOR: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if SAVE_PERSIST is also set to TRUE, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see GPUdb.createTableMonitor. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GRAPH_TABLE: If specified, the created graph is also created as a table with the given name, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. The table will have the following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
• ADD_TURNS: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• IS_PARTITIONED: Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SERVER_ID: Indicates which graph server(s) to send the request to. Default is to send to the server with the most available memory.
• USE_RTREE: Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• LABEL_DELIMITER: If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. The default value is ''.
• ALLOW_MULTIPLE_EDGES: Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• EMBEDDING_TABLE: If table exists (should be generated by the match/graph match_embedding solver), the vector embeddings for the newly inserted nodes will be appended into this table. The default value is ''.

The default value is an empty Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

The schema for the class.

getGraphName

public String getGraphName()

Name of the graph resource to generate.

Returns:

The current value of graphName.

setGraphName

public CreateGraphRequest setGraphName(String graphName)

Name of the graph resource to generate.

Parameters:

graphName - The new value for graphName.

Returns:

this to mimic the builder pattern.

getDirectedGraph

public boolean getDirectedGraph()

If set to TRUE, the graph will be directed. If set to FALSE, the graph will not be directed. Consult Directed Graphs for more details. Supported values:

• true
• false

The default value is true.

Returns:

The current value of directedGraph.

setDirectedGraph

public CreateGraphRequest setDirectedGraph(boolean directedGraph)

If set to TRUE, the graph will be directed. If set to FALSE, the graph will not be directed. Consult Directed Graphs for more details. Supported values:

• true
• false

The default value is true.

Parameters:

directedGraph - The new value for directedGraph.

Returns:

this to mimic the builder pattern.

getNodes

public List<String> getNodes()

Nodes represent fundamental topological units of a graph. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or constant values, e.g., '{9, 10, 11} AS NODE_ID'. If using constant values in an identifier combination, the number of values specified must match across the combination.

Returns:

The current value of nodes.

setNodes

public CreateGraphRequest setNodes(List<String> nodes)

Nodes represent fundamental topological units of a graph. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or constant values, e.g., '{9, 10, 11} AS NODE_ID'. If using constant values in an identifier combination, the number of values specified must match across the combination.

Parameters:

nodes - The new value for nodes.

Returns:

this to mimic the builder pattern.

getEdges

public List<String> getEdges()

Edges represent the required fundamental topological unit of a graph that typically connect nodes. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or constant values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using constant values in an identifier combination, the number of values specified must match across the combination.

Returns:

The current value of edges.

setEdges

public CreateGraphRequest setEdges(List<String> edges)

Edges represent the required fundamental topological unit of a graph that typically connect nodes. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or constant values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using constant values in an identifier combination, the number of values specified must match across the combination.

Parameters:

edges - The new value for edges.

Returns:

this to mimic the builder pattern.

getWeights

public List<String> getWeights()

Weights represent a method of informing the graph solver of the cost of including a given edge in a solution. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using constant values in an identifier combination, the number of values specified must match across the combination.

Returns:

The current value of weights.

setWeights

public CreateGraphRequest setWeights(List<String> weights)

Weights represent a method of informing the graph solver of the cost of including a given edge in a solution. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using constant values in an identifier combination, the number of values specified must match across the combination.

Parameters:

weights - The new value for weights.

Returns:

this to mimic the builder pattern.

getRestrictions

public List<String> getRestrictions()

Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. 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 constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination.

Returns:

The current value of restrictions.

setRestrictions

public CreateGraphRequest setRestrictions(List<String> restrictions)

Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. 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 constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination.

Parameters:

restrictions - The new value for restrictions.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• MERGE_TOLERANCE: If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. If nodes are within the tolerance of each other, they will be merged as a single node. The default value is '1.0E-5'.
• RECREATE: If set to TRUE and the graph (using graphName) already exists, the graph is deleted and recreated. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SAVE_PERSIST: If set to TRUE, the graph will be saved in the persist directory (see the config reference for more information). If set to FALSE, the graph will be removed when the graph server is shutdown. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ADD_TABLE_MONITOR: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if SAVE_PERSIST is also set to TRUE, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see GPUdb.createTableMonitor. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GRAPH_TABLE: If specified, the created graph is also created as a table with the given name, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. The table will have the following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
• ADD_TURNS: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• IS_PARTITIONED: Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SERVER_ID: Indicates which graph server(s) to send the request to. Default is to send to the server with the most available memory.
• USE_RTREE: Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• LABEL_DELIMITER: If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. The default value is ''.
• ALLOW_MULTIPLE_EDGES: Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• EMBEDDING_TABLE: If table exists (should be generated by the match/graph match_embedding solver), the vector embeddings for the newly inserted nodes will be appended into this table. The default value is ''.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

public CreateGraphRequest setOptions(Map<String,String> options)

Optional parameters.

• MERGE_TOLERANCE: If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. If nodes are within the tolerance of each other, they will be merged as a single node. The default value is '1.0E-5'.
• RECREATE: If set to TRUE and the graph (using graphName) already exists, the graph is deleted and recreated. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SAVE_PERSIST: If set to TRUE, the graph will be saved in the persist directory (see the config reference for more information). If set to FALSE, the graph will be removed when the graph server is shutdown. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ADD_TABLE_MONITOR: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if SAVE_PERSIST is also set to TRUE, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see GPUdb.createTableMonitor. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GRAPH_TABLE: If specified, the created graph is also created as a table with the given name, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. The table will have the following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
• ADD_TURNS: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• IS_PARTITIONED: Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SERVER_ID: Indicates which graph server(s) to send the request to. Default is to send to the server with the most available memory.
• USE_RTREE: Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• LABEL_DELIMITER: If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. The default value is ''.
• ALLOW_MULTIPLE_EDGES: Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• EMBEDDING_TABLE: If table exists (should be generated by the match/graph match_embedding solver), the vector embeddings for the newly inserted nodes will be appended into this table. The default value is ''.

The default value is an empty Map.

Parameters:

options - The new value for options.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

The schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object