Kinetica C# API  Version 6.1.0.0
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 
127  public struct Options
128  {
129 
145  public const string GET_SIZES = "get_sizes";
146  public const string TRUE = "true";
147  public const string FALSE = "false";
148 
169  public const string SHOW_CHILDREN = "show_children";
170 
187  public const string NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists";
188 
204  public const string GET_COLUMN_INFO = "get_column_info";
205  } // end struct Options
206 
207 
211  public string table_name { get; set; }
212 
300  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
301 
302 
305  public ShowTableRequest() { }
306 
401  public ShowTableRequest( string table_name,
402  IDictionary<string, string> options = null)
403  {
404  this.table_name = table_name ?? "";
405  this.options = options ?? new Dictionary<string, string>();
406  } // end constructor
407 
408  } // end class ShowTableRequest
409 
410 
411 
416  {
417 
445  public struct TableDescriptions
446  {
447  public const string COLLECTION = "COLLECTION";
448  public const string VIEW = "VIEW";
449  public const string REPLICATED = "REPLICATED";
450  public const string JOIN = "JOIN";
451  public const string RESULT_TABLE = "RESULT_TABLE";
452  } // end struct TableDescriptions
453 
454 
462  public struct AdditionalInfo
463  {
464 
479  public const string ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables";
480  public const string TRUE = "true";
481  public const string FALSE = "false";
482 
497  public const string PROTECTED = "protected";
498 
502  public const string RECORD_BYTES = "record_bytes";
503 
508  public const string TABLE_TTL = "table_ttl";
509 
515  public const string REMAINING_TABLE_TTL = "remaining_table_ttl";
516 
522  public const string FOREIGN_KEYS = "foreign_keys";
523 
528  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
529 
534  public const string ATTRIBUTE_INDEXES = "attribute_indexes";
535 
542  public const string COMPRESSED_COLUMNS = "compressed_columns";
543 
547  public const string COLUMN_INFO = "column_info";
548 
578  public const string GLOBAL_ACCESS_MODE = "global_access_mode";
579 
582  public const string NO_ACCESS = "no_access";
583 
586  public const string READ_ONLY = "read_only";
587 
590  public const string WRITE_ONLY = "write_only";
591 
594  public const string READ_WRITE = "read_write";
595  } // end struct AdditionalInfo
596 
597 
600  public string table_name { get; set; }
601 
613  public IList<string> table_names { get; set; } = new List<string>();
614 
640  public IList<IList<string>> table_descriptions { get; set; } = new List<IList<string>>();
641 
644  public IList<string> type_ids { get; set; } = new List<string>();
645 
648  public IList<string> type_schemas { get; set; } = new List<string>();
649 
652  public IList<string> type_labels { get; set; } = new List<string>();
653 
656  public IList<IDictionary<string, IList<string>>> properties { get; set; } = new List<IDictionary<string, IList<string>>>();
657 
663  public IList<IDictionary<string, string>> additional_info { get; set; } = new List<IDictionary<string, string>>();
664 
673  public IList<long> sizes { get; set; } = new List<long>();
674 
682  public IList<long> full_sizes { get; set; } = new List<long>();
683 
691  public IList<double> join_sizes { get; set; } = new List<double>();
692 
696  public long total_size { get; set; }
697 
700  public long total_full_size { get; set; }
701 
702  } // end class ShowTableResponse
703 
704 
705 
706 
707 } // end namespace kinetica
const string NO_ERROR_IF_NOT_EXISTS
If false will return an error if the provided table_name does not exist.
Definition: ShowTable.cs:187
Additional information about the respective tables in <member name="table_names">.
Definition: ShowTable.cs:462
const string GET_SIZES
If true then the table sizes will be returned; blank, otherwise.
Definition: ShowTable.cs:145
IDictionary< string, string > options
Optional parameters.
Definition: ShowTable.cs:300
const string GET_COLUMN_INFO
If true then column info (memory usage, etc) will be returned.
Definition: ShowTable.cs:204
ShowTableRequest(string table_name, IDictionary< string, string > options=null)
Constructs a ShowTableRequest object with the specified parameters.
Definition: ShowTable.cs:401
ShowTableRequest()
Constructs a ShowTableRequest object with default parameters.
Definition: ShowTable.cs:305
A set of results returned by Kinetica.showTable(string,IDictionary<string, string>).
Definition: ShowTable.cs:415
const string SHOW_CHILDREN
If table_name is a collection, then true will return information about the children of the collection...
Definition: ShowTable.cs:169
List of descriptions for the respective tables in <member name="table_names">.
Definition: ShowTable.cs:445
A set of parameters for Kinetica.showTable(string,IDictionary<string, string>).
Definition: ShowTable.cs:35
Optional parameters.
Definition: ShowTable.cs:127
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string table_name
Name of the table for which to retrieve the information.
Definition: ShowTable.cs:211