Kinetica C# API  Version 7.1.10.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 
48  {
49 
180  public struct Options
181  {
182 
198  public const string FORCE_SYNCHRONOUS = "force_synchronous";
199  public const string TRUE = "true";
200  public const string FALSE = "false";
201 
218  public const string GET_SIZES = "get_sizes";
219 
237  public const string GET_CACHED_SIZES = "get_cached_sizes";
238 
259  public const string SHOW_CHILDREN = "show_children";
260 
277  public const string NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists";
278 
294  public const string GET_COLUMN_INFO = "get_column_info";
295  } // end struct Options
296 
297 
303  public string table_name { get; set; }
304 
433  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
434 
435 
438  public ShowTableRequest() { }
439 
577  public ShowTableRequest( string table_name,
578  IDictionary<string, string> options = null)
579  {
580  this.table_name = table_name ?? "";
581  this.options = options ?? new Dictionary<string, string>();
582  } // end constructor
583 
584  } // end class ShowTableRequest
585 
586 
587 
592  {
593 
649  public struct TableDescriptions
650  {
651  public const string COLLECTION = "COLLECTION";
652  public const string JOIN = "JOIN";
653  public const string LOGICAL_EXTERNAL_TABLE = "LOGICAL_EXTERNAL_TABLE";
654  public const string LOGICAL_VIEW = "LOGICAL_VIEW";
655  public const string MATERIALIZED_EXTERNAL_TABLE = "MATERIALIZED_EXTERNAL_TABLE";
656  public const string MATERIALIZED_VIEW = "MATERIALIZED_VIEW";
657  public const string MATERIALIZED_VIEW_MEMBER = "MATERIALIZED_VIEW_MEMBER";
658  public const string MATERIALIZED_VIEW_UNDER_CONSTRUCTION = "MATERIALIZED_VIEW_UNDER_CONSTRUCTION";
659  public const string REPLICATED = "REPLICATED";
660  public const string RESULT_TABLE = "RESULT_TABLE";
661  public const string SCHEMA = "SCHEMA";
662  public const string VIEW = "VIEW";
663  } // end struct TableDescriptions
664 
665 
673  public struct AdditionalInfo
674  {
675 
692  public const string REQUEST_AVRO_TYPE = "request_avro_type";
693  public const string CREATE_TABLE = "create_table";
694  public const string CREATE_PROJECTION = "create_projection";
695  public const string CREATE_UNION = "create_union";
696 
699  public const string REQUEST_AVRO_JSON = "request_avro_json";
700 
714  public const string PROTECTED = "protected";
715  public const string TRUE = "true";
716  public const string FALSE = "false";
717 
721  public const string RECORD_BYTES = "record_bytes";
722 
725  public const string TOTAL_BYTES = "total_bytes";
726 
730  public const string COLLECTION_NAMES = "collection_names";
731 
734  public const string SCHEMA_NAME = "schema_name";
735 
739  public const string TABLE_TTL = "table_ttl";
740 
745  public const string REMAINING_TABLE_TTL = "remaining_table_ttl";
746 
752  public const string FOREIGN_KEYS = "foreign_keys";
753 
758  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
759 
807  public const string PARTITION_TYPE = "partition_type";
808 
812  public const string RANGE = "RANGE";
813 
817  public const string INTERVAL = "INTERVAL";
818 
822  public const string LIST = "LIST";
823 
827  public const string HASH = "HASH";
828 
832  public const string SERIES = "SERIES";
833 
835  public const string NONE = "NONE";
836 
839  public const string PARTITION_KEYS = "partition_keys";
840 
846  public const string PARTITION_DEFINITIONS = "partition_definitions";
847 
851  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
852 
861  public const string ATTRIBUTE_INDEXES = "attribute_indexes";
862 
865  public const string COMPRESSED_COLUMNS = "compressed_columns";
866 
871  public const string COLUMN_INFO = "column_info";
872 
902  public const string GLOBAL_ACCESS_MODE = "global_access_mode";
903 
906  public const string NO_ACCESS = "no_access";
907 
910  public const string READ_ONLY = "read_only";
911 
914  public const string WRITE_ONLY = "write_only";
915 
918  public const string READ_WRITE = "read_write";
919 
923  public const string VIEW_TABLE_NAME = "view_table_name";
924 
929  public const string IS_VIEW_PERSISTED = "is_view_persisted";
930 
934  public const string IS_DIRTY = "is_dirty";
935 
939  public const string REFRESH_METHOD = "refresh_method";
940 
944  public const string REFRESH_START_TIME = "refresh_start_time";
945 
948  public const string REFRESH_STOP_TIME = "refresh_stop_time";
949 
953  public const string REFRESH_PERIOD = "refresh_period";
954 
958  public const string LAST_REFRESH_TIME = "last_refresh_time";
959 
963  public const string NEXT_REFRESH_TIME = "next_refresh_time";
964 
968  public const string USER_CHUNK_SIZE = "user_chunk_size";
969 
972  public const string OWNER_RESOURCE_GROUP = "owner_resource_group";
973 
977  public const string ALTERNATE_SHARD_KEYS = "alternate_shard_keys";
978 
981  public const string DATASOURCE_SUBSCRIPTIONS = "datasource_subscriptions";
982  } // end struct AdditionalInfo
983 
984 
987  public string table_name { get; set; }
988 
1001  public IList<string> table_names { get; set; } = new List<string>();
1002 
1056  public IList<IList<string>> table_descriptions { get; set; } = new List<IList<string>>();
1057 
1060  public IList<string> type_ids { get; set; } = new List<string>();
1061 
1064  public IList<string> type_schemas { get; set; } = new List<string>();
1065 
1068  public IList<string> type_labels { get; set; } = new List<string>();
1069 
1072  public IList<IDictionary<string, IList<string>>> properties { get; set; } = new List<IDictionary<string, IList<string>>>();
1073 
1079  public IList<IDictionary<string, string>> additional_info { get; set; } = new List<IDictionary<string, string>>();
1080 
1084  public IList<long> sizes { get; set; } = new List<long>();
1085 
1090  public IList<long> full_sizes { get; set; } = new List<long>();
1091 
1100  public IList<double> join_sizes { get; set; } = new List<double>();
1101 
1104  public long total_size { get; set; }
1105 
1109  public long total_full_size { get; set; }
1110 
1112  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1113 
1114  } // end class ShowTableResponse
1115 
1116 
1117 
1118 
1119 } // 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:934
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:1090
const string PARTITION_KEYS
Comma-separated list of partition keys.
Definition: ShowTable.cs:839
IList< IList< string > > table_descriptions
List of descriptions for the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:1056
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:1084
const string IS_VIEW_PERSISTED
True if the view named view_table_name is persisted - reported for each view member.
Definition: ShowTable.cs:929
const string COMPRESSED_COLUMNS
No longer supported.
Definition: ShowTable.cs:865
const string NO_ERROR_IF_NOT_EXISTS
If false will return an error if the provided table_name does not exist.
Definition: ShowTable.cs:277
Additional information about the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:673
const string REFRESH_STOP_TIME
Time at which the periodic view refresh stops.
Definition: ShowTable.cs:948
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:721
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:218
const string NO_ACCESS
No read/write operations are allowed on this table.
Definition: ShowTable.cs:906
const string ALTERNATE_SHARD_KEYS
Semicolon-separated list of shard keys that were equated in joins (applicable for join tables)...
Definition: ShowTable.cs:977
IList< string > type_schemas
Type schemas of the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:1064
IList< IDictionary< string, IList< string > > > properties
Property maps of the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:1072
IDictionary< string, string > options
Optional parameters.
Definition: ShowTable.cs:433
IList< string > type_ids
Type ids of the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:1060
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:758
const string REQUEST_AVRO_JSON
The JSON representation of request creating this table.
Definition: ShowTable.cs:699
const string FORCE_SYNCHRONOUS
If true then the table sizes will wait for read lock before returning.
Definition: ShowTable.cs:198
const string COLUMN_INFO
JSON-encoded string representing a map of column name to information including memory usage if the ge...
Definition: ShowTable.cs:871
const string REFRESH_START_TIME
For materialized view with periodic refresh_method the current intial datetime string that periodic r...
Definition: ShowTable.cs:944
const string READ_WRITE
All read/write operations are allowed on this table.
Definition: ShowTable.cs:918
IList< string > table_names
If is a table or view, then the single element of the array is .
Definition: ShowTable.cs:1001
const string GET_COLUMN_INFO
If true then column info (memory usage, etc) will be returned.
Definition: ShowTable.cs:294
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:923
const string TABLE_TTL
The value of the time-to-live setting.
Definition: ShowTable.cs:739
const string REFRESH_PERIOD
For materialized view with periodic refresh_method the current refresh period in seconds.
Definition: ShowTable.cs:953
const string SCHEMA_NAME
The name of the schema for the table.
Definition: ShowTable.cs:734
ShowTableRequest(string table_name, IDictionary< string, string > options=null)
Constructs a ShowTableRequest object with the specified parameters.
Definition: ShowTable.cs:577
ShowTableRequest()
Constructs a ShowTableRequest object with default parameters.
Definition: ShowTable.cs:438
const string DATASOURCE_SUBSCRIPTIONS
Semicolon-separated list of datasource names the table has subscribed to.
Definition: ShowTable.cs:981
A set of results returned by Kinetica.showTable(string,IDictionary{string, string}).
Definition: ShowTable.cs:591
const string SHOW_CHILDREN
If table_name is a schema, then true will return information about the tables and views in the schema...
Definition: ShowTable.cs:259
const string GET_CACHED_SIZES
If true then the number of records in each table, along with a cumulative count, will be returned; bl...
Definition: ShowTable.cs:237
const string TOTAL_BYTES
The total size in bytes of all data stored in the table.
Definition: ShowTable.cs:725
const string FOREIGN_KEYS
Semicolon-separated list of foreign keys, of the format &#39;source_column references target_table(primar...
Definition: ShowTable.cs:752
const string NONE
Using no partitioning
Definition: ShowTable.cs:835
const string RANGE
Using range partitioning
Definition: ShowTable.cs:812
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the partition_type.
Definition: ShowTable.cs:846
const string ATTRIBUTE_INDEXES
Semicolon-separated list of indexes.
Definition: ShowTable.cs:861
const string PROTECTED
No longer used.
Definition: ShowTable.cs:714
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:851
const string OWNER_RESOURCE_GROUP
Name of the owner resource group.
Definition: ShowTable.cs:972
const string GLOBAL_ACCESS_MODE
Returns the global access mode (i.e.
Definition: ShowTable.cs:902
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:1100
const string LAST_REFRESH_TIME
For materialized view the a datatime string indicating the last time the view was refreshed...
Definition: ShowTable.cs:958
const string READ_ONLY
Only read operations are allowed on this table.
Definition: ShowTable.cs:910
List of descriptions for the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:649
A set of parameters for Kinetica.showTable(string,IDictionary{string, string}).
Definition: ShowTable.cs:47
IDictionary< string, string > info
Additional information.
Definition: ShowTable.cs:1112
const string NEXT_REFRESH_TIME
For materialized view with periodic refresh_method a datetime string indicating the next time the vie...
Definition: ShowTable.cs:963
const string SERIES
Using series partitioning.
Definition: ShowTable.cs:832
const string REQUEST_AVRO_TYPE
Method by which this table was created.
Definition: ShowTable.cs:692
Optional parameters.
Definition: ShowTable.cs:180
const string REFRESH_METHOD
For materialized view current refresh_method - one of manual, periodic, on_change.
Definition: ShowTable.cs:939
string table_name
Value of .
Definition: ShowTable.cs:987
IList< string > type_labels
Type labels of the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:1068
IList< IDictionary< string, string > > additional_info
Additional information about the respective tables in &lt;member name=&quot;table_names&quot;&gt;.
Definition: ShowTable.cs:1079
const string PARTITION_TYPE
Partitioning scheme used for this table Supported values: RANGE: Using range partitioning INTERVAL: ...
Definition: ShowTable.cs:807
const string HASH
Using hash partitioning.
Definition: ShowTable.cs:827
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:745
const string COLLECTION_NAMES
[DEPRECATED–use schema_name instead] This will now contain the name of the schema for the table...
Definition: ShowTable.cs:730
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:1109
long total_size
If get_sizes is true, the sum of the elements of &lt;member name=&quot;sizes&quot;&gt;.
Definition: ShowTable.cs:1104
const string WRITE_ONLY
Only write operations are allowed on this table.
Definition: ShowTable.cs:914
const string INTERVAL
Using interval partitioning
Definition: ShowTable.cs:817
string table_name
Name of the table for which to retrieve the information, in [schema_name.
Definition: ShowTable.cs:303
const string LIST
Using manual list partitioning
Definition: ShowTable.cs:822
const string USER_CHUNK_SIZE
User-specified number of records per chunk, if provided at table creation time.
Definition: ShowTable.cs:968