> ## 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.

# /modify/graph

```
URL: http://<db.host>:<db.port>/modify/graph
```

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](../../graph_solver/network_graph_solver/) concepts
documentation, and [Graph REST Tutorial](../../guides/graph_rest_guide/)
before using this endpoint.

## Input Parameter Description

<ParamField body="graph_name" type="string">
  Name of the graph resource to modify.
</ParamField>

<ParamField body="nodes" type="array of strings">
  Nodes with which to update existing input parameter *nodes* in graph specified by input parameter *graph\_name*. Review [Nodes](../../graph_solver/network_graph_solver/#nodes) for more information. Nodes must be specified using [identifiers](../../graph_solver/network_graph_solver/#identifiers); identifiers are grouped as [combinations](../../graph_solver/network_graph_solver/#id-combos). 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.
</ParamField>

<ParamField body="edges" type="array of strings">
  Edges with which to update existing input parameter *edges* in graph specified by input parameter *graph\_name*. Review [Edges](../../graph_solver/network_graph_solver/#edges) for more information. Edges must be specified using [identifiers](../../graph_solver/network_graph_solver/#identifiers); identifiers are grouped as [combinations](../../graph_solver/network_graph_solver/#id-combos). 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.
</ParamField>

<ParamField body="weights" type="array of strings">
  Weights with which to update existing input parameter *weights* in graph specified by input parameter *graph\_name*. Review [Weights](../../graph_solver/network_graph_solver/#graph-weights) for more information. Weights must be specified using [identifiers](../../graph_solver/network_graph_solver/#identifiers); identifiers are grouped as [combinations](../../graph_solver/network_graph_solver/#id-combos). 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.
</ParamField>

<ParamField body="restrictions" type="array of strings">
  Restrictions with which to update existing input parameter *restrictions* in graph specified by input parameter *graph\_name*. Review [Restrictions](../../graph_solver/network_graph_solver/#graph-restrictions) for more information. Restrictions must be specified using [identifiers](../../graph_solver/network_graph_solver/#identifiers); identifiers are grouped as [combinations](../../graph_solver/network_graph_solver/#id-combos). 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.
</ParamField>

<ParamField body="options" type="map of string to strings">
  Optional parameters.

  The default value is an empty map ( \{} ).

  <Expandable title="options">
    <ParamField body="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.
    </ParamField>

    <ParamField body="export_create_results">
      If set to *true*, returns the graph topology in the response as arrays.

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="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.

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="save_persist">
      If set to *true*, the graph will be saved in the persist directory (see the [config reference](../../config/) for more information). If set to *false*, the graph will be removed when the graph server is shutdown.

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="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](/content/api/rest/create_tablemonitor_rest).

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="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](../../concepts/tables/#table-name-resolution) and meeting [table naming criteria](../../concepts/tables/#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 ''.
    </ParamField>

    <ParamField body="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.

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="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).

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="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`.
    </ParamField>

    <ParamField body="use_rtree">
      Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges.

      The default value is `true`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="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 ''.
    </ParamField>

    <ParamField body="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.

      The default value is `true`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="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 ''.
    </ParamField>
  </Expandable>
</ParamField>

## Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query.  Here is a description of the various fields of the wrapper:

<ResponseField name="status" type="String">
  'OK' or 'ERROR'
</ResponseField>

<ResponseField name="message" type="String">
  Empty if success or an error message
</ResponseField>

<ResponseField name="data_type" type="String">
  'modify\_graph\_response' or 'none' in case of an error
</ResponseField>

<ResponseField name="data" type="String">
  Empty string
</ResponseField>

<ResponseField name="data_str" type="JSON or String">
  This embedded JSON represents the result of the /modify/graph endpoint:

  <Expandable title="data_str">
    <ResponseField name="result" type="boolean">
      Indicates a successful modification on all servers.
    </ResponseField>

    <ResponseField name="num_nodes" type="long">
      Total number of nodes in the graph.
    </ResponseField>

    <ResponseField name="num_edges" type="long">
      Total number of edges in the graph.
    </ResponseField>

    <ResponseField name="edges_ids" type="array of longs">
      Edges given as pairs of node indices. Only populated if *export\_create\_results* is set to *true*.
    </ResponseField>

    <ResponseField name="info" type="map of string to strings">
      Additional information.
    </ResponseField>
  </Expandable>

  Empty string in case of an error.
</ResponseField>