Kinetica C# API  Version 6.2.0.1
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 
41  {
42 
152  public struct Options
153  {
154 
170  public const string FORCE_SYNCHRONOUS = "force_synchronous";
171  public const string TRUE = "true";
172  public const string FALSE = "false";
173 
189  public const string GET_SIZES = "get_sizes";
190 
212  public const string SHOW_CHILDREN = "show_children";
213 
230  public const string NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists";
231 
247  public const string GET_COLUMN_INFO = "get_column_info";
248  } // end struct Options
249 
250 
254  public string table_name { get; set; }
255 
363  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
364 
365 
368  public ShowTableRequest() { }
369 
483  public ShowTableRequest( string table_name,
484  IDictionary<string, string> options = null)
485  {
486  this.table_name = table_name ?? "";
487  this.options = options ?? new Dictionary<string, string>();
488  } // end constructor
489 
490  } // end class ShowTableRequest
491 
492 
493 
498  {
499 
527  public struct TableDescriptions
528  {
529  public const string COLLECTION = "COLLECTION";
530  public const string VIEW = "VIEW";
531  public const string REPLICATED = "REPLICATED";
532  public const string JOIN = "JOIN";
533  public const string RESULT_TABLE = "RESULT_TABLE";
534  } // end struct TableDescriptions
535 
536 
544  public struct AdditionalInfo
545  {
546 
563  public const string REQUEST_AVRO_TYPE = "request_avro_type";
564  public const string CREATE_TABLE = "create_table";
565  public const string CREATE_PROJECTION = "create_projection";
566  public const string CREATE_UNION = "create_union";
567 
570  public const string REQUEST_AVRO_JSON = "request_avro_json";
571 
586  public const string ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables";
587  public const string TRUE = "true";
588  public const string FALSE = "false";
589 
604  public const string PROTECTED = "protected";
605 
609  public const string RECORD_BYTES = "record_bytes";
610 
613  public const string COLLECTION_NAMES = "collection_names";
614 
618  public const string TABLE_TTL = "table_ttl";
619 
624  public const string REMAINING_TABLE_TTL = "remaining_table_ttl";
625 
629  public const string MEMORY_TTL = "memory_ttl";
630 
636  public const string FOREIGN_KEYS = "foreign_keys";
637 
642  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
643 
648  public const string ATTRIBUTE_INDEXES = "attribute_indexes";
649 
656  public const string COMPRESSED_COLUMNS = "compressed_columns";
657 
661  public const string COLUMN_INFO = "column_info";
662 
692  public const string GLOBAL_ACCESS_MODE = "global_access_mode";
693 
696  public const string NO_ACCESS = "no_access";
697 
700  public const string READ_ONLY = "read_only";
701 
704  public const string WRITE_ONLY = "write_only";
705 
708  public const string READ_WRITE = "read_write";
709 
713  public const string VIEW_TABLE_NAME = "view_table_name";
714 
729  public const string IS_VIEW_PERSISTED = "is_view_persisted";
730 
745  public const string IS_DIRTY = "is_dirty";
746 
764  public const string REFRESH_METHOD = "refresh_method";
765  public const string MANUAL = "manual";
766  public const string PERIODIC = "periodic";
767  public const string ON_CHANGE = "on_change";
768 
772  public const string REFRESH_START_TIME = "refresh_start_time";
773 
777  public const string REFRESH_PERIOD = "refresh_period";
778 
781  public const string LAST_REFRESH_TIME = "last_refresh_time";
782 
786  public const string NEXT_REFRESH_TIME = "next_refresh_time";
787  } // end struct AdditionalInfo
788 
789 
792  public string table_name { get; set; }
793 
805  public IList<string> table_names { get; set; } = new List<string>();
806 
832  public IList<IList<string>> table_descriptions { get; set; } = new List<IList<string>>();
833 
836  public IList<string> type_ids { get; set; } = new List<string>();
837 
840  public IList<string> type_schemas { get; set; } = new List<string>();
841 
844  public IList<string> type_labels { get; set; } = new List<string>();
845 
848  public IList<IDictionary<string, IList<string>>> properties { get; set; } = new List<IDictionary<string, IList<string>>>();
849 
855  public IList<IDictionary<string, string>> additional_info { get; set; } = new List<IDictionary<string, string>>();
856 
865  public IList<long> sizes { get; set; } = new List<long>();
866 
874  public IList<long> full_sizes { get; set; } = new List<long>();
875 
883  public IList<double> join_sizes { get; set; } = new List<double>();
884 
888  public long total_size { get; set; }
889 
892  public long total_full_size { get; set; }
893 
894  } // end class ShowTableResponse
895 
896 
897 
898 
899 } // 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:230
Additional information about the respective tables in <member name="table_names">.
Definition: ShowTable.cs:544
const string GET_SIZES
If true then the table sizes will be returned; blank, otherwise.
Definition: ShowTable.cs:189
IDictionary< string, string > options
Optional parameters.
Definition: ShowTable.cs:363
const string FORCE_SYNCHRONOUS
If true then the table sizes will wait for read lock before returning.
Definition: ShowTable.cs:170
const string GET_COLUMN_INFO
If true then column info (memory usage, etc) will be returned.
Definition: ShowTable.cs:247
ShowTableRequest(string table_name, IDictionary< string, string > options=null)
Constructs a ShowTableRequest object with the specified parameters.
Definition: ShowTable.cs:483
ShowTableRequest()
Constructs a ShowTableRequest object with default parameters.
Definition: ShowTable.cs:368
A set of results returned by Kinetica.showTable(string,IDictionary<string, string>).
Definition: ShowTable.cs:497
const string SHOW_CHILDREN
If table_name is a collection, then true will return information about the children of the collection...
Definition: ShowTable.cs:212
List of descriptions for the respective tables in <member name="table_names">.
Definition: ShowTable.cs:527
A set of parameters for Kinetica.showTable(string,IDictionary<string, string>).
Definition: ShowTable.cs:40
Optional parameters.
Definition: ShowTable.cs:152
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:254