Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
10 
11 namespace kinetica
12 {
13 
50  {
51 
178  public struct Options
179  {
180 
202  public const string FORCE_UNDIRECTED = "force_undirected";
203  public const string TRUE = "true";
204  public const string FALSE = "false";
205 
211  public const string LIMIT = "limit";
212 
219  public const string TARGET_NODES_TABLE = "target_nodes_table";
220 
225  public const string RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value";
226 
248  public const string EXPORT_QUERY_RESULTS = "export_query_results";
249 
271  public const string ENABLE_GRAPH_DRAW = "enable_graph_draw";
272 
288  public const string AND_LABELS = "and_labels";
289  } // end struct Options
290 
291 
293  public string graph_name { get; set; }
294 
305  public IList<string> queries { get; set; } = new List<string>();
306 
319  public IList<string> restrictions { get; set; } = new List<string>();
320 
333  public string adjacency_table { get; set; } = "";
334 
347  public int rings { get; set; } = 1;
348 
473  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
474 
475 
478  public QueryGraphRequest() { }
479 
659  IList<string> queries,
660  IList<string> restrictions = null,
661  string adjacency_table = null,
662  int? rings = null,
663  IDictionary<string, string> options = null)
664  {
665  this.graph_name = graph_name ?? "";
666  this.queries = queries ?? new List<string>();
667  this.restrictions = restrictions ?? new List<string>();
668  this.adjacency_table = adjacency_table ?? "";
669  this.rings = rings ?? 1;
670  this.options = options ?? new Dictionary<string, string>();
671  } // end constructor
672 
673  } // end class QueryGraphRequest
674 
675 
676 
681  {
682 
684  public bool result { get; set; }
685 
690  public IList<long> adjacency_list_int_array { get; set; } = new List<long>();
691 
696  public IList<string> adjacency_list_string_array { get; set; } = new List<string>();
697 
703  public IList<string> adjacency_list_wkt_array { get; set; } = new List<string>();
704 
706  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
707 
708  } // end class QueryGraphResponse
709 
710 
711 
712 
713 } // 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:288
bool result
Indicates a successful query.
Definition: QueryGraph.cs:684
const string TARGET_NODES_TABLE
Name of the table to store the list of the final nodes reached during the traversal.
Definition: QueryGraph.cs:219
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:690
const string ENABLE_GRAPH_DRAW
If set to true, adds a WKT-type column named &#39;QUERY_EDGE_WKTLINE&#39; to the given adjacency_table and in...
Definition: QueryGraph.cs:271
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:696
IList< string > restrictions
Additional restrictions to apply to the nodes/edges of an existing graph.
Definition: QueryGraph.cs:319
IDictionary< string, string > options
Additional parameters FORCE_UNDIRECTED: If set to true, all inbound edges and outbound edges relative...
Definition: QueryGraph.cs:473
string graph_name
Name of the graph resource to query.
Definition: QueryGraph.cs:293
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:703
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:658
const string RESTRICTION_THRESHOLD_VALUE
Value-based restriction comparison.
Definition: QueryGraph.cs:225
const string EXPORT_QUERY_RESULTS
Returns query results in the response.
Definition: QueryGraph.cs:248
int rings
Sets the number of rings around the node to query for adjacency, with &#39;1&#39; being the edges directly at...
Definition: QueryGraph.cs:347
const string FORCE_UNDIRECTED
If set to true, all inbound edges and outbound edges relative to the node will be returned...
Definition: QueryGraph.cs:202
IDictionary< string, string > info
Additional information.
Definition: QueryGraph.cs:706
A set of parameters for Kinetica.queryGraph(string,IList{string},IList{string},string,int,IDictionary{string, string}).
Definition: QueryGraph.cs:49
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of results returned by Kinetica.queryGraph(string,IList{string},IList{string},string,int,IDictionary{string, string}).
Definition: QueryGraph.cs:680
IList< string > queries
Nodes or edges to be queried specified using query identifiers.
Definition: QueryGraph.cs:305
string adjacency_table
Name of the table to store the resulting adjacencies.
Definition: QueryGraph.cs:333
QueryGraphRequest()
Constructs a QueryGraphRequest object with default parameters.
Definition: QueryGraph.cs:478
const string LIMIT
When specified, limits the number of query results.
Definition: QueryGraph.cs:211
Additional parameters FORCE_UNDIRECTED: If set to true, all inbound edges and outbound edges relative...
Definition: QueryGraph.cs:178