Skip to main content

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

​
Static 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.
 
const string RECREATE = “recreate”
 If set to TRUE and the graph (using CreateGraphRequest.graph_name) already exists, the graph is deleted and recreated.
 
const string TRUE = “true”
 A boolean constant for the CreateGraphRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the CreateGraphRequest.Options options.
 
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).
 
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).
 
const string GRAPH_TABLE = “graph_table”
 If specified, the created graph is also created as a table with the given name, in [schema_name.
 
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.
 
const string IS_PARTITIONED = “is_partitioned”
 
const string SERVER_ID = “server_id”
 Indicates which graph server(s) to send the request to.
 
const string USE_RTREE = “use_rtree”
 Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges.
 
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.
 
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.
 
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.
 

​
Detailed Description

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

Optional parameters.

Definition at line 48 of file CreateGraph.cs.

​
Member Data Documentation

​
◆ ADD_TABLE_MONITOR

const string kinetica.CreateGraphRequest.Options.ADD_TABLE_MONITOR = “add_table_monitor”
 static

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. Supported values:

The default value is FALSE.

Definition at line 134 of file CreateGraph.cs.

​
◆ ADD_TURNS

const string kinetica.CreateGraphRequest.Options.ADD_TURNS = “add_turns”
 static

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 166 of file CreateGraph.cs.

​
◆ ALLOW_MULTIPLE_EDGES

const string kinetica.CreateGraphRequest.Options.ALLOW_MULTIPLE_EDGES = “allow_multiple_edges”
 static

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 229 of file CreateGraph.cs.

​
◆ EMBEDDING_TABLE

const string kinetica.CreateGraphRequest.Options.EMBEDDING_TABLE = “embedding_table”
 static

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 235 of file CreateGraph.cs.

​
◆ FALSE

const string kinetica.CreateGraphRequest.Options.FALSE = “false”
 static

A boolean constant for the CreateGraphRequest.Options options.

Definition at line 84 of file CreateGraph.cs.

​
◆ GRAPH_TABLE

const string kinetica.CreateGraphRequest.Options.GRAPH_TABLE = “graph_table”
 static

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 146 of file CreateGraph.cs.

​
◆ IS_PARTITIONED

const string kinetica.CreateGraphRequest.Options.IS_PARTITIONED = “is_partitioned”
 static

Supported values:

The default value is FALSE.

Definition at line 182 of file CreateGraph.cs.

​
◆ LABEL_DELIMITER

const string kinetica.CreateGraphRequest.Options.LABEL_DELIMITER = “label_delimiter”
 static

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 211 of file CreateGraph.cs.

​
◆ MERGE_TOLERANCE

const string kinetica.CreateGraphRequest.Options.MERGE_TOLERANCE = “merge_tolerance”
 static

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 56 of file CreateGraph.cs.

​
◆ RECREATE

const string kinetica.CreateGraphRequest.Options.RECREATE = “recreate”
 static

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

Supported values:

The default value is FALSE.

Definition at line 76 of file CreateGraph.cs.

​
◆ SAVE_PERSIST

const string kinetica.CreateGraphRequest.Options.SAVE_PERSIST = “save_persist”
 static

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 108 of file CreateGraph.cs.

​
◆ SERVER_ID

const string kinetica.CreateGraphRequest.Options.SERVER_ID = “server_id”
 static

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 188 of file CreateGraph.cs.

​
◆ TRUE

const string kinetica.CreateGraphRequest.Options.TRUE = “true”
 static

A boolean constant for the CreateGraphRequest.Options options.

Definition at line 80 of file CreateGraph.cs.

​
◆ USE_RTREE

const string kinetica.CreateGraphRequest.Options.USE_RTREE = “use_rtree”
 static

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 205 of file CreateGraph.cs.

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