Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
ShowTable.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 
36  {
37 
70  public struct Options
71  {
72 
76  public const string GET_SIZES = "get_sizes";
77  public const string TRUE = "true";
78  public const string FALSE = "false";
79 
88  public const string SHOW_CHILDREN = "show_children";
89 
94  public const string NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists";
95  } // end struct Options
96 
97 
101  public string table_name { get; set; }
102 
133  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
134 
135 
138  public ShowTableRequest() { }
139 
177  public ShowTableRequest( string table_name,
178  IDictionary<string, string> options = null)
179  {
180  this.table_name = table_name ?? "";
181  this.options = options ?? new Dictionary<string, string>();
182  } // end constructor
183 
184  } // end class ShowTableRequest
185 
186 
187 
190  {
191 
198  public struct TableDescriptions
199  {
200  public const string COLLECTION = "COLLECTION";
201  public const string VIEW = "VIEW";
202  public const string REPLICATED = "REPLICATED";
203  public const string JOIN = "JOIN";
204  public const string RESULT_TABLE = "RESULT_TABLE";
205  } // end struct TableDescriptions
206 
207 
213  public struct AdditionalInfo
214  {
215 
221  public const string ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables";
222  public const string FALSE = "false";
223  public const string TRUE = "true";
224 
228  public const string PROTECTED = "protected";
229 
234  public const string TABLE_TTL = "table_ttl";
235 
240  public const string REMAINING_TABLE_TTL = "remaining_table_ttl";
241 
246  public const string FOREIGN_KEYS = "foreign_keys";
247 
252  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
253 
256  public const string ATTRIBUTE_INDEXES = "attribute_indexes";
257  } // end struct AdditionalInfo
258 
259 
262  public string table_name { get; set; }
263 
275  public IList<string> table_names { get; set; } = new List<string>();
276 
281  public IList<IList<string>> table_descriptions { get; set; } = new List<IList<string>>();
282 
285  public IList<string> type_ids { get; set; } = new List<string>();
286 
289  public IList<string> type_schemas { get; set; } = new List<string>();
290 
293  public IList<string> type_labels { get; set; } = new List<string>();
294 
297  public IList<IDictionary<string, IList<string>>> properties { get; set; } = new List<IDictionary<string, IList<string>>>();
298 
302  public IList<IDictionary<string, string>> additional_info { get; set; } = new List<IDictionary<string, string>>();
303 
312  public IList<long> sizes { get; set; } = new List<long>();
313 
321  public IList<long> full_sizes { get; set; } = new List<long>();
322 
330  public IList<double> join_sizes { get; set; } = new List<double>();
331 
335  public long total_size { get; set; }
336 
339  public long total_full_size { get; set; }
340 
341  } // end class ShowTableResponse
342 
343 
344 
345 
346 } // end namespace kinetica
IList< long > full_sizes
Empty array if the get_sizes option is false.
Definition: ShowTable.cs:321
IList< IList< string > > table_descriptions
List of descriptions for the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:281
IList< long > sizes
Empty array if the get_sizes option is false.
Definition: ShowTable.cs:312
const string NO_ERROR_IF_NOT_EXISTS
If false will return an error if the provided &lt;member name=&quot;table_name&quot;&gt; does not exist...
Definition: ShowTable.cs:94
Additional information about the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:213
const string GET_SIZES
If true then the table sizes will be returned; blank, otherwise.
Definition: ShowTable.cs:76
IList< string > type_schemas
Type schemas of the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:289
IList< IDictionary< string, IList< string > > > properties
Property maps of the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:297
const string ALLOW_HOMOGENEOUS_TABLES
Only present if the respective table is a collection.
Definition: ShowTable.cs:221
IDictionary< string, string > options
Optional parameters.
Definition: ShowTable.cs:133
IList< string > type_ids
Type ids of the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:285
const string FOREIGN_SHARD_KEY
Foreign shard key description of the format: &lt;fk_foreign_key&gt; references &lt;pk_column_name&gt; from &lt;pk_ta...
Definition: ShowTable.cs:252
IList< string > table_names
If is a table or view, then the single element of the array is .
Definition: ShowTable.cs:275
const string TABLE_TTL
The value of TTL setting, in minutes, for the respective table (-1 if it will never expire)...
Definition: ShowTable.cs:234
ShowTableRequest(string table_name, IDictionary< string, string > options=null)
Constructs a ShowTableRequest object with the specified parameters.
Definition: ShowTable.cs:177
ShowTableRequest()
Constructs a ShowTableRequest object with default parameters.
Definition: ShowTable.cs:138
A set of results returned by /show/table.
Definition: ShowTable.cs:189
const string SHOW_CHILDREN
If &lt;member name=&quot;table_name&quot;&gt; is a collection, then true will return information about the children o...
Definition: ShowTable.cs:88
const string FOREIGN_KEYS
Semicolon-separated list of foreign key constraints, of the format &#39;source_column references target_t...
Definition: ShowTable.cs:246
const string ATTRIBUTE_INDEXES
Semicolon-separated list of columns that have attribute indexes.
Definition: ShowTable.cs:256
const string PROTECTED
Indicates whether the respective table is protected or not.
Definition: ShowTable.cs:228
IList< double > join_sizes
Empty array if the get_sizes option is false.
Definition: ShowTable.cs:330
List of descriptions for the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:198
A set of parameters for /show/table.
Definition: ShowTable.cs:35
Optional parameters.
Definition: ShowTable.cs:70
string table_name
Value of .
Definition: ShowTable.cs:262
IList< string > type_labels
Type labels of the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:293
IList< IDictionary< string, string > > additional_info
Additional information about the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:302
const string REMAINING_TABLE_TTL
The remaining amount of minutes before the respective table expires (-1 if it will never expire)...
Definition: ShowTable.cs:240
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
long total_full_size
-1 if the get_sizes option is false.
Definition: ShowTable.cs:339
long total_size
-1 if the get_sizes option is false.
Definition: ShowTable.cs:335
string table_name
Name of the table for which to retrieve the information.
Definition: ShowTable.cs:101