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

Inheritance diagram for kinetica.QueryGraphRequest:

Collaboration diagram for kinetica.QueryGraphRequest:

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

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

	QueryGraphRequest (string graph_name, IList< string > queries, IList< string > restrictions=null, string adjacency_table=null, int? rings=null, IDictionary< string, string > options=null)
	Constructs a QueryGraphRequest 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...

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

IList< string >	queries = new List<string>() `[get, set]`
	Nodes or edges to be queried specified using query identifiers. More...

IList< string >	restrictions = new List<string>() `[get, set]`
	Additional restrictions to apply to the nodes/edges of an existing graph. More...

string	adjacency_table = "" `[get, set]`
	Name of the table to store the resulting adjacencies, in [schema_name. More...

int	rings = 1 `[get, set]`
	Sets the number of rings around the node to query for adjacency, with '1' being the edges directly attached to the queried node. More...

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

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

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

Detailed Description

A set of parameters for Kinetica.queryGraph.

Employs a topological query on a graph generated a-priori by Kinetica.createGraph and returns a list of adjacent edge(s) or node(s), also known as an adjacency list, depending on what's been provided to the endpoint; providing edges will return nodes and providing nodes will return edges.

To determine the node(s) or edge(s) adjacent to a value from a given column, provide a list of values to queries. This field can be populated with column values from any table as long as the type is supported by the given identifier. See Query Identifiers for more information.

To return the adjacency list in the response, leave adjacency_table empty.

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

Definition at line 36 of file QueryGraph.cs.

Constructor & Destructor Documentation

◆ QueryGraphRequest() [1/2]

kinetica.QueryGraphRequest.QueryGraphRequest ( )

inline

Constructs a QueryGraphRequest object with default parameters.

Definition at line 305 of file QueryGraph.cs.

◆ QueryGraphRequest() [2/2]

kinetica.QueryGraphRequest.QueryGraphRequest	(	string	graph_name,
		IList< string >	queries,
		IList< string >	restrictions = `null`,
		string	adjacency_table = `null`,
		int?	rings = `null`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a QueryGraphRequest object with the specified parameters.

Parameters

graph_name	Name of the graph resource to query.
queries	Nodes or edges to be queried specified using query identifiers. Identifiers can be used with existing column names, e.g., 'table.column AS QUERY_NODE_ID', raw values, e.g., '{0, 2} AS QUERY_NODE_ID', or expressions, e.g., 'ST_MAKEPOINT(table.x, table.y) AS QUERY_NODE_WKTPOINT'. Multiple values can be provided as long as the same identifier is used for all values. If using raw values in an identifier combination, the number of values specified must match across the combination.
restrictions	Additional restrictions to apply to the nodes/edges of an existing graph. 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. The default value is an empty List.
adjacency_table	Name of the table to store the resulting adjacencies, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If left blank, the query results are instead returned in the response. If the 'QUERY_TARGET_NODE_LABEL' query identifier is used in queries , then two additional columns will be available: 'PATH_ID' and 'RING_ID'. See Using Labels for more information. The default value is ''.
rings	Sets the number of rings around the node to query for adjacency, with '1' being the edges directly attached to the queried node. Also known as number of hops. For example, if it is set to '2', the edge(s) directly attached to the queried node(s) will be returned; in addition, the edge(s) attached to the node(s) attached to the initial ring of edge(s) surrounding the queried node(s) will be returned. If the value is set to '0', any nodes that meet the criteria in queries and restrictions will be returned. This parameter is only applicable when querying nodes. The default value is 1.
options	Additional parameters. FORCE_UNDIRECTED: If set to TRUE, all inbound edges and outbound edges relative to the node will be returned. If set to FALSE, only outbound edges relative to the node will be returned. This parameter is only applicable if the queried graph graph_name is directed and when querying nodes. Consult Directed Graphs for more details. Supported values: TRUE FALSE The default value is FALSE. LIMIT: When specified (>0), limits the number of query results. The size of the nodes table will be limited by the LIMIT value. The default value is '0'. OUTPUT_WKT_PATH: If true then concatenated wkt line segments will be added as the WKT column of the adjacency table. Supported values: TRUE FALSE The default value is FALSE. AND_LABELS: If set to TRUE, the result of the query has entities that satisfy all of the target labels, instead of any. 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, amongst those containing the corresponding graph, that has the most computational bandwidth. OUTPUT_CHARN_LENGTH: When specified (>0 and <=256), limits the number of char length on the output tables for string based nodes. The default length is 64. The default value is '64'. FIND_COMMON_LABELS: If set to true, for many-to-many queries or multi-level traversals, it lists the common labels between the source and target nodes and edge labels in each path. Otherwise (zero rings), it'll list all labels of the node(s) queried. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 471 of file QueryGraph.cs.

Property Documentation

◆ adjacency_table

string kinetica.QueryGraphRequest.adjacency_table = ""

getset

Name of the table to store the resulting adjacencies, in [schema_name.

]table_name format, using standard name resolution rules and meeting table naming criteria.

If left blank, the query results are instead returned in the response. If the 'QUERY_TARGET_NODE_LABEL' query identifier is used in queries, then two additional columns will be available: 'PATH_ID' and 'RING_ID'. See Using Labels for more information. The default value is ''.

Definition at line 176 of file QueryGraph.cs.

◆ graph_name

string kinetica.QueryGraphRequest.graph_name

getset

Name of the graph resource to query.

Definition at line 132 of file QueryGraph.cs.

◆ options

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

getset

Additional parameters.

FORCE_UNDIRECTED: If set to TRUE, all inbound edges and outbound edges relative to the node will be returned. If set to FALSE, only outbound edges relative to the node will be returned. This parameter is only applicable if the queried graph graph_name is directed and when querying nodes. Consult Directed Graphs for more details. Supported values:
- TRUE
- FALSE
The default value is FALSE.
LIMIT: When specified (>0), limits the number of query results. The size of the nodes table will be limited by the LIMIT value. The default value is '0'.
OUTPUT_WKT_PATH: If true then concatenated wkt line segments will be added as the WKT column of the adjacency table. Supported values:
- TRUE
- FALSE
The default value is FALSE.
AND_LABELS: If set to TRUE, the result of the query has entities that satisfy all of the target labels, instead of any. 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, amongst those containing the corresponding graph, that has the most computational bandwidth.
OUTPUT_CHARN_LENGTH: When specified (>0 and <=256), limits the number of char length on the output tables for string based nodes. The default length is 64. The default value is '64'.
FIND_COMMON_LABELS: If set to true, for many-to-many queries or multi-level traversals, it lists the common labels between the source and target nodes and edge labels in each path. Otherwise (zero rings), it'll list all labels of the node(s) queried. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 301 of file QueryGraph.cs.

◆ queries

IList<string> kinetica.QueryGraphRequest.queries = new List<string>()

getset

Nodes or edges to be queried specified using query identifiers.

Identifiers can be used with existing column names, e.g., 'table.column AS QUERY_NODE_ID', raw values, e.g., '{0, 2} AS QUERY_NODE_ID', or expressions, e.g., 'ST_MAKEPOINT(table.x, table.y) AS QUERY_NODE_WKTPOINT'. Multiple values can be provided as long as the same identifier is used for all values. If using raw values in an identifier combination, the number of values specified must match across the combination.

Definition at line 144 of file QueryGraph.cs.

◆ restrictions

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

getset

Additional restrictions to apply to the nodes/edges of an existing graph.

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. The default value is an empty List.

Definition at line 159 of file QueryGraph.cs.

◆ rings

int kinetica.QueryGraphRequest.rings = 1

getset

Sets the number of rings around the node to query for adjacency, with '1' being the edges directly attached to the queried node.

Also known as number of hops. For example, if it is set to '2', the edge(s) directly attached to the queried node(s) will be returned; in addition, the edge(s) attached to the node(s) attached to the initial ring of edge(s) surrounding the queried node(s) will be returned. If the value is set to '0', any nodes that meet the criteria in queries and restrictions will be returned. This parameter is only applicable when querying nodes. The default value is 1.

Definition at line 190 of file QueryGraph.cs.

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

Kinetica/Protocol/QueryGraph.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QueryGraphRequest() [1/2]

◆ QueryGraphRequest() [2/2]

Property Documentation

◆ adjacency_table

◆ graph_name

◆ options

◆ queries

◆ restrictions

◆ rings