> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.ModifyGraphRequest > kinetica.ModifyGraphRequest — Kinetica C# API

A set of parameters for Kinetica.modifyGraph. More...

Inheritance diagram for kinetica.ModifyGraphRequest:
Collaboration diagram for kinetica.ModifyGraphRequest:

Classes
struct   Options
  A set of string constants for the parameter ModifyGraphRequest.options. More...
 

Public Member Functions
  ModifyGraphRequest ()
  Constructs a ModifyGraphRequest object with default parameters.
 
  ModifyGraphRequest (string graph\_name, IList\< string > nodes, IList\< string > edges, IList\< string > weights, IList\< string > restrictions, IDictionary\< string, string > options=null)
  Constructs a ModifyGraphRequest object with the specified parameters.
 
  ModifyGraphRequest ()
  Constructs a ModifyGraphRequest object with default parameters.
 
  ModifyGraphRequest (string graph\_name, IList\< string > nodes, IList\< string > edges, IList\< string > weights, IList\< string > restrictions, IDictionary\< string, string > options=null)
  Constructs a ModifyGraphRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  graph\_name \[get, set]
  Name of the graph resource to modify.
 
IList\< string >  nodes = new List\() \[get, set]
  Nodes with which to update existing ModifyGraphRequest.nodes in graph specified by ModifyGraphRequest.graph\_name.
 
IList\< string >  edges = new List\() \[get, set]
  Edges with which to update existing ModifyGraphRequest.edges in graph specified by ModifyGraphRequest.graph\_name.
 
IList\< string >  weights = new List\() \[get, set]
  Weights with which to update existing ModifyGraphRequest.weights in graph specified by ModifyGraphRequest.graph\_name.
 
IList\< string >  restrictions = new List\() \[get, set]
  Restrictions with which to update existing ModifyGraphRequest.restrictions in graph specified by ModifyGraphRequest.graph\_name.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

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.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.modifyGraph.

Update an existing graph network using given nodes, edges, weights, restrictions, and options.

IMPORTANT: It's highly recommended that you review the Graphs and Solvers concepts documentation, and Graph REST Tutorial before using this endpoint.

Definition at line 21 of file ModifyGraph.cs.

Constructor & Destructor Documentation

◆ ModifyGraphRequest() \[1/4]

kinetica.ModifyGraphRequest.ModifyGraphRequest ( )
inline

Constructs a ModifyGraphRequest object with default parameters.

Definition at line 604 of file ModifyGraph.cs.

◆ ModifyGraphRequest() \[2/4]

kinetica.ModifyGraphRequest.ModifyGraphRequest ( string graph\_name,
IList\< string > nodes,
IList\< string > edges,
IList\< string > weights,
IList\< string > restrictions,
IDictionary\< string, string > options = null )
inline

Constructs a ModifyGraphRequest object with the specified parameters.

Parameters
graph\_name Name of the graph resource to modify.
nodes Nodes with which to update existing nodes in graph specified by graph\_name . Review Nodes for more information. 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 raw values, e.g., '{"{"}9, 10, 11{"}"} AS NODE\_ID'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
edges Edges with which to update existing edges in graph specified by graph\_name . Review Edges for more information. 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 raw values, e.g., "{"{"}'family', 'coworker'{"}"} AS EDGE\_LABEL". If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
weights Weights with which to update existing weights in graph specified by graph\_name . Review Weights for more information. 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 raw values, e.g., '{"{"}4, 15{"}"} AS WEIGHTS\_VALUESPECIFIED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
restrictions Restrictions with which to update existing restrictions in graph specified by graph\_name . Review Restrictions for more information. 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 raw values, e.g., '{"{"}0, 0, 0, 1{"}"} AS RESTRICTIONS\_ONOFFCOMPARED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
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.
  • EXPORT\_CREATE\_RESULTS: If set to TRUE, returns the graph topology in the response as arrays. Supported values: 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: 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 Kinetica.createTableMonitor. 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. 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 ''.
  • 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: 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: 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'.
  • 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.
  • 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 ''.
The default value is an empty Dictionary.

Definition at line 947 of file ModifyGraph.cs.

◆ ModifyGraphRequest() \[3/4]

kinetica.ModifyGraphRequest.ModifyGraphRequest ( )
inline

Constructs a ModifyGraphRequest object with default parameters.

Definition at line 604 of file ModifyGraph.cs.

◆ ModifyGraphRequest() \[4/4]

kinetica.ModifyGraphRequest.ModifyGraphRequest ( string graph\_name,
IList\< string > nodes,
IList\< string > edges,
IList\< string > weights,
IList\< string > restrictions,
IDictionary\< string, string > options = null )
inline

Constructs a ModifyGraphRequest object with the specified parameters.

Parameters
graph\_name Name of the graph resource to modify.
nodes Nodes with which to update existing nodes in graph specified by graph\_name . Review Nodes for more information. 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 raw values, e.g., '{"{"}9, 10, 11{"}"} AS NODE\_ID'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
edges Edges with which to update existing edges in graph specified by graph\_name . Review Edges for more information. 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 raw values, e.g., "{"{"}'family', 'coworker'{"}"} AS EDGE\_LABEL". If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
weights Weights with which to update existing weights in graph specified by graph\_name . Review Weights for more information. 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 raw values, e.g., '{"{"}4, 15{"}"} AS WEIGHTS\_VALUESPECIFIED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
restrictions Restrictions with which to update existing restrictions in graph specified by graph\_name . Review Restrictions for more information. 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 raw values, e.g., '{"{"}0, 0, 0, 1{"}"} AS RESTRICTIONS\_ONOFFCOMPARED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
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.
  • EXPORT\_CREATE\_RESULTS: If set to TRUE, returns the graph topology in the response as arrays. Supported values: 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: 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 Kinetica.createTableMonitor. 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. 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 ''.
  • 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: 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: 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'.
  • 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.
  • 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 ''.
The default value is an empty Dictionary.

Definition at line 947 of file ModifyGraph.cs.

Property Documentation

◆ edges

IList\< string > kinetica.ModifyGraphRequest.edges = new List\()
getset

Edges with which to update existing ModifyGraphRequest.edges in graph specified by ModifyGraphRequest.graph\_name.

Review Edges for more information. 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 raw values, e.g., "{"{"}'family', 'coworker'{"}"} AS EDGE\_LABEL". If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.

Definition at line 287 of file ModifyGraph.cs.

◆ graph\_name

string kinetica.ModifyGraphRequest.graph\_name
getset

Name of the graph resource to modify.

Definition at line 247 of file ModifyGraph.cs.

◆ nodes

IList\< string > kinetica.ModifyGraphRequest.nodes = new List\()
getset

Nodes with which to update existing ModifyGraphRequest.nodes in graph specified by ModifyGraphRequest.graph\_name.

Review Nodes for more information. 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 raw values, e.g., '{"{"}9, 10, 11{"}"} AS NODE\_ID'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.

Definition at line 267 of file ModifyGraph.cs.

◆ options

IDictionary\< string, string > kinetica.ModifyGraphRequest.options = new Dictionary\()
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.
  • EXPORT\_CREATE\_RESULTS: If set to TRUE, returns the graph topology in the response as arrays. Supported values: 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: 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 Kinetica.createTableMonitor. 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. 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 ''.
  • 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: 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: 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'.
  • 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.
  • 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 ''.

The default value is an empty Dictionary.

Definition at line 600 of file ModifyGraph.cs.

◆ restrictions

IList\< string > kinetica.ModifyGraphRequest.restrictions = new List\()
getset

Restrictions with which to update existing ModifyGraphRequest.restrictions in graph specified by ModifyGraphRequest.graph\_name.

Review Restrictions for more information. 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 raw values, e.g., '{"{"}0, 0, 0, 1{"}"} AS RESTRICTIONS\_ONOFFCOMPARED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.

Definition at line 329 of file ModifyGraph.cs.

◆ weights

IList\< string > kinetica.ModifyGraphRequest.weights = new List\()
getset

Weights with which to update existing ModifyGraphRequest.weights in graph specified by ModifyGraphRequest.graph\_name.

Review Weights for more information. 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 raw values, e.g., '{"{"}4, 15{"}"} AS WEIGHTS\_VALUESPECIFIED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.

Definition at line 308 of file ModifyGraph.cs.

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