Kinetica   C#   API  Version 7.2.3.1
CreateGraphRequest.Options Struct Reference

A set of string constants for the parameter options. 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"
 
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...
 
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 42 of file CreateGraph.cs.

Member Data Documentation

◆ ADD_TABLE_MONITOR

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

Supported values:

The default value is FALSE.

Definition at line 102 of file CreateGraph.cs.

◆ ADD_TURNS

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

Supported values:

The default value is FALSE.

Definition at line 130 of file CreateGraph.cs.

◆ ALLOW_MULTIPLE_EDGES

const string 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 186 of file CreateGraph.cs.

◆ EMBEDDING_TABLE

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

◆ FALSE

const string CreateGraphRequest.Options.FALSE = "false"

Definition at line 69 of file CreateGraph.cs.

◆ GRAPH_TABLE

const string 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 114 of file CreateGraph.cs.

◆ IS_PARTITIONED

const string CreateGraphRequest.Options.IS_PARTITIONED = "is_partitioned"

Supported values:

The default value is FALSE.

Definition at line 143 of file CreateGraph.cs.

◆ LABEL_DELIMITER

const string 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 170 of file CreateGraph.cs.

◆ MERGE_TOLERANCE

const string 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 50 of file CreateGraph.cs.

◆ RECREATE

const string 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 66 of file CreateGraph.cs.

◆ SAVE_PERSIST

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

Supported values:

The default value is FALSE.

Definition at line 86 of file CreateGraph.cs.

◆ SERVER_ID

const string 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 149 of file CreateGraph.cs.

◆ TRUE

const string CreateGraphRequest.Options.TRUE = "true"

Definition at line 68 of file CreateGraph.cs.

◆ USE_RTREE

const string 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 164 of file CreateGraph.cs.


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