create\_graph(graph\_name=None, directed\_graph=True, nodes=None, edges=None, weights=None, restrictions=None, options={"{"}{"}"})\[source]

Creates a new graph network using given nodes, edges, weights, and restrictions.

IMPORTANT: It’s highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Parameters

graph\_name (str) –

Name of the graph resource to generate.

directed\_graph (bool) –

If set to true, the graph will be directed. If set to false, the graph will not be directed. Consult Directed Graphs for more details. Allowed values are:

True
False

The default value is True.

nodes (list of str) –

Nodes represent fundamental topological units of a graph. 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 constant values, e.g., ‘{"{"}9, 10, 11{"}"} AS NODE\_ID’. If using constant values in an identifier combination, the number of values specified must match across the combination. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

edges (list of str) –

Edges represent the required fundamental topological unit of a graph that typically connect nodes. 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 constant values, e.g., “{"{"}‘family’, ‘coworker’{"}"} AS EDGE\_LABEL”. If using constant values in an identifier combination, the number of values specified must match across the combination. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

weights (list of str) –

Weights represent a method of informing the graph solver of the cost of including a given edge in a solution. 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 constant values, e.g., ‘{"{"}4, 15{"}"} AS WEIGHTS\_VALUESPECIFIED’. If using constant values in an identifier combination, the number of values specified must match across the combination. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

restrictions (list of str) –

Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. 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 constant values, e.g., ‘{"{"}0, 0, 0, 1{"}"} AS RESTRICTIONS\_ONOFFCOMPARED’. If using constant values in an identifier combination, the number of values specified must match across the combination. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

options (dict of str to str) –

Optional parameters. Allowed keys are:

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 input parameter graph\_name) already exists, the graph is deleted and recreated. Allowed values are:
- true
- false
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. Allowed values are:
- true
- false
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 GPUdb.create\_table\_monitor(). Allowed values are:
- true
- false
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). Allowed values are:
- true
- false
The default value is ‘false’.
is\_partitioned – Allowed values are:
- true
- false
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. Allowed values are:
- true
- false
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. Allowed values are:
- true
- false
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 dict ( {"{"}{"}"} ).

Returns

A dict with the following entries–

result (bool) –

Indicates a successful creation on all servers.

num\_nodes (long) –

Total number of nodes created.

num\_edges (long) –

Total number of edges created.

edges\_ids (list of longs) –

\[Deprecated] Edges given as pairs of node indices. Only populated if export\_create\_results internal option is set to true.

info (dict of str to str) –

Additional information.