A set of parameters for Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}). More...

Inheritance diagram for kinetica.CreateGraphRequest:

Collaboration diagram for kinetica.CreateGraphRequest:

Classes
struct	DirectedGraph
	If set to true, the graph will be directed. More...

struct	Options
	Optional parameters. More...

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

	CreateGraphRequest (string graph_name, bool?directed_graph, IList< string > nodes, IList< string > edges, IList< string > weights, IList< string > restrictions, IDictionary< string, string > options=null)
	Constructs a CreateGraphRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	graph_name `[get, set]`
	Name of the graph resource to generate. More...

bool	directed_graph `[get, set]`
	If set to true, the graph will be directed. More...

IList< string >	nodes = true `[get, set]`
	Nodes represent fundamental topological units of a graph. More...

IList< string >	edges = new List<string>() `[get, set]`
	Edges represent the required fundamental topological unit of a graph that typically connect nodes. More...

IList< string >	weights = new List<string>() `[get, set]`
	Weights represent a method of informing the graph solver of the cost of including a given edge in a solution. More...

IList< string >	restrictions = new List<string>() `[get, set]`
	Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. More...

IDictionary< string, string >	options = new List<string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}).

Creates a new graph network using given nodes, edges, weights, and restrictions.
IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Definition at line 30 of file CreateGraph.cs.

Constructor & Destructor Documentation

kinetica.CreateGraphRequest.CreateGraphRequest ( )

inline

Constructs a CreateGraphRequest object with default parameters.

Definition at line 907 of file CreateGraph.cs.

kinetica.CreateGraphRequest.CreateGraphRequest	(	string	graph_name,
		bool?	directed_graph,
		IList< string >	nodes,
		IList< string >	edges,
		IList< string >	weights,
		IList< string >	restrictions,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateGraphRequest object with the specified parameters.

Parameters

graph_name	Name of the graph resource to generate.
directed_graph	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. RESTRICTION_THRESHOLD_VALUE: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the graph. 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-4'. MIN_X: Minimum x (longitude) value for spatial graph associations. The default value is '-180.0'. MAX_X: Maximum x (longitude) value for spatial graph associations. The default value is '180.0'. MIN_Y: Minimum y (latitude) value for spatial graph associations. The default value is '-90.0'. MAX_Y: Maximum y (latitude) value for spatial graph associations. The default value is '90.0'. RECREATE: If set to true and the graph (using ) already exists, the graph is deleted and recreated. Supported values: TRUE FALSE The default value is FALSE. MODIFY: If set to true, recreate is set to true, and the graph (specified using ) already exists, the graph is updated with the given components. Supported values: TRUE FALSE The default value is FALSE. EXPORT_CREATE_RESULTS: If set to true, returns the graph topology in the response as arrays. Supported values: TRUE FALSE The default value is FALSE. ENABLE_GRAPH_DRAW: If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed. 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. SYNC_DB: If set to true and save_persist is set to true, the graph will be fully reconstructed upon a database restart and be updated to align with any source table(s) updates made since the creation of the graph. If dynamic graph updates upon table inserts are desired, use add_table_monitor instead. 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 /create/tablemonitor. 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 and following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''. REMOVE_LABEL_ONLY: When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity. Otherwise (default), it'll delete the label AND the entity. Supported values: TRUE FALSE The default value is FALSE. 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. TURN_ANGLE: Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. It is the vertical deviation angle from the incoming edge to the intersection node. The larger the value, the larger the threshold for sharp turns and intersections; the smaller the value, the larger the threshold for right and left turns; 0 < turn_angle < 90. The default value is '60'. The default value is an empty Dictionary.

Definition at line 1258 of file CreateGraph.cs.

Property Documentation

bool kinetica.CreateGraphRequest.directed_graph

getset

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.

Definition at line 569 of file CreateGraph.cs.

IList<string> kinetica.CreateGraphRequest.edges = new List<string>()

getset

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.

Definition at line 604 of file CreateGraph.cs.

string kinetica.CreateGraphRequest.graph_name

getset

Name of the graph resource to generate.

Definition at line 549 of file CreateGraph.cs.

IList<string> kinetica.CreateGraphRequest.nodes = true

getset

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.

Definition at line 586 of file CreateGraph.cs.

IDictionary<string, string> kinetica.CreateGraphRequest.options = new List<string>()

getset

Optional parameters.

RESTRICTION_THRESHOLD_VALUE: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the graph.
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-4'.
MIN_X: Minimum x (longitude) value for spatial graph associations. The default value is '-180.0'.
MAX_X: Maximum x (longitude) value for spatial graph associations. The default value is '180.0'.
MIN_Y: Minimum y (latitude) value for spatial graph associations. The default value is '-90.0'.
MAX_Y: Maximum y (latitude) value for spatial graph associations. The default value is '90.0'.
RECREATE: If set to true and the graph (using ) already exists, the graph is deleted and recreated. Supported values:
- TRUE
- FALSE
The default value is FALSE.
MODIFY: If set to true, recreate is set to true, and the graph (specified using ) already exists, the graph is updated with the given components. Supported values:
- TRUE
- FALSE
The default value is FALSE.
EXPORT_CREATE_RESULTS: If set to true, returns the graph topology in the response as arrays. Supported values:
- TRUE
- FALSE
The default value is FALSE.
ENABLE_GRAPH_DRAW: If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed. 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.
SYNC_DB: If set to true and save_persist is set to true, the graph will be fully reconstructed upon a database restart and be updated to align with any source table(s) updates made since the creation of the graph. If dynamic graph updates upon table inserts are desired, use add_table_monitor instead. 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 /create/tablemonitor. 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 and following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
REMOVE_LABEL_ONLY: When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity. Otherwise (default), it'll delete the label AND the entity. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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.
TURN_ANGLE: Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. It is the vertical deviation angle from the incoming edge to the intersection node. The larger the value, the larger the threshold for sharp turns and intersections; the smaller the value, the larger the threshold for right and left turns; 0 < turn_angle < 90. The default value is '60'.

The default value is an empty Dictionary.

Definition at line 902 of file CreateGraph.cs.

IList<string> kinetica.CreateGraphRequest.restrictions = new List<string>()

getset

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.

Definition at line 642 of file CreateGraph.cs.

IList<string> kinetica.CreateGraphRequest.weights = new List<string>()

getset

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.

Definition at line 624 of file CreateGraph.cs.

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

Kinetica/Protocol/CreateGraph.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation