createGraph - Kinetica Docs

◆ createGraph() [1/4]

CreateGraphResponse gpudb::GPUdb::createGraph ( const CreateGraphRequest & request_ ) const

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

[in] request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

◆ createGraph() [2/4]

CreateGraphResponse & gpudb::GPUdb::createGraph	(	const CreateGraphRequest &	request_,
		CreateGraphResponse &	response_ ) const

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

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

◆ createGraph() [3/4]

CreateGraphResponse gpudb::GPUdb::createGraph	(	const std::string &	graphName,
		const bool	directedGraph,
		const std::vector< std::string > &	nodes,
		const std::vector< std::string > &	edges,
		const std::vector< std::string > &	weights,
		const std::vector< std::string > &	restrictions,
		const std::map< std::string, std::string > &	options ) const

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

[in]	graphName	Name of the graph resource to generate.
[in]	directedGraph	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. Supported values: true false The default value is true.
[in]	nodes	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.
[in]	edges	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.
[in]	weights	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.
[in]	restrictions	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.
[in]	options	Optional parameters. create_graph_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’. create_graph_recreate: If set to true and the graph (using graphName) already exists, the graph is deleted and recreated. Supported values: create_graph_true create_graph_false The default value is create_graph_false. create_graph_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: create_graph_true create_graph_false The default value is create_graph_false. create_graph_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 createTableMonitor. Supported values: create_graph_true create_graph_false The default value is create_graph_false. create_graph_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 ”. create_graph_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: create_graph_true create_graph_false The default value is create_graph_false. create_graph_is_partitioned: Supported values: create_graph_true create_graph_false The default value is create_graph_false. create_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to the server with the most available memory. create_graph_use_rtree: Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values: create_graph_true create_graph_false The default value is create_graph_true. create_graph_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 ”. create_graph_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: create_graph_true create_graph_false The default value is create_graph_true. create_graph_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 map.

Returns

Response object containing the result of the operation.

◆ createGraph() [4/4]

CreateGraphResponse & gpudb::GPUdb::createGraph	(	const std::string &	graphName,
		const bool	directedGraph,
		const std::vector< std::string > &	nodes,
		const std::vector< std::string > &	edges,
		const std::vector< std::string > &	weights,
		const std::vector< std::string > &	restrictions,
		const std::map< std::string, std::string > &	options,
		CreateGraphResponse &	response_ ) const

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

[in]	graphName	Name of the graph resource to generate.
[in]	directedGraph	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. Supported values: true false The default value is true.
[in]	nodes	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.
[in]	edges	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.
[in]	weights	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.
[in]	restrictions	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.
[in]	options	Optional parameters. create_graph_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’. create_graph_recreate: If set to true and the graph (using graphName) already exists, the graph is deleted and recreated. Supported values: create_graph_true create_graph_false The default value is create_graph_false. create_graph_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: create_graph_true create_graph_false The default value is create_graph_false. create_graph_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 createTableMonitor. Supported values: create_graph_true create_graph_false The default value is create_graph_false. create_graph_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 ”. create_graph_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: create_graph_true create_graph_false The default value is create_graph_false. create_graph_is_partitioned: Supported values: create_graph_true create_graph_false The default value is create_graph_false. create_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to the server with the most available memory. create_graph_use_rtree: Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values: create_graph_true create_graph_false The default value is create_graph_true. create_graph_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 ”. create_graph_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: create_graph_true create_graph_false The default value is create_graph_true. create_graph_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 map.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

​◆ createGraph() [1/4]

​◆ createGraph() [2/4]

​◆ createGraph() [3/4]

​◆ createGraph() [4/4]

◆ createGraph() [1/4]

◆ createGraph() [2/4]

◆ createGraph() [3/4]

◆ createGraph() [4/4]