Kinetica   C#   API  Version 7.2.3.0
QueryGraph.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica
10 {
37  {
41  public struct Options
42  {
57  public const string FORCE_UNDIRECTED = "force_undirected";
58 
59  public const string TRUE = "true";
60  public const string FALSE = "false";
61 
67  public const string LIMIT = "limit";
68 
82  public const string OUTPUT_WKT_PATH = "output_wkt_path";
83 
98  public const string AND_LABELS = "and_labels";
99 
105  public const string SERVER_ID = "server_id";
106 
112  public const string OUTPUT_CHARN_LENGTH = "output_charn_length";
113 
128  public const string FIND_COMMON_LABELS = "find_common_labels";
129  } // end struct Options
130 
132  public string graph_name { get; set; }
133 
144  public IList<string> queries { get; set; } = new List<string>();
145 
159  public IList<string> restrictions { get; set; } = new List<string>();
160 
176  public string adjacency_table { get; set; } = "";
177 
190  public int rings { get; set; } = 1;
191 
301  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
302 
305  public QueryGraphRequest() { }
306 
472  IList<string> queries,
473  IList<string> restrictions = null,
474  string adjacency_table = null,
475  int? rings = null,
476  IDictionary<string, string> options = null)
477  {
478  this.graph_name = graph_name ?? "";
479  this.queries = queries ?? new List<string>();
480  this.restrictions = restrictions ?? new List<string>();
481  this.adjacency_table = adjacency_table ?? "";
482  this.rings = rings ?? 1;
483  this.options = options ?? new Dictionary<string, string>();
484  } // end constructor
485  } // end class QueryGraphRequest
486 
491  {
493  public bool result { get; set; }
494 
499  public IList<long> adjacency_list_int_array { get; set; } = new List<long>();
500 
505  public IList<string> adjacency_list_string_array { get; set; } = new List<string>();
506 
512  public IList<string> adjacency_list_wkt_array { get; set; } = new List<string>();
513 
515  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
516  } // end class QueryGraphResponse
517 } // end namespace kinetica
const string AND_LABELS
If set to TRUE, the result of the query has entities that satisfy all of the target labels,...
Definition: QueryGraph.cs:98
const string FIND_COMMON_LABELS
If set to true, for many-to-many queries or multi-level traversals, it lists the common labels betwee...
Definition: QueryGraph.cs:128
bool result
Indicates a successful query.
Definition: QueryGraph.cs:493
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: QueryGraph.cs:105
const string OUTPUT_CHARN_LENGTH
When specified (>0 and <=256), limits the number of char length on the output tables for string based...
Definition: QueryGraph.cs:112
IList< long > adjacency_list_int_array
The adjacency entity integer ID: either edge IDs per node requested (if using QUERY_EDGE_ID or QUERY_...
Definition: QueryGraph.cs:499
IList< string > adjacency_list_string_array
The adjacency entity string ID: either edge IDs per node requested (if using QUERY_EDGE_NAME or QUERY...
Definition: QueryGraph.cs:505
IList< string > restrictions
Additional restrictions to apply to the nodes/edges of an existing graph.
Definition: QueryGraph.cs:159
IDictionary< string, string > options
Additional parameters.
Definition: QueryGraph.cs:301
string graph_name
Name of the graph resource to query.
Definition: QueryGraph.cs:132
IList< string > adjacency_list_wkt_array
The adjacency entity WKTPOINT or WKTLINE ID: either edge IDs per node requested (if using QUERY_EDGE_...
Definition: QueryGraph.cs:512
int rings
Sets the number of rings around the node to query for adjacency, with '1' being the edges directly at...
Definition: QueryGraph.cs:190
const string FORCE_UNDIRECTED
If set to TRUE, all inbound edges and outbound edges relative to the node will be returned.
Definition: QueryGraph.cs:57
IDictionary< string, string > info
Additional information.
Definition: QueryGraph.cs:515
const string OUTPUT_WKT_PATH
If true then concatenated wkt line segments will be added as the WKT column of the adjacency table.
Definition: QueryGraph.cs:82
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.
Definition: QueryGraph.cs:471
A set of parameters for Kinetica.queryGraph.
Definition: QueryGraph.cs:36
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of results returned by Kinetica.queryGraph.
Definition: QueryGraph.cs:490
IList< string > queries
Nodes or edges to be queried specified using query identifiers.
Definition: QueryGraph.cs:144
string adjacency_table
Name of the table to store the resulting adjacencies, in [schema_name.
Definition: QueryGraph.cs:176
QueryGraphRequest()
Constructs a QueryGraphRequest object with default parameters.
Definition: QueryGraph.cs:305
const string LIMIT
When specified (>0), limits the number of query results.
Definition: QueryGraph.cs:67
A set of string constants for the parameter options.
Definition: QueryGraph.cs:41