Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.CreateGraphRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string MERGE_TOLERANCE = "merge_tolerance"
 If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. More...
 
const string RECREATE = "recreate"
 If set to true and the graph (using graph_name) already exists, the graph is deleted and recreated. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
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 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 IS_PARTITIONED = "is_partitioned"
 Supported values:

The default value is FALSE. More...

 
const string SERVER_ID = "server_id"
 Indicates which graph server(s) to send the request to. 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...
 

Detailed Description

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 ) already exists, the graph is deleted and recreated. Supported values: 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: 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: 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: The default value is FALSE.
  • IS_PARTITIONED: Supported values: 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: 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: The default value is TRUE.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 248 of file CreateGraph.cs.

Member Data Documentation

const string kinetica.CreateGraphRequest.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).

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 Kinetica.createTableMonitor(string,IDictionary{string, string}). Supported values:

The default value is FALSE.

Definition at line 321 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.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.

(increases the total number of edges). Supported values:

The default value is FALSE.

Definition at line 352 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.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 414 of file CreateGraph.cs.

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

Definition at line 276 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.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. 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 ''.

Definition at line 333 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.IS_PARTITIONED = "is_partitioned"

Supported values:

The default value is FALSE.

Definition at line 368 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.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 396 of file CreateGraph.cs.

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

Definition at line 256 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.RECREATE = "recreate"

If set to true and the graph (using graph_name) already exists, the graph is deleted and recreated.

Supported values:

The default value is FALSE.

Definition at line 274 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.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).

If set to false, the graph will be removed when the graph server is shutdown. Supported values:

The default value is FALSE.

Definition at line 297 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.SERVER_ID = "server_id"

Indicates which graph server(s) to send the request to.

Default is to send to the server with the most available memory.

Definition at line 373 of file CreateGraph.cs.

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

Definition at line 275 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.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 390 of file CreateGraph.cs.

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