Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.QueryGraphRequest.Options Struct Reference

Additional parameters

More...

Public Attributes

const string FORCE_UNDIRECTED = "force_undirected"
 If set to true, all inbound edges and outbound edges relative to the node will be returned. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string LIMIT = "limit"
 When specified, limits the number of query results. More...
 
const string TARGET_NODES_TABLE = "target_nodes_table"
 Name of the table to store the list of the final nodes reached during the traversal. More...
 
const string RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value"
 Value-based restriction comparison. More...
 
const string EXPORT_QUERY_RESULTS = "export_query_results"
 Returns query results in the response. More...
 
const string ENABLE_GRAPH_DRAW = "enable_graph_draw"
 If set to true, adds a WKT-type column named 'QUERY_EDGE_WKTLINE' to the given adjacency_table and inputs WKT values from the source graph (if available) or auto-generated WKT values (if there are no WKT values in the source graph). More...
 
const string AND_LABELS = "and_labels"
 If set to true, the result of the query has entities that satisfy all of the target labels, instead of any. More...
 

Detailed Description

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 is directed and when querying nodes. Consult Directed Graphs for more details. Supported values:

The default value is FALSE. LIMIT: When specified, limits the number of query results. Note that if the target_nodes_table is provided, the size of the corresponding table will be limited by the limit value. The default value is an empty Dictionary. TARGET_NODES_TABLE: Name of the table to store the list of the final nodes reached during the traversal. If this value is left as the default, the table name will default to the value plus a '_nodes' suffix, e.g., '<adjacency_table_name>_nodes'. The default value is ''. 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 solution. EXPORT_QUERY_RESULTS: Returns query results in the response. If set to true, the <member name="adjacency_list_int_array"> (if the query was based on IDs), <member name="adjacency_list_string_array"> (if the query was based on names), or <member name="adjacency_list_wkt_array"> (if the query was based on WKTs) will be populated with the results. If set to false, none of the arrays will be populated. Supported values:

The default value is FALSE. ENABLE_GRAPH_DRAW: If set to true, adds a WKT-type column named 'QUERY_EDGE_WKTLINE' to the given and inputs WKT values from the source graph (if available) or auto-generated WKT values (if there are no WKT values in the source graph). A subsequent call to the /wms endpoint can then be made to display the query results on a map. Supported values:

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:

The default value is FALSE.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 178 of file QueryGraph.cs.

Member Data Documentation

const string kinetica.QueryGraphRequest.Options.AND_LABELS = "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:

The default value is FALSE.

Definition at line 288 of file QueryGraph.cs.

const string kinetica.QueryGraphRequest.Options.ENABLE_GRAPH_DRAW = "enable_graph_draw"

If set to true, adds a WKT-type column named 'QUERY_EDGE_WKTLINE' to the given adjacency_table and inputs WKT values from the source graph (if available) or auto-generated WKT values (if there are no WKT values in the source graph).

A subsequent call to the /wms endpoint can then be made to display the query results on a map. Supported values:

The default value is FALSE.

Definition at line 271 of file QueryGraph.cs.

const string kinetica.QueryGraphRequest.Options.EXPORT_QUERY_RESULTS = "export_query_results"

Returns query results in the response.

If set to true, the <member name="adjacency_list_int_array"> (if the query was based on IDs), <member name="adjacency_list_string_array"> (if the query was based on names), or <member name="adjacency_list_wkt_array"> (if the query was based on WKTs) will be populated with the results. If set to false, none of the arrays will be populated. Supported values:

The default value is FALSE.

Definition at line 248 of file QueryGraph.cs.

const string kinetica.QueryGraphRequest.Options.FALSE = "false"

Definition at line 204 of file QueryGraph.cs.

const string kinetica.QueryGraphRequest.Options.FORCE_UNDIRECTED = "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:

The default value is FALSE.

Definition at line 202 of file QueryGraph.cs.

const string kinetica.QueryGraphRequest.Options.LIMIT = "limit"

When specified, limits the number of query results.

Note that if the target_nodes_table is provided, the size of the corresponding table will be limited by the limit value. The default value is an empty Dictionary.

Definition at line 211 of file QueryGraph.cs.

const string kinetica.QueryGraphRequest.Options.RESTRICTION_THRESHOLD_VALUE = "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 solution.

Definition at line 225 of file QueryGraph.cs.

const string kinetica.QueryGraphRequest.Options.TARGET_NODES_TABLE = "target_nodes_table"

Name of the table to store the list of the final nodes reached during the traversal.

If this value is left as the default, the table name will default to the adjacency_table value plus a '_nodes' suffix, e.g., '<adjacency_table_name>_nodes'. The default value is ''.

Definition at line 219 of file QueryGraph.cs.

const string kinetica.QueryGraphRequest.Options.TRUE = "true"

Definition at line 203 of file QueryGraph.cs.

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