Kinetica C# API  Version 7.1.10.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 
54  {
55 
168  public struct Options
169  {
170 
192  public const string FORCE_UNDIRECTED = "force_undirected";
193  public const string TRUE = "true";
194  public const string FALSE = "false";
195 
199  public const string LIMIT = "limit";
200 
216  public const string OUTPUT_WKT_PATH = "output_wkt_path";
217 
233  public const string AND_LABELS = "and_labels";
234 
239  public const string SERVER_ID = "server_id";
240 
244  public const string OUTPUT_CHARN_LENGTH = "output_charn_length";
245 
263  public const string FIND_COMMON_LABELS = "find_common_labels";
264  } // end struct Options
265 
266 
268  public string graph_name { get; set; }
269 
280  public IList<string> queries { get; set; } = new List<string>();
281 
294  public IList<string> restrictions { get; set; } = new List<string>();
295 
311  public string adjacency_table { get; set; } = "";
312 
325  public int rings { get; set; } = 1;
326 
437  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
438 
439 
442  public QueryGraphRequest() { }
443 
612  IList<string> queries,
613  IList<string> restrictions = null,
614  string adjacency_table = null,
615  int? rings = null,
616  IDictionary<string, string> options = null)
617  {
618  this.graph_name = graph_name ?? "";
619  this.queries = queries ?? new List<string>();
620  this.restrictions = restrictions ?? new List<string>();
621  this.adjacency_table = adjacency_table ?? "";
622  this.rings = rings ?? 1;
623  this.options = options ?? new Dictionary<string, string>();
624  } // end constructor
625 
626  } // end class QueryGraphRequest
627 
628 
629 
634  {
635 
637  public bool result { get; set; }
638 
643  public IList<long> adjacency_list_int_array { get; set; } = new List<long>();
644 
649  public IList<string> adjacency_list_string_array { get; set; } = new List<string>();
650 
656  public IList<string> adjacency_list_wkt_array { get; set; } = new List<string>();
657 
659  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
660 
661  } // end class QueryGraphResponse
662 
663 
664 
665 
666 } // 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:233
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:263
bool result
Indicates a successful query.
Definition: QueryGraph.cs:637
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: QueryGraph.cs:239
const string OUTPUT_CHARN_LENGTH
When specified (&gt;0 and &lt;=256), limits the number of char length on the output tables for string based...
Definition: QueryGraph.cs:244
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:643
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:649
IList< string > restrictions
Additional restrictions to apply to the nodes/edges of an existing graph.
Definition: QueryGraph.cs:294
IDictionary< string, string > options
Additional parameters FORCE_UNDIRECTED: If set to true, all inbound edges and outbound edges relative...
Definition: QueryGraph.cs:437
string graph_name
Name of the graph resource to query.
Definition: QueryGraph.cs:268
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:656
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:611
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:325
const string FORCE_UNDIRECTED
If set to true, all inbound edges and outbound edges relative to the node will be returned...
Definition: QueryGraph.cs:192
IDictionary< string, string > info
Additional information.
Definition: QueryGraph.cs:659
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:216
A set of parameters for Kinetica.queryGraph(string,IList{string},IList{string},string,int,IDictionary{string, string}).
Definition: QueryGraph.cs:53
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:633
IList< string > queries
Nodes or edges to be queried specified using query identifiers.
Definition: QueryGraph.cs:280
string adjacency_table
Name of the table to store the resulting adjacencies, in [schema_name.
Definition: QueryGraph.cs:311
QueryGraphRequest()
Constructs a QueryGraphRequest object with default parameters.
Definition: QueryGraph.cs:442
const string LIMIT
When specified (&gt;0), limits the number of query results.
Definition: QueryGraph.cs:199
Additional parameters FORCE_UNDIRECTED: If set to true, all inbound edges and outbound edges relative...
Definition: QueryGraph.cs:168