Kinetica C# API  Version 7.0.19.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 
42  {
43 
153  public struct Options
154  {
155 
171  public const string FORCE_SYNCHRONOUS = "force_synchronous";
172  public const string TRUE = "true";
173  public const string FALSE = "false";
174 
191  public const string GET_SIZES = "get_sizes";
192 
213  public const string SHOW_CHILDREN = "show_children";
214 
231  public const string NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists";
232 
248  public const string GET_COLUMN_INFO = "get_column_info";
249  } // end struct Options
250 
251 
255  public string table_name { get; set; }
256 
364  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
365 
366 
369  public ShowTableRequest() { }
370 
485  public ShowTableRequest( string table_name,
486  IDictionary<string, string> options = null)
487  {
488  this.table_name = table_name ?? "";
489  this.options = options ?? new Dictionary<string, string>();
490  } // end constructor
491 
492  } // end class ShowTableRequest
493 
494 
495 
500  {
501 
541  public struct TableDescriptions
542  {
543  public const string COLLECTION = "COLLECTION";
544  public const string VIEW = "VIEW";
545  public const string REPLICATED = "REPLICATED";
546  public const string JOIN = "JOIN";
547  public const string RESULT_TABLE = "RESULT_TABLE";
548  public const string MATERIALIZED_VIEW = "MATERIALIZED_VIEW";
549  public const string MATERIALIZED_VIEW_MEMBER = "MATERIALIZED_VIEW_MEMBER";
550  public const string MATERIALIZED_VIEW_UNDER_CONSTRUCTION = "MATERIALIZED_VIEW_UNDER_CONSTRUCTION";
551  } // end struct TableDescriptions
552 
553 
561  public struct AdditionalInfo
562  {
563 
580  public const string REQUEST_AVRO_TYPE = "request_avro_type";
581  public const string CREATE_TABLE = "create_table";
582  public const string CREATE_PROJECTION = "create_projection";
583  public const string CREATE_UNION = "create_union";
584 
587  public const string REQUEST_AVRO_JSON = "request_avro_json";
588 
603  public const string PROTECTED = "protected";
604  public const string TRUE = "true";
605  public const string FALSE = "false";
606 
610  public const string RECORD_BYTES = "record_bytes";
611 
614  public const string COLLECTION_NAMES = "collection_names";
615 
619  public const string TABLE_TTL = "table_ttl";
620 
625  public const string REMAINING_TABLE_TTL = "remaining_table_ttl";
626 
632  public const string FOREIGN_KEYS = "foreign_keys";
633 
638  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
639 
673  public const string PARTITION_TYPE = "partition_type";
674 
678  public const string RANGE = "RANGE";
679 
683  public const string INTERVAL = "INTERVAL";
684 
688  public const string LIST = "LIST";
689 
691  public const string NONE = "NONE";
692 
695  public const string PARTITION_KEYS = "partition_keys";
696 
702  public const string PARTITION_DEFINITIONS = "partition_definitions";
703 
707  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
708 
713  public const string ATTRIBUTE_INDEXES = "attribute_indexes";
714 
721  public const string COMPRESSED_COLUMNS = "compressed_columns";
722 
727  public const string COLUMN_INFO = "column_info";
728 
758  public const string GLOBAL_ACCESS_MODE = "global_access_mode";
759 
762  public const string NO_ACCESS = "no_access";
763 
766  public const string READ_ONLY = "read_only";
767 
770  public const string WRITE_ONLY = "write_only";
771 
774  public const string READ_WRITE = "read_write";
775 
779  public const string VIEW_TABLE_NAME = "view_table_name";
780 
785  public const string IS_VIEW_PERSISTED = "is_view_persisted";
786 
790  public const string IS_DIRTY = "is_dirty";
791 
795  public const string REFRESH_METHOD = "refresh_method";
796 
800  public const string REFRESH_START_TIME = "refresh_start_time";
801 
805  public const string REFRESH_PERIOD = "refresh_period";
806 
810  public const string LAST_REFRESH_TIME = "last_refresh_time";
811 
815  public const string NEXT_REFRESH_TIME = "next_refresh_time";
816 
820  public const string USER_CHUNK_SIZE = "user_chunk_size";
821 
825  public const string ALTERNATE_SHARD_KEYS = "alternate_shard_keys";
826  } // end struct AdditionalInfo
827 
828 
831  public string table_name { get; set; }
832 
844  public IList<string> table_names { get; set; } = new List<string>();
845 
883  public IList<IList<string>> table_descriptions { get; set; } = new List<IList<string>>();
884 
887  public IList<string> type_ids { get; set; } = new List<string>();
888 
891  public IList<string> type_schemas { get; set; } = new List<string>();
892 
895  public IList<string> type_labels { get; set; } = new List<string>();
896 
899  public IList<IDictionary<string, IList<string>>> properties { get; set; } = new List<IDictionary<string, IList<string>>>();
900 
906  public IList<IDictionary<string, string>> additional_info { get; set; } = new List<IDictionary<string, string>>();
907 
911  public IList<long> sizes { get; set; } = new List<long>();
912 
917  public IList<long> full_sizes { get; set; } = new List<long>();
918 
927  public IList<double> join_sizes { get; set; } = new List<double>();
928 
931  public long total_size { get; set; }
932 
936  public long total_full_size { get; set; }
937 
939  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
940 
941  } // end class ShowTableResponse
942 
943 
944 
945 
946 } // end namespace kinetica
const string IS_DIRTY
True if some input table of the materialized view that affects this member table has been modified si...
Definition: ShowTable.cs:790
IList< long > full_sizes
If get_sizes is true, an array containing the number of records of each corresponding table in &lt;membe...
Definition: ShowTable.cs:917
const string PARTITION_KEYS
Comma-separated list of partition keys.
Definition: ShowTable.cs:695
IList< IList< string > > table_descriptions
List of descriptions for the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:883
IList< long > sizes
If get_sizes is true, an array containing the number of records of each corresponding table in &lt;membe...
Definition: ShowTable.cs:911
const string IS_VIEW_PERSISTED
True if the view named view_table_name is persisted - reported for each view member.
Definition: ShowTable.cs:785
const string COMPRESSED_COLUMNS
Semicolon-separated list of compressed columns with the corresponding compression type for each; e...
Definition: ShowTable.cs:721
const string NO_ERROR_IF_NOT_EXISTS
If false will return an error if the provided table_name does not exist.
Definition: ShowTable.cs:231
Additional information about the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:561
const string RECORD_BYTES
The number of in-memory bytes per record which is the sum of the byte sizes of all columns with prope...
Definition: ShowTable.cs:610
const string GET_SIZES
If true then the number of records in each table, along with a cumulative count, will be returned; bl...
Definition: ShowTable.cs:191
const string NO_ACCESS
No read/write operations are allowed on this table.
Definition: ShowTable.cs:762
const string ALTERNATE_SHARD_KEYS
Semicolon-separated list of shard keys that were equated in joins (applicable for join tables)...
Definition: ShowTable.cs:825
IList< string > type_schemas
Type schemas of the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:891
IList< IDictionary< string, IList< string > > > properties
Property maps of the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:899
IDictionary< string, string > options
Optional parameters.
Definition: ShowTable.cs:364
IList< string > type_ids
Type ids of the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:887
const string FOREIGN_SHARD_KEY
Foreign shard key description of the format: &#39;fk_foreign_key references pk_column_name from pk_table_...
Definition: ShowTable.cs:638
const string REQUEST_AVRO_JSON
The JSON representation of request creating this table.
Definition: ShowTable.cs:587
const string FORCE_SYNCHRONOUS
If true then the table sizes will wait for read lock before returning.
Definition: ShowTable.cs:171
const string COLUMN_INFO
JSON-encoded string representing a map of column name to information including memory usage if if the...
Definition: ShowTable.cs:727
const string REFRESH_START_TIME
For materialized view with periodic refresh_method the current intial datetime string that periodic r...
Definition: ShowTable.cs:800
const string READ_WRITE
All read/write operations are allowed on this table.
Definition: ShowTable.cs:774
IList< string > table_names
If is a table or view, then the single element of the array is .
Definition: ShowTable.cs:844
const string GET_COLUMN_INFO
If true then column info (memory usage, etc) will be returned.
Definition: ShowTable.cs:248
const string VIEW_TABLE_NAME
For materialized view the name of the view this member table is part of - if same as the table_name t...
Definition: ShowTable.cs:779
const string TABLE_TTL
The value of the time-to-live setting.
Definition: ShowTable.cs:619
const string REFRESH_PERIOD
For materialized view with periodic refresh_method the current refresh period in seconds.
Definition: ShowTable.cs:805
ShowTableRequest(string table_name, IDictionary< string, string > options=null)
Constructs a ShowTableRequest object with the specified parameters.
Definition: ShowTable.cs:485
ShowTableRequest()
Constructs a ShowTableRequest object with default parameters.
Definition: ShowTable.cs:369
A set of results returned by Kinetica.showTable(string,IDictionary{string, string}).
Definition: ShowTable.cs:499
const string SHOW_CHILDREN
If table_name is a collection, then true will return information about the children of the collection...
Definition: ShowTable.cs:213
const string FOREIGN_KEYS
Semicolon-separated list of foreign keys, of the format &#39;source_column references target_table(primar...
Definition: ShowTable.cs:632
const string NONE
Using no partitioning
Definition: ShowTable.cs:691
const string RANGE
Using range partitioning
Definition: ShowTable.cs:678
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the partition_type.
Definition: ShowTable.cs:702
const string ATTRIBUTE_INDEXES
Semicolon-separated list of columns that have indexes.
Definition: ShowTable.cs:713
const string PROTECTED
Indicates whether the respective table is protected or not.
Definition: ShowTable.cs:603
const string IS_AUTOMATIC_PARTITION
True if partitions will be created for LIST VALUES which don&#39;t fall into existing partitions...
Definition: ShowTable.cs:707
const string GLOBAL_ACCESS_MODE
Returns the global access mode (i.e.
Definition: ShowTable.cs:758
IList< double > join_sizes
If get_sizes is true, an array containing the number of unfiltered records in the cross product of th...
Definition: ShowTable.cs:927
const string LAST_REFRESH_TIME
For materialized view the a datatime string indicating the last time the view was refreshed...
Definition: ShowTable.cs:810
const string READ_ONLY
Only read operations are allowed on this table.
Definition: ShowTable.cs:766
List of descriptions for the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:541
A set of parameters for Kinetica.showTable(string,IDictionary{string, string}).
Definition: ShowTable.cs:41
IDictionary< string, string > info
Additional information.
Definition: ShowTable.cs:939
const string NEXT_REFRESH_TIME
For materialized view with periodic refresh_method a datetime string indicating the next time the vie...
Definition: ShowTable.cs:815
const string REQUEST_AVRO_TYPE
Method by which this table was created.
Definition: ShowTable.cs:580
Optional parameters.
Definition: ShowTable.cs:153
const string REFRESH_METHOD
For materialized view current refresh_method - one of manual, periodic, on_change.
Definition: ShowTable.cs:795
string table_name
Value of .
Definition: ShowTable.cs:831
IList< string > type_labels
Type labels of the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:895
IList< IDictionary< string, string > > additional_info
Additional information about the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:906
const string PARTITION_TYPE
Partitioning scheme used for this table Supported values: RANGE: Using range partitioning INTERVAL: ...
Definition: ShowTable.cs:673
const string REMAINING_TABLE_TTL
The remaining time-to-live, in minutes, before the respective table expires (-1 if it will never expi...
Definition: ShowTable.cs:625
const string COLLECTION_NAMES
The names of the collections this table is part of.
Definition: ShowTable.cs:614
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
long total_full_size
If get_sizes is true, the sum of the elements of &lt;member name=&quot;full_sizes&quot;&gt; (same value as &lt;member na...
Definition: ShowTable.cs:936
long total_size
If get_sizes is true, the sum of the elements of &lt;member name=&quot;sizes&quot;&gt;.
Definition: ShowTable.cs:931
const string WRITE_ONLY
Only write operations are allowed on this table.
Definition: ShowTable.cs:770
const string INTERVAL
Using interval partitioning
Definition: ShowTable.cs:683
string table_name
Name of the table for which to retrieve the information.
Definition: ShowTable.cs:255
const string LIST
Using manual list partitioning
Definition: ShowTable.cs:688
const string USER_CHUNK_SIZE
User-specified number of records per chunk, if provided at table creation time.
Definition: ShowTable.cs:820