Kinetica   C#   API  Version 7.2.3.0
kinetica.ModifyGraphRequest.Options Struct Reference

A set of string constants for the parameter options. More...

Public Attributes

const string RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value"
 Value-based restriction comparison. More...
 
const string EXPORT_CREATE_RESULTS = "export_create_results"
 If set to TRUE, returns the graph topology in the response as arrays. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string ENABLE_GRAPH_DRAW = "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. More...
 
const string SAVE_PERSIST = "save_persist"
 If set to TRUE, the graph will be saved in the persist directory (see the config reference for more information). More...
 
const string ADD_TABLE_MONITOR = "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). More...
 
const string GRAPH_TABLE = "graph_table"
 If specified, the created graph is also created as a table with the given name, in [schema_name. More...
 
const string REMOVE_LABEL_ONLY = "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. More...
 
const string ADD_TURNS = "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. More...
 
const string TURN_ANGLE = "turn_angle"
 Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. More...
 
const string USE_RTREE = "use_rtree"
 Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. More...
 
const string LABEL_DELIMITER = "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. More...
 
const string ALLOW_MULTIPLE_EDGES = "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. More...
 
const string EMBEDDING_TABLE = "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. More...
 

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 26 of file ModifyGraph.cs.

Member Data Documentation

◆ ADD_TABLE_MONITOR

const string kinetica.ModifyGraphRequest.Options.ADD_TABLE_MONITOR = "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).

Supported values:

The default value is FALSE.

Definition at line 105 of file ModifyGraph.cs.

◆ ADD_TURNS

const string kinetica.ModifyGraphRequest.Options.ADD_TURNS = "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.

Supported values:

The default value is FALSE.

Definition at line 150 of file ModifyGraph.cs.

◆ ALLOW_MULTIPLE_EDGES

const string kinetica.ModifyGraphRequest.Options.ALLOW_MULTIPLE_EDGES = "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:

The default value is TRUE.

Definition at line 198 of file ModifyGraph.cs.

◆ EMBEDDING_TABLE

const string kinetica.ModifyGraphRequest.Options.EMBEDDING_TABLE = "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 ''.

Definition at line 205 of file ModifyGraph.cs.

◆ ENABLE_GRAPH_DRAW

const string kinetica.ModifyGraphRequest.Options.ENABLE_GRAPH_DRAW = "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:

The default value is FALSE.

Definition at line 71 of file ModifyGraph.cs.

◆ EXPORT_CREATE_RESULTS

const string kinetica.ModifyGraphRequest.Options.EXPORT_CREATE_RESULTS = "export_create_results"

If set to TRUE, returns the graph topology in the response as arrays.

Supported values:

The default value is FALSE.

Definition at line 48 of file ModifyGraph.cs.

◆ FALSE

const string kinetica.ModifyGraphRequest.Options.FALSE = "false"

Definition at line 51 of file ModifyGraph.cs.

◆ GRAPH_TABLE

const string kinetica.ModifyGraphRequest.Options.GRAPH_TABLE = "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.

This 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 ''.

Definition at line 118 of file ModifyGraph.cs.

◆ LABEL_DELIMITER

const string kinetica.ModifyGraphRequest.Options.LABEL_DELIMITER = "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 ''.

Definition at line 182 of file ModifyGraph.cs.

◆ REMOVE_LABEL_ONLY

const string kinetica.ModifyGraphRequest.Options.REMOVE_LABEL_ONLY = "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.

Supported values:

The default value is FALSE.

Definition at line 134 of file ModifyGraph.cs.

◆ RESTRICTION_THRESHOLD_VALUE

const string kinetica.ModifyGraphRequest.Options.RESTRICTION_THRESHOLD_VALUE = "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.

Definition at line 33 of file ModifyGraph.cs.

◆ SAVE_PERSIST

const string kinetica.ModifyGraphRequest.Options.SAVE_PERSIST = "save_persist"

If set to TRUE, the graph will be saved in the persist directory (see the config reference for more information).

Supported values:

The default value is FALSE.

Definition at line 88 of file ModifyGraph.cs.

◆ TRUE

const string kinetica.ModifyGraphRequest.Options.TRUE = "true"

Definition at line 50 of file ModifyGraph.cs.

◆ TURN_ANGLE

const string kinetica.ModifyGraphRequest.Options.TURN_ANGLE = "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'.

Definition at line 161 of file ModifyGraph.cs.

◆ USE_RTREE

const string kinetica.ModifyGraphRequest.Options.USE_RTREE = "use_rtree"

Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges.

Supported values:

The default value is TRUE.

Definition at line 176 of file ModifyGraph.cs.


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