Kinetica   C#   API  Version 7.2.3.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 namespace kinetica
10 {
44  {
48  public struct Options
49  {
62  public const string DEPENDENCIES = "dependencies";
63 
64  public const string TRUE = "true";
65  public const string FALSE = "false";
66 
80  public const string FORCE_SYNCHRONOUS = "force_synchronous";
81 
96  public const string GET_CACHED_SIZES = "get_cached_sizes";
97 
112  public const string GET_SIZES = "get_sizes";
113 
128  public const string NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists";
129 
146  public const string SHOW_CHILDREN = "show_children";
147 
161  public const string GET_COLUMN_INFO = "get_column_info";
162  } // end struct Options
163 
170  public string table_name { get; set; }
171 
312  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
313 
316  public ShowTableRequest() { }
317 
466  public ShowTableRequest( string table_name,
467  IDictionary<string, string> options = null)
468  {
469  this.table_name = table_name ?? "";
470  this.options = options ?? new Dictionary<string, string>();
471  } // end constructor
472  } // end class ShowTableRequest
473 
478  {
483  public struct TableDescriptions
484  {
485  public const string COLLECTION = "COLLECTION";
486  public const string JOIN = "JOIN";
487  public const string LOGICAL_EXTERNAL_TABLE = "LOGICAL_EXTERNAL_TABLE";
488  public const string LOGICAL_VIEW = "LOGICAL_VIEW";
489  public const string MATERIALIZED_EXTERNAL_TABLE = "MATERIALIZED_EXTERNAL_TABLE";
490  public const string MATERIALIZED_VIEW = "MATERIALIZED_VIEW";
491  public const string MATERIALIZED_VIEW_MEMBER = "MATERIALIZED_VIEW_MEMBER";
492  public const string MATERIALIZED_VIEW_UNDER_CONSTRUCTION = "MATERIALIZED_VIEW_UNDER_CONSTRUCTION";
493  public const string REPLICATED = "REPLICATED";
494  public const string RESULT_TABLE = "RESULT_TABLE";
495  public const string SCHEMA = "SCHEMA";
496  public const string VIEW = "VIEW";
497  } // end struct TableDescriptions
498 
503  public struct AdditionalInfo
504  {
524  public const string REQUEST_AVRO_TYPE = "request_avro_type";
525 
526  public const string CREATE_TABLE = "create_table";
527  public const string CREATE_PROJECTION = "create_projection";
528  public const string CREATE_UNION = "create_union";
529 
533  public const string REQUEST_AVRO_JSON = "request_avro_json";
534 
546  public const string PROTECTED = "protected";
547 
548  public const string TRUE = "true";
549  public const string FALSE = "false";
550 
554  public const string RECORD_BYTES = "record_bytes";
555 
558  public const string TOTAL_BYTES = "total_bytes";
559 
564  public const string COLLECTION_NAMES = "collection_names";
565 
569  public const string SCHEMA_NAME = "schema_name";
570 
574  public const string TABLE_TTL = "table_ttl";
575 
581  public const string REMAINING_TABLE_TTL = "remaining_table_ttl";
582 
598  public const string PRIMARY_KEY_TYPE = "primary_key_type";
599 
601  public const string MEMORY = "memory";
602 
604  public const string DISK = "disk";
605 
612  public const string FOREIGN_KEYS = "foreign_keys";
613 
619  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
620 
670  public const string PARTITION_TYPE = "partition_type";
671 
675  public const string RANGE = "RANGE";
676 
680  public const string INTERVAL = "INTERVAL";
681 
685  public const string LIST = "LIST";
686 
690  public const string HASH = "HASH";
691 
695  public const string SERIES = "SERIES";
696 
698  public const string NONE = "NONE";
699 
702  public const string PARTITION_KEYS = "partition_keys";
703 
710  public const string PARTITION_DEFINITIONS = "partition_definitions";
711 
715  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
716 
727  public const string ATTRIBUTE_INDEXES = "attribute_indexes";
728 
731  public const string COMPRESSED_COLUMNS = "compressed_columns";
732 
739  public const string COLUMN_INFO = "column_info";
740 
772  public const string GLOBAL_ACCESS_MODE = "global_access_mode";
773 
776  public const string NO_ACCESS = "no_access";
777 
780  public const string READ_ONLY = "read_only";
781 
784  public const string WRITE_ONLY = "write_only";
785 
788  public const string READ_WRITE = "read_write";
789 
794  public const string VIEW_TABLE_NAME = "view_table_name";
795 
801  public const string IS_VIEW_PERSISTED = "is_view_persisted";
802 
807  public const string IS_DIRTY = "is_dirty";
808 
812  public const string REFRESH_METHOD = "refresh_method";
813 
818  public const string REFRESH_START_TIME = "refresh_start_time";
819 
823  public const string REFRESH_STOP_TIME = "refresh_stop_time";
824 
828  public const string REFRESH_PERIOD = "refresh_period";
829 
833  public const string LAST_REFRESH_TIME = "last_refresh_time";
834 
839  public const string NEXT_REFRESH_TIME = "next_refresh_time";
840 
844  public const string USER_CHUNK_SIZE = "user_chunk_size";
845 
849  public const string USER_CHUNK_COLUMN_MAX_MEMORY = "user_chunk_column_max_memory";
850 
854  public const string USER_CHUNK_MAX_MEMORY = "user_chunk_max_memory";
855 
858  public const string OWNER_RESOURCE_GROUP = "owner_resource_group";
859 
863  public const string ALTERNATE_SHARD_KEYS = "alternate_shard_keys";
864 
868  public const string DATASOURCE_SUBSCRIPTIONS = "datasource_subscriptions";
869 
873  public const string NULL_MODIFYING_COLUMNS = "null_modifying_columns";
874  } // end struct AdditionalInfo
875 
878  public string table_name { get; set; }
879 
897  public IList<string> table_names { get; set; } = new List<string>();
898 
957  public IList<IList<string>> table_descriptions { get; set; } = new List<IList<string>>();
958 
961  public IList<string> type_ids { get; set; } = new List<string>();
962 
965  public IList<string> type_schemas { get; set; } = new List<string>();
966 
969  public IList<string> type_labels { get; set; } = new List<string>();
970 
973  public IList<IDictionary<string, IList<string>>> properties { get; set; } = new List<IDictionary<string, IList<string>>>();
974 
1393  public IList<IDictionary<string, string>> additional_info { get; set; } = new List<IDictionary<string, string>>();
1394 
1401  public IList<long> sizes { get; set; } = new List<long>();
1402 
1410  public IList<long> full_sizes { get; set; } = new List<long>();
1411 
1425  public IList<double> join_sizes { get; set; } = new List<double>();
1426 
1432  public long total_size { get; set; }
1433 
1440  public long total_full_size { get; set; }
1441 
1443  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1444  } // end class ShowTableResponse
1445 } // end namespace kinetica
const string DISK
On-disk primary key
Definition: ShowTable.cs:604
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:807
const string NULL_MODIFYING_COLUMNS
Comma-separated list of null modifying column names.
Definition: ShowTable.cs:873
IList< long > full_sizes
If GET_SIZES is TRUE, an array containing the number of records of each corresponding table in table_...
Definition: ShowTable.cs:1410
const string PARTITION_KEYS
Comma-separated list of partition keys.
Definition: ShowTable.cs:702
IList< IList< string > > table_descriptions
List of descriptions for the respective tables in table_names.
Definition: ShowTable.cs:957
IList< long > sizes
If GET_SIZES is TRUE, an array containing the number of records of each corresponding table in table_...
Definition: ShowTable.cs:1401
const string IS_VIEW_PERSISTED
True if the view named view_table_name is persisted - reported for each view member.
Definition: ShowTable.cs:801
const string COMPRESSED_COLUMNS
No longer supported.
Definition: ShowTable.cs:731
const string NO_ERROR_IF_NOT_EXISTS
If FALSE will return an error if the provided table_name does not exist.
Definition: ShowTable.cs:128
A set of string constants for the parameter additional_info.
Definition: ShowTable.cs:503
const string REFRESH_STOP_TIME
Time at which the periodic view refresh stops.
Definition: ShowTable.cs:823
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:554
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:112
const string NO_ACCESS
No read/write operations are allowed on this table.
Definition: ShowTable.cs:776
const string ALTERNATE_SHARD_KEYS
Semicolon-separated list of shard keys that were equated in joins (applicable for join tables).
Definition: ShowTable.cs:863
IList< string > type_schemas
Type schemas of the respective tables in table_names.
Definition: ShowTable.cs:965
IList< IDictionary< string, IList< string > > > properties
Property maps of the respective tables in table_names.
Definition: ShowTable.cs:973
IDictionary< string, string > options
Optional parameters.
Definition: ShowTable.cs:312
IList< string > type_ids
Type ids of the respective tables in table_names.
Definition: ShowTable.cs:961
const string FOREIGN_SHARD_KEY
Foreign shard key description of the format: <fk_foreign_key> references <pk_column_name> from <pk_ta...
Definition: ShowTable.cs:619
const string REQUEST_AVRO_JSON
The JSON representation of request creating this table.
Definition: ShowTable.cs:533
const string FORCE_SYNCHRONOUS
If TRUE then the table sizes will wait for read lock before returning.
Definition: ShowTable.cs:80
const string USER_CHUNK_MAX_MEMORY
User-specified target max bytes for all columns in a chunk, if provided at table creation time.
Definition: ShowTable.cs:854
const string DEPENDENCIES
Include view dependencies in the output.
Definition: ShowTable.cs:62
const string COLUMN_INFO
JSON-encoded string representing a map of column name to information including memory usage if the GE...
Definition: ShowTable.cs:739
const string REFRESH_START_TIME
For materialized view with periodic refresh_method the current intial datetime string that periodic r...
Definition: ShowTable.cs:818
const string READ_WRITE
All read/write operations are allowed on this table.
Definition: ShowTable.cs:788
IList< string > table_names
If table_name is a table or view, then the single element of the array is table_name.
Definition: ShowTable.cs:897
const string GET_COLUMN_INFO
If TRUE then column info (memory usage, etc) will be returned.
Definition: ShowTable.cs:161
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:794
const string TABLE_TTL
The value of the time-to-live setting.
Definition: ShowTable.cs:574
const string USER_CHUNK_COLUMN_MAX_MEMORY
User-specified target max bytes per column in a chunk, if provided at table creation time.
Definition: ShowTable.cs:849
const string REFRESH_PERIOD
For materialized view with periodic refresh_method the current refresh period in seconds.
Definition: ShowTable.cs:828
const string SCHEMA_NAME
The name of the schema for the table.
Definition: ShowTable.cs:569
ShowTableRequest(string table_name, IDictionary< string, string > options=null)
Constructs a ShowTableRequest object with the specified parameters.
Definition: ShowTable.cs:466
ShowTableRequest()
Constructs a ShowTableRequest object with default parameters.
Definition: ShowTable.cs:316
const string DATASOURCE_SUBSCRIPTIONS
Semicolon-separated list of datasource names the table has subscribed to.
Definition: ShowTable.cs:868
A set of results returned by Kinetica.showTable.
Definition: ShowTable.cs:477
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:146
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:96
const string MEMORY
In-memory primary key
Definition: ShowTable.cs:601
const string TOTAL_BYTES
The total size in bytes of all data stored in the table.
Definition: ShowTable.cs:558
const string FOREIGN_KEYS
Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primar...
Definition: ShowTable.cs:612
const string NONE
Using no partitioning
Definition: ShowTable.cs:698
const string RANGE
Using range partitioning
Definition: ShowTable.cs:675
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the partition_type.
Definition: ShowTable.cs:710
const string ATTRIBUTE_INDEXES
Semicolon-separated list of indexes.
Definition: ShowTable.cs:727
const string PROTECTED
No longer used.
Definition: ShowTable.cs:546
const string IS_AUTOMATIC_PARTITION
True if partitions will be created for LIST VALUES which don't fall into existing partitions.
Definition: ShowTable.cs:715
const string PRIMARY_KEY_TYPE
The primary key type of the table (if it has a primary key).
Definition: ShowTable.cs:598
const string OWNER_RESOURCE_GROUP
Name of the owner resource group.
Definition: ShowTable.cs:858
const string GLOBAL_ACCESS_MODE
Returns the global access mode (i.e.
Definition: ShowTable.cs:772
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:1425
const string LAST_REFRESH_TIME
For materialized view the a datatime string indicating the last time the view was refreshed.
Definition: ShowTable.cs:833
const string READ_ONLY
Only read operations are allowed on this table.
Definition: ShowTable.cs:780
A set of string constants for the parameter table_descriptions.
Definition: ShowTable.cs:483
A set of parameters for Kinetica.showTable.
Definition: ShowTable.cs:43
IDictionary< string, string > info
Additional information.
Definition: ShowTable.cs:1443
const string NEXT_REFRESH_TIME
For materialized view with periodic refresh_method a datetime string indicating the next time the vie...
Definition: ShowTable.cs:839
const string SERIES
Using series partitioning.
Definition: ShowTable.cs:695
const string REQUEST_AVRO_TYPE
Method by which this table was created.
Definition: ShowTable.cs:524
A set of string constants for the parameter options.
Definition: ShowTable.cs:48
const string REFRESH_METHOD
For materialized view current refresh_method - one of manual, periodic, on_change.
Definition: ShowTable.cs:812
string table_name
Value of table_name.
Definition: ShowTable.cs:878
IList< string > type_labels
Type labels of the respective tables in table_names.
Definition: ShowTable.cs:969
IList< IDictionary< string, string > > additional_info
Additional information about the respective tables in table_names.
Definition: ShowTable.cs:1393
const string PARTITION_TYPE
Partitioning scheme used for this table.
Definition: ShowTable.cs:670
const string HASH
Using hash partitioning.
Definition: ShowTable.cs:690
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:581
const string COLLECTION_NAMES
[DEPRECATED–use schema_name instead] This will now contain the name of the schema for the table.
Definition: ShowTable.cs:564
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 full_sizes (same value as total_size).
Definition: ShowTable.cs:1440
long total_size
If GET_SIZES is TRUE, the sum of the elements of sizes.
Definition: ShowTable.cs:1432
const string WRITE_ONLY
Only write operations are allowed on this table.
Definition: ShowTable.cs:784
const string INTERVAL
Using interval partitioning
Definition: ShowTable.cs:680
string table_name
Name of the table for which to retrieve the information, in [schema_name.
Definition: ShowTable.cs:170
const string LIST
Using manual list partitioning
Definition: ShowTable.cs:685
const string USER_CHUNK_SIZE
User-specified number of records per chunk, if provided at table creation time.
Definition: ShowTable.cs:844