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 {
43  public class ShowTableRequest : KineticaData
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_ACCESS_DATA = "get_access_data";
97 
112  public const string GET_CACHED_SIZES = "get_cached_sizes";
113 
128  public const string GET_SIZES = "get_sizes";
129 
143  public const string SKIP_ADDITIONAL_INFO = "skip_additional_info";
144 
159  public const string NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists";
160 
175  public const string SKIP_TEMP_SCHEMAS = "skip_temp_schemas";
176 
193  public const string SHOW_CHILDREN = "show_children";
194 
208  public const string GET_COLUMN_INFO = "get_column_info";
209  } // end struct Options
210 
217  public string table_name { get; set; }
218 
416  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
417 
420  public ShowTableRequest() { }
421 
627  public ShowTableRequest( string table_name,
628  IDictionary<string, string> options = null)
629  {
630  this.table_name = table_name ?? "";
631  this.options = options ?? new Dictionary<string, string>();
632  } // end constructor
633  } // end class ShowTableRequest
634 
638  public class ShowTableResponse : KineticaData
639  {
644  public struct TableDescriptions
645  {
646  public const string COLLECTION = "COLLECTION";
647  public const string JOIN = "JOIN";
648  public const string LOGICAL_EXTERNAL_TABLE = "LOGICAL_EXTERNAL_TABLE";
649  public const string LOGICAL_VIEW = "LOGICAL_VIEW";
650  public const string MATERIALIZED_EXTERNAL_TABLE = "MATERIALIZED_EXTERNAL_TABLE";
651  public const string MATERIALIZED_VIEW = "MATERIALIZED_VIEW";
652  public const string MATERIALIZED_VIEW_MEMBER = "MATERIALIZED_VIEW_MEMBER";
653  public const string MATERIALIZED_VIEW_UNDER_CONSTRUCTION = "MATERIALIZED_VIEW_UNDER_CONSTRUCTION";
654  public const string REPLICATED = "REPLICATED";
655  public const string RESULT_TABLE = "RESULT_TABLE";
656  public const string SCHEMA = "SCHEMA";
657  public const string VIEW = "VIEW";
658  } // end struct TableDescriptions
659 
664  public struct AdditionalInfo
665  {
685  public const string REQUEST_AVRO_TYPE = "request_avro_type";
686 
687  public const string CREATE_TABLE = "create_table";
688  public const string CREATE_PROJECTION = "create_projection";
689  public const string CREATE_UNION = "create_union";
690 
694  public const string REQUEST_AVRO_JSON = "request_avro_json";
695 
707  public const string PROTECTED = "protected";
708 
709  public const string TRUE = "true";
710  public const string FALSE = "false";
711 
715  public const string RECORD_BYTES = "record_bytes";
716 
719  public const string TOTAL_BYTES = "total_bytes";
720 
725  public const string COLLECTION_NAMES = "collection_names";
726 
730  public const string SCHEMA_NAME = "schema_name";
731 
735  public const string TABLE_TTL = "table_ttl";
736 
742  public const string REMAINING_TABLE_TTL = "remaining_table_ttl";
743 
759  public const string PRIMARY_KEY_TYPE = "primary_key_type";
760 
762  public const string MEMORY = "memory";
763 
765  public const string DISK = "disk";
766 
773  public const string FOREIGN_KEYS = "foreign_keys";
774 
780  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
781 
831  public const string PARTITION_TYPE = "partition_type";
832 
836  public const string RANGE = "RANGE";
837 
841  public const string INTERVAL = "INTERVAL";
842 
846  public const string LIST = "LIST";
847 
851  public const string HASH = "HASH";
852 
856  public const string SERIES = "SERIES";
857 
859  public const string NONE = "NONE";
860 
863  public const string PARTITION_KEYS = "partition_keys";
864 
871  public const string PARTITION_DEFINITIONS = "partition_definitions";
872 
876  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
877 
888  public const string ATTRIBUTE_INDEXES = "attribute_indexes";
889 
896  public const string COLUMN_INFO = "column_info";
897 
929  public const string GLOBAL_ACCESS_MODE = "global_access_mode";
930 
933  public const string NO_ACCESS = "no_access";
934 
937  public const string READ_ONLY = "read_only";
938 
941  public const string WRITE_ONLY = "write_only";
942 
945  public const string READ_WRITE = "read_write";
946 
951  public const string VIEW_TABLE_NAME = "view_table_name";
952 
958  public const string IS_VIEW_PERSISTED = "is_view_persisted";
959 
964  public const string IS_DIRTY = "is_dirty";
965 
969  public const string REFRESH_METHOD = "refresh_method";
970 
975  public const string REFRESH_START_TIME = "refresh_start_time";
976 
980  public const string REFRESH_STOP_TIME = "refresh_stop_time";
981 
985  public const string REFRESH_PERIOD = "refresh_period";
986 
990  public const string LAST_REFRESH_TIME = "last_refresh_time";
991 
996  public const string NEXT_REFRESH_TIME = "next_refresh_time";
997 
1001  public const string USER_CHUNK_SIZE = "user_chunk_size";
1002 
1006  public const string USER_CHUNK_COLUMN_MAX_MEMORY = "user_chunk_column_max_memory";
1007 
1011  public const string USER_CHUNK_MAX_MEMORY = "user_chunk_max_memory";
1012 
1015  public const string OWNER_RESOURCE_GROUP = "owner_resource_group";
1016 
1020  public const string ALTERNATE_SHARD_KEYS = "alternate_shard_keys";
1021 
1025  public const string DATASOURCE_SUBSCRIPTIONS = "datasource_subscriptions";
1026 
1030  public const string NULL_MODIFYING_COLUMNS = "null_modifying_columns";
1031 
1036  public const string COMPRESSION_CODEC = "compression_codec";
1037 
1040  public const string CREATED_BY = "created_by";
1041 
1045  public const string CREATED_TIME = "created_time";
1046 
1049  public const string LAST_READ_BY = "last_read_by";
1050 
1054  public const string LAST_READ_TIME = "last_read_time";
1055 
1058  public const string READ_COUNT = "read_count";
1059 
1062  public const string LAST_WRITE_BY = "last_write_by";
1063 
1066  public const string LAST_WRITE_TIME = "last_write_time";
1067 
1070  public const string WRITE_COUNT = "write_count";
1071 
1074  public const string LAST_ALTER_BY = "last_alter_by";
1075 
1079  public const string LAST_ALTER_TIME = "last_alter_time";
1080 
1084  public const string ALTER_COUNT = "alter_count";
1085  } // end struct AdditionalInfo
1086 
1089  public string table_name { get; set; }
1090 
1108  public IList<string> table_names { get; set; } = new List<string>();
1109 
1168  public IList<IList<string>> table_descriptions { get; set; } = new List<IList<string>>();
1169 
1172  public IList<string> type_ids { get; set; } = new List<string>();
1173 
1176  public IList<string> type_schemas { get; set; } = new List<string>();
1177 
1180  public IList<string> type_labels { get; set; } = new List<string>();
1181 
1184  public IList<IDictionary<string, IList<string>>> properties { get; set; } = new List<IDictionary<string, IList<string>>>();
1185 
1678  public IList<IDictionary<string, string>> additional_info { get; set; } = new List<IDictionary<string, string>>();
1679 
1686  public IList<long> sizes { get; set; } = new List<long>();
1687 
1695  public IList<long> full_sizes { get; set; } = new List<long>();
1696 
1710  public IList<double> join_sizes { get; set; } = new List<double>();
1711 
1717  public long total_size { get; set; }
1718 
1725  public long total_full_size { get; set; }
1726 
1728  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1729  } // end class ShowTableResponse
1730 } // end namespace kinetica
const string REFRESH_STOP_TIME
Time at which the periodic view refresh stops.
Definition: ShowTable.cs:980
const string DEPENDENCIES
Include view dependencies in the output.
Definition: ShowTable.cs:62
const string LIST
Using manual list partitioning
Definition: ShowTable.cs:846
const string TABLE_TTL
The value of the time-to-live setting.
Definition: ShowTable.cs:735
const string REQUEST_AVRO_JSON
The JSON representation of request creating this table.
Definition: ShowTable.cs:694
string table_name
Name of the table for which to retrieve the information, in [schema_name.
Definition: ShowTable.cs:217
IList< IList< string > > table_descriptions
List of descriptions for the respective tables in table_names.
Definition: ShowTable.cs:1168
const string FOREIGN_KEYS
Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primar...
Definition: ShowTable.cs:773
const string NO_ERROR_IF_NOT_EXISTS
If FALSE will return an error if the provided table_name does not exist.
Definition: ShowTable.cs:159
const string ATTRIBUTE_INDEXES
Semicolon-separated list of indexes.
Definition: ShowTable.cs:888
const string LAST_WRITE_BY
User that last wrote to this table.
Definition: ShowTable.cs:1062
const string NO_ACCESS
No read/write operations are allowed on this table.
Definition: ShowTable.cs:933
const string GLOBAL_ACCESS_MODE
Returns the global access mode (i.e.
Definition: ShowTable.cs:929
const string CREATED_TIME
Time (UTC) when this table or view was created.
Definition: ShowTable.cs:1045
const string IS_AUTOMATIC_PARTITION
True if partitions will be created for LIST VALUES which don't fall into existing partitions.
Definition: ShowTable.cs:876
const string INTERVAL
Using interval partitioning
Definition: ShowTable.cs:841
const string READ_ONLY
Only read operations are allowed on this table.
Definition: ShowTable.cs:937
const string LAST_WRITE_TIME
Time (UTC) when this table was last written.
Definition: ShowTable.cs:1066
const string SKIP_ADDITIONAL_INFO
If TRUE then the response will not populate the additional_info field.
Definition: ShowTable.cs:143
const string WRITE_ONLY
Only write operations are allowed on this table.
Definition: ShowTable.cs:941
const string LAST_REFRESH_TIME
For materialized view the datetime string indicating the last time the view was refreshed.
Definition: ShowTable.cs:990
const string ALTERNATE_SHARD_KEYS
Semicolon-separated list of shard keys that were equated in joins (applicable for join tables).
Definition: ShowTable.cs:1020
long total_size
If GET_SIZES is TRUE, the sum of the elements of sizes.
Definition: ShowTable.cs:1717
const string PROTECTED
No longer used.
Definition: ShowTable.cs:707
const string COMPRESSION_CODEC
Default compression codec for the table.
Definition: ShowTable.cs:1036
const string DATASOURCE_SUBSCRIPTIONS
Semicolon-separated list of datasource names the table has subscribed to.
Definition: ShowTable.cs:1025
const string NEXT_REFRESH_TIME
For materialized view with periodic refresh_method a datetime string indicating the next time the vie...
Definition: ShowTable.cs:996
const string HASH
Using hash partitioning.
Definition: ShowTable.cs:851
const string FORCE_SYNCHRONOUS
If TRUE then the table sizes will wait for read lock before returning.
Definition: ShowTable.cs:80
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:964
IList< IDictionary< string, string > > additional_info
Additional information about the respective tables in table_names.
Definition: ShowTable.cs:1678
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:1006
ShowTableRequest(string table_name, IDictionary< string, string > options=null)
Constructs a ShowTableRequest object with the specified parameters.
Definition: ShowTable.cs:627
const string USER_CHUNK_SIZE
User-specified number of records per chunk, if provided at table creation time.
Definition: ShowTable.cs:1001
ShowTableRequest()
Constructs a ShowTableRequest object with default parameters.
Definition: ShowTable.cs:420
const string SKIP_TEMP_SCHEMAS
If TRUE then the table list will not include tables from SYS_TEMP and other system temporary schemas.
Definition: ShowTable.cs:175
const string REFRESH_METHOD
For materialized view current refresh_method - one of manual, periodic, on_change.
Definition: ShowTable.cs:969
const string REFRESH_PERIOD
For materialized view with periodic refresh_method the current refresh period in seconds.
Definition: ShowTable.cs:985
const string PARTITION_TYPE
Partitioning scheme used for this table.
Definition: ShowTable.cs:831
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:193
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:951
const string NONE
Using no partitioning
Definition: ShowTable.cs:859
const string SCHEMA_NAME
The name of the schema for the table.
Definition: ShowTable.cs:730
const string REQUEST_AVRO_TYPE
Method by which this table was created.
Definition: ShowTable.cs:685
IList< IDictionary< string, IList< string > > > properties
Property maps of the respective tables in table_names.
Definition: ShowTable.cs:1184
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:1695
const string DISK
On-disk primary key
Definition: ShowTable.cs:765
const string READ_WRITE
All read/write operations are allowed on this table.
Definition: ShowTable.cs:945
const string NULL_MODIFYING_COLUMNS
Comma-separated list of null modifying column names.
Definition: ShowTable.cs:1030
const string GET_COLUMN_INFO
If TRUE then column info (memory usage, etc) will be returned.
Definition: ShowTable.cs:208
const string LAST_ALTER_TIME
Time (UTC) when this table or view was last altered.
Definition: ShowTable.cs:1079
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:1710
const string ALTER_COUNT
Count of times this table or view was altered.
Definition: ShowTable.cs:1084
const string OWNER_RESOURCE_GROUP
Name of the owner resource group.
Definition: ShowTable.cs:1015
const string PRIMARY_KEY_TYPE
The primary key type of the table (if it has a primary key).
Definition: ShowTable.cs:759
const string REFRESH_START_TIME
For materialized view with periodic refresh_method the initial datetime string that periodic refreshe...
Definition: ShowTable.cs:975
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:1011
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:112
IDictionary< string, string > info
Additional information.
Definition: ShowTable.cs:1728
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:715
const string TOTAL_BYTES
The total size in bytes of all data stored in the table.
Definition: ShowTable.cs:719
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the partition_type.
Definition: ShowTable.cs:871
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:1108
IList< long > sizes
If GET_SIZES is TRUE, an array containing the number of records of each corresponding table in table_...
Definition: ShowTable.cs:1686
const string LAST_READ_BY
User that last read this table or view.
Definition: ShowTable.cs:1049
IList< string > type_labels
Type labels of the respective tables in table_names.
Definition: ShowTable.cs:1180
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:1725
IList< string > type_ids
Type IDs of the respective tables in table_names.
Definition: ShowTable.cs:1172
const string READ_COUNT
Count of times this table or view was read.
Definition: ShowTable.cs:1058
IDictionary< string, string > options
Optional parameters.
Definition: ShowTable.cs:416
const string COLUMN_INFO
JSON-encoded string representing a map of column name to information including memory usage if the GE...
Definition: ShowTable.cs:896
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:742
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:780
const string PARTITION_KEYS
Comma-separated list of partition keys.
Definition: ShowTable.cs:863
const string COLLECTION_NAMES
[DEPRECATED–use schema_name instead] This will now contain the name of the schema for the table.
Definition: ShowTable.cs:725
const string WRITE_COUNT
Count of times this table was written.
Definition: ShowTable.cs:1070
const string LAST_READ_TIME
Time (UTC) when this table or view was last read.
Definition: ShowTable.cs:1054
string table_name
Value of table_name.
Definition: ShowTable.cs:1089
const string IS_VIEW_PERSISTED
True if the view named view_table_name is persisted - reported for each view member.
Definition: ShowTable.cs:958
const string SERIES
Using series partitioning.
Definition: ShowTable.cs:856
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:128
IList< string > type_schemas
Type schemas of the respective tables in table_names.
Definition: ShowTable.cs:1176
const string LAST_ALTER_BY
User that last altered this table or view.
Definition: ShowTable.cs:1074
const string CREATED_BY
User that created this table or view.
Definition: ShowTable.cs:1040
const string MEMORY
In-memory primary key
Definition: ShowTable.cs:762
const string RANGE
Using range partitioning
Definition: ShowTable.cs:836
const string GET_ACCESS_DATA
If TRUE then data about the last read, write, alter and create will be returned.
Definition: ShowTable.cs:96