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

Inheritance diagram for kinetica.CreateGraphRequest:

Collaboration diagram for kinetica.CreateGraphRequest:

Classes
struct	DirectedGraph
	A set of string constants for the parameter directed_graph. More...

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

Public Member Functions
	CreateGraphRequest ()
	Constructs a CreateGraphRequest object with default parameters. More...

	CreateGraphRequest (string graph_name, bool? directed_graph, IList< string > nodes, IList< string > edges, IList< string > weights, IList< string > restrictions, IDictionary< string, string > options=null)
	Constructs a CreateGraphRequest object with the specified parameters. More...

	CreateGraphRequest ()
	Constructs a CreateGraphRequest object with default parameters. More...

	CreateGraphRequest (string graph_name, bool? directed_graph, IList< string > nodes, IList< string > edges, IList< string > weights, IList< string > restrictions, IDictionary< string, string > options=null)
	Constructs a CreateGraphRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	graph_name `[get, set]`
	Name of the graph resource to generate. More...

bool	directed_graph = true `[get, set]`
	If set to TRUE, the graph will be directed. More...

IList< string >	nodes = new List<string>() `[get, set]`
	Nodes represent fundamental topological units of a graph. More...

IList< string >	edges = new List<string>() `[get, set]`
	Edges represent the required fundamental topological unit of a graph that typically connect nodes. More...

IList< string >	weights = new List<string>() `[get, set]`
	Weights represent a method of informing the graph solver of the cost of including a given edge in a solution. More...

IList< string >	restrictions = new List<string>() `[get, set]`
	Restrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

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

static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.createGraph.

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

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

Definition at line 23 of file CreateGraph.cs.

Constructor & Destructor Documentation

◆ CreateGraphRequest() [1/4]

kinetica.CreateGraphRequest.CreateGraphRequest ( )

inline

Constructs a CreateGraphRequest object with default parameters.

Definition at line 465 of file CreateGraph.cs.

◆ CreateGraphRequest() [2/4]

kinetica.CreateGraphRequest.CreateGraphRequest	(	string	graph_name,
		bool?	directed_graph,
		IList< string >	nodes,
		IList< string >	edges,
		IList< string >	weights,
		IList< string >	restrictions,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateGraphRequest object with the specified parameters.

Parameters

graph_name	Name of the graph resource to generate.
directed_graph	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.
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.
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.
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.
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.
options	Optional parameters. 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 graph_name ) already exists, the graph is deleted and recreated. Supported values: 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. Supported values: 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 Kinetica.createTableMonitor. Supported values: 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). Supported values: TRUE FALSE The default value is FALSE. IS_PARTITIONED: Supported values: 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. Supported values: 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. Supported values: 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 Dictionary.

Definition at line 719 of file CreateGraph.cs.

◆ CreateGraphRequest() [3/4]

kinetica.CreateGraphRequest.CreateGraphRequest ( )

inline

Constructs a CreateGraphRequest object with default parameters.

Definition at line 465 of file CreateGraph.cs.

◆ CreateGraphRequest() [4/4]

kinetica.CreateGraphRequest.CreateGraphRequest	(	string	graph_name,
		bool?	directed_graph,
		IList< string >	nodes,
		IList< string >	edges,
		IList< string >	weights,
		IList< string >	restrictions,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateGraphRequest object with the specified parameters.

Parameters

graph_name	Name of the graph resource to generate.
directed_graph	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.
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.
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.
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.
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.
options	Optional parameters. 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 graph_name ) already exists, the graph is deleted and recreated. Supported values: 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. Supported values: 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 Kinetica.createTableMonitor. Supported values: 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). Supported values: TRUE FALSE The default value is FALSE. IS_PARTITIONED: Supported values: 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. Supported values: 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. Supported values: 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 Dictionary.

Definition at line 719 of file CreateGraph.cs.

Property Documentation

◆ directed_graph

bool kinetica.CreateGraphRequest.directed_graph = true

getset

If set to TRUE, the graph will be directed.

Supported values:

true
false

The default value is true.

Definition at line 215 of file CreateGraph.cs.

◆ edges

IList< string > kinetica.CreateGraphRequest.edges = new List<string>()

getset

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.

Definition at line 245 of file CreateGraph.cs.

◆ graph_name

string kinetica.CreateGraphRequest.graph_name

getset

Name of the graph resource to generate.

Definition at line 201 of file CreateGraph.cs.

◆ nodes

IList< string > kinetica.CreateGraphRequest.nodes = new List<string>()

getset

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.

Definition at line 230 of file CreateGraph.cs.

◆ options

IDictionary< string, string > kinetica.CreateGraphRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

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 graph_name) already exists, the graph is deleted and recreated. Supported values:
- 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. Supported values:
- 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 Kinetica.createTableMonitor. Supported values:
- 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). Supported values:
- TRUE
- FALSE
The default value is FALSE.
IS_PARTITIONED: Supported values:
- 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. Supported values:
- 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. Supported values:
- 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 Dictionary.

Definition at line 461 of file CreateGraph.cs.

◆ restrictions

IList< string > kinetica.CreateGraphRequest.restrictions = new List<string>()

getset

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.

Definition at line 276 of file CreateGraph.cs.

◆ weights

IList< string > kinetica.CreateGraphRequest.weights = new List<string>()

getset

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.

Definition at line 260 of file CreateGraph.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateGraph.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateGraphRequest() [1/4]

◆ CreateGraphRequest() [2/4]

◆ CreateGraphRequest() [3/4]

◆ CreateGraphRequest() [4/4]

Property Documentation

◆ directed_graph

◆ edges

◆ graph_name

◆ nodes

◆ options

◆ restrictions

◆ weights