Kinetica C# API  Version 7.1.10.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 (>0), limits the number of query results. More...
 
const string OUTPUT_WKT_PATH = "output_wkt_path"
 If true then concatenated wkt line segments will be added as the WKT column of the adjacency table. 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...
 
const string SERVER_ID = "server_id"
 Indicates which graph server(s) to send the request to. More...
 
const string OUTPUT_CHARN_LENGTH = "output_charn_length"
 When specified (>0 and <=256), limits the number of char length on the output tables for string based nodes. More...
 
const string FIND_COMMON_LABELS = "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. 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 (>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:

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

The default value is FALSE.

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

Definition at line 168 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 233 of file QueryGraph.cs.

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

Definition at line 194 of file QueryGraph.cs.

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

The default value is FALSE.

Definition at line 263 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 192 of file QueryGraph.cs.

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

Definition at line 199 of file QueryGraph.cs.

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

Definition at line 244 of file QueryGraph.cs.

const string kinetica.QueryGraphRequest.Options.OUTPUT_WKT_PATH = "output_wkt_path"

If true then concatenated wkt line segments will be added as the WKT column of the adjacency table.

Supported values:

The default value is FALSE.

Definition at line 216 of file QueryGraph.cs.

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

Definition at line 239 of file QueryGraph.cs.

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

Definition at line 193 of file QueryGraph.cs.

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