Kinetica   C#   API  Version 7.2.3.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 namespace kinetica;
10 
42 {
46  public struct Options
47  {
60  public const string DEPENDENCIES = "dependencies";
61 
62  public const string TRUE = "true";
63  public const string FALSE = "false";
64 
78  public const string FORCE_SYNCHRONOUS = "force_synchronous";
79 
93  public const string GET_ACCESS_DATA = "get_access_data";
94 
109  public const string GET_CACHED_SIZES = "get_cached_sizes";
110 
125  public const string GET_SIZES = "get_sizes";
126 
140  public const string REFERENCING_MATERIALIZED_VIEWS = "referencing_materialized_views";
141 
155  public const string SKIP_ADDITIONAL_INFO = "skip_additional_info";
156 
171  public const string NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists";
172 
187  public const string SKIP_TEMP_SCHEMAS = "skip_temp_schemas";
188 
205  public const string SHOW_CHILDREN = "show_children";
206 
220  public const string GET_COLUMN_INFO = "get_column_info";
221  } // end struct Options
222 
229  public string table_name { get; set; }
230 
441  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
442 
445  public ShowTableRequest() { }
446 
665  public ShowTableRequest( string table_name,
666  IDictionary<string, string> options = null)
667  {
668  this.table_name = table_name ?? "";
669  this.options = options ?? new Dictionary<string, string>();
670  } // end constructor
671 } // end class ShowTableRequest
672 
677 {
682  public struct TableDescriptions
683  {
684  public const string COLLECTION = "COLLECTION";
685  public const string JOIN = "JOIN";
686  public const string LOGICAL_EXTERNAL_TABLE = "LOGICAL_EXTERNAL_TABLE";
687  public const string LOGICAL_VIEW = "LOGICAL_VIEW";
688  public const string MATERIALIZED_EXTERNAL_TABLE = "MATERIALIZED_EXTERNAL_TABLE";
689  public const string MATERIALIZED_VIEW = "MATERIALIZED_VIEW";
690  public const string MATERIALIZED_VIEW_MEMBER = "MATERIALIZED_VIEW_MEMBER";
691  public const string MATERIALIZED_VIEW_UNDER_CONSTRUCTION = "MATERIALIZED_VIEW_UNDER_CONSTRUCTION";
692  public const string REPLICATED = "REPLICATED";
693  public const string RESULT_TABLE = "RESULT_TABLE";
694  public const string SCHEMA = "SCHEMA";
695  public const string VIEW = "VIEW";
696  } // end struct TableDescriptions
697 
702  public struct AdditionalInfo
703  {
723  public const string REQUEST_AVRO_TYPE = "request_avro_type";
724 
725  public const string CREATE_TABLE = "create_table";
726  public const string CREATE_PROJECTION = "create_projection";
727  public const string CREATE_UNION = "create_union";
728 
732  public const string REQUEST_AVRO_JSON = "request_avro_json";
733 
744  public const string PROTECTED = "protected";
745 
746  public const string TRUE = "true";
747  public const string FALSE = "false";
748 
751  public const string RECORD_BYTES = "record_bytes";
752 
755  public const string TOTAL_BYTES = "total_bytes";
756 
761  public const string COLLECTION_NAMES = "collection_names";
762 
766  public const string SCHEMA_NAME = "schema_name";
767 
771  public const string TABLE_TTL = "table_ttl";
772 
777  public const string REMAINING_TABLE_TTL = "remaining_table_ttl";
778 
793  public const string PRIMARY_KEY_TYPE = "primary_key_type";
794 
796  public const string MEMORY = "memory";
797 
799  public const string DISK = "disk";
800 
807  public const string FOREIGN_KEYS = "foreign_keys";
808 
814  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
815 
860  public const string PARTITION_TYPE = "partition_type";
861 
865  public const string RANGE = "RANGE";
866 
870  public const string INTERVAL = "INTERVAL";
871 
875  public const string LIST = "LIST";
876 
880  public const string HASH = "HASH";
881 
885  public const string SERIES = "SERIES";
886 
888  public const string NONE = "NONE";
889 
892  public const string PARTITION_KEYS = "partition_keys";
893 
900  public const string PARTITION_DEFINITIONS = "partition_definitions";
901 
905  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
906 
916  public const string ATTRIBUTE_INDEXES = "attribute_indexes";
917 
924  public const string COLUMN_INFO = "column_info";
925 
955  public const string GLOBAL_ACCESS_MODE = "global_access_mode";
956 
959  public const string NO_ACCESS = "no_access";
960 
962  public const string READ_ONLY = "read_only";
963 
965  public const string WRITE_ONLY = "write_only";
966 
969  public const string READ_WRITE = "read_write";
970 
975  public const string VIEW_TABLE_NAME = "view_table_name";
976 
981  public const string IS_VIEW_PERSISTED = "is_view_persisted";
982 
987  public const string IS_DIRTY = "is_dirty";
988 
992  public const string REFRESH_METHOD = "refresh_method";
993 
997  public const string REFRESH_START_TIME = "refresh_start_time";
998 
1001  public const string REFRESH_STOP_TIME = "refresh_stop_time";
1002 
1006  public const string REFRESH_PERIOD = "refresh_period";
1007 
1011  public const string LAST_REFRESH_TIME = "last_refresh_time";
1012 
1017  public const string NEXT_REFRESH_TIME = "next_refresh_time";
1018 
1022  public const string USER_CHUNK_SIZE = "user_chunk_size";
1023 
1027  public const string USER_CHUNK_COLUMN_MAX_MEMORY = "user_chunk_column_max_memory";
1028 
1032  public const string USER_CHUNK_MAX_MEMORY = "user_chunk_max_memory";
1033 
1036  public const string OWNER_RESOURCE_GROUP = "owner_resource_group";
1037 
1041  public const string ALTERNATE_SHARD_KEYS = "alternate_shard_keys";
1042 
1046  public const string DATASOURCE_SUBSCRIPTIONS = "datasource_subscriptions";
1047 
1051  public const string NULL_MODIFYING_COLUMNS = "null_modifying_columns";
1052 
1056  public const string COMPRESSION_CODEC = "compression_codec";
1057 
1060  public const string CREATED_BY = "created_by";
1061 
1064  public const string CREATED_TIME = "created_time";
1065 
1068  public const string LAST_READ_BY = "last_read_by";
1069 
1073  public const string LAST_READ_TIME = "last_read_time";
1074 
1077  public const string READ_COUNT = "read_count";
1078 
1081  public const string LAST_WRITE_BY = "last_write_by";
1082 
1085  public const string LAST_WRITE_TIME = "last_write_time";
1086 
1089  public const string WRITE_COUNT = "write_count";
1090 
1093  public const string LAST_ALTER_BY = "last_alter_by";
1094 
1098  public const string LAST_ALTER_TIME = "last_alter_time";
1099 
1102  public const string ALTER_COUNT = "alter_count";
1103  } // end struct AdditionalInfo
1104 
1107  public string table_name { get; set; }
1108 
1124  public IList<string> table_names { get; set; } = new List<string>();
1125 
1181  public IList<IList<string>> table_descriptions { get; set; } = new List<IList<string>>();
1182 
1185  public IList<string> type_ids { get; set; } = new List<string>();
1186 
1189  public IList<string> type_schemas { get; set; } = new List<string>();
1190 
1193  public IList<string> type_labels { get; set; } = new List<string>();
1194 
1197  public IList<IDictionary<string, IList<string>>> properties { get; set; } = new List<IDictionary<string, IList<string>>>();
1198 
1669  public IList<IDictionary<string, string>> additional_info { get; set; } = new List<IDictionary<string, string>>();
1670 
1677  public IList<long> sizes { get; set; } = new List<long>();
1678 
1685  public IList<long> full_sizes { get; set; } = new List<long>();
1686 
1700  public IList<double> join_sizes { get; set; } = new List<double>();
1701 
1707  public long total_size { get; set; }
1708 
1715  public long total_full_size { get; set; }
1716 
1718  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1719 } // end class ShowTableResponse
const string CREATED_BY
User that created this table or view.
Definition: ShowTable.cs:1060
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:1685
const string ALTERNATE_SHARD_KEYS
Semicolon-separated list of shard keys that were equated in joins (applicable for join tables).
Definition: ShowTable.cs:1041
const string PROTECTED
No longer used.
Definition: ShowTable.cs:744
IList< IList< string > > table_descriptions
List of descriptions for the respective tables in table_names.
Definition: ShowTable.cs:1181
const string REFERENCING_MATERIALIZED_VIEWS
Include materialized views using this table as a source in the output.
Definition: ShowTable.cs:140
const string READ_ONLY
Only read operations are allowed on this table.
Definition: ShowTable.cs:962
IDictionary< string, string > info
Additional information.
Definition: ShowTable.cs:1718
const string REQUEST_AVRO_JSON
The JSON representation of request creating this table.
Definition: ShowTable.cs:732
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:125
IList< string > type_ids
Type IDs of the respective tables in table_names.
Definition: ShowTable.cs:1185
const string WRITE_COUNT
Count of times this table was written.
Definition: ShowTable.cs:1089
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:1032
const string COLUMN_INFO
JSON-encoded string representing a map of column name to information including memory usage if the GE...
Definition: ShowTable.cs:924
const string MEMORY
In-memory primary key.
Definition: ShowTable.cs:796
A set of string constants for the parameter additional_info.
Definition: ShowTable.cs:702
ShowTableRequest(string table_name, IDictionary< string, string > options=null)
Constructs a ShowTableRequest object with the specified parameters.
Definition: ShowTable.cs:665
const string PARTITION_KEYS
Comma-separated list of partition keys.
Definition: ShowTable.cs:892
const string LAST_ALTER_TIME
Time (UTC) when this table or view was last altered.
Definition: ShowTable.cs:1098
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:205
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
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:777
ShowTableRequest()
Constructs a ShowTableRequest object with default parameters.
Definition: ShowTable.cs:445
string table_name
Name of the table for which to retrieve the information, in [schema_name.
Definition: ShowTable.cs:229
const string READ_COUNT
Count of times this table or view was read.
Definition: ShowTable.cs:1077
const string LAST_READ_BY
User that last read this table or view.
Definition: ShowTable.cs:1068
IList< long > sizes
If GET_SIZES is TRUE, an array containing the number of records of each corresponding table in table_...
Definition: ShowTable.cs:1677
const string REFRESH_STOP_TIME
Time at which the periodic view refresh stops.
Definition: ShowTable.cs:1001
const string NULL_MODIFYING_COLUMNS
Comma-separated list of null modifying column names.
Definition: ShowTable.cs:1051
const string LAST_REFRESH_TIME
For materialized view the datetime string indicating the last time the view was refreshed.
Definition: ShowTable.cs:1011
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:1124
const string ALTER_COUNT
Count of times this table or view was altered.
Definition: ShowTable.cs:1102
const string SKIP_ADDITIONAL_INFO
If TRUE then the response will not populate the additional_info field.
Definition: ShowTable.cs:155
const string FORCE_SYNCHRONOUS
If TRUE then the table sizes will wait for read lock before returning.
Definition: ShowTable.cs:78
const string IS_VIEW_PERSISTED
True if the view named view_table_name is persisted - reported for each view member.
Definition: ShowTable.cs:981
const string SCHEMA_NAME
The name of the schema for the table.
Definition: ShowTable.cs:766
const string USER_CHUNK_SIZE
User-specified number of records per chunk, if provided at table creation time.
Definition: ShowTable.cs:1022
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:987
IList< IDictionary< string, IList< string > > > properties
Property maps of the respective tables in table_names.
Definition: ShowTable.cs:1197
const string LAST_WRITE_BY
User that last wrote to this table.
Definition: ShowTable.cs:1081
const string TOTAL_BYTES
The total size in bytes of all data stored in the table.
Definition: ShowTable.cs:755
IDictionary< string, string > options
Optional parameters.
Definition: ShowTable.cs:441
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:109
const string PRIMARY_KEY_TYPE
The primary key type of the table (if it has a primary key).
Definition: ShowTable.cs:793
const string FOREIGN_KEYS
Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primar...
Definition: ShowTable.cs:807
IList< string > type_schemas
Type schemas of the respective tables in table_names.
Definition: ShowTable.cs:1189
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:1027
A set of parameters for Kinetica.showTable.
Definition: ShowTable.cs:41
const string IS_AUTOMATIC_PARTITION
True if partitions will be created for LIST VALUES which don't fall into existing partitions.
Definition: ShowTable.cs:905
const string REFRESH_START_TIME
For materialized view with periodic refresh_method the initial datetime string that periodic refreshe...
Definition: ShowTable.cs:997
const string DATASOURCE_SUBSCRIPTIONS
Semicolon-separated list of datasource names the table has subscribed to.
Definition: ShowTable.cs:1046
const string GET_ACCESS_DATA
If TRUE then data about the last read, write, alter and create will be returned.
Definition: ShowTable.cs:93
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:751
const string LAST_READ_TIME
Time (UTC) when this table or view was last read.
Definition: ShowTable.cs:1073
const string READ_WRITE
All read/write operations are allowed on this table.
Definition: ShowTable.cs:969
const string REFRESH_PERIOD
For materialized view with periodic refresh_method the current refresh period in seconds.
Definition: ShowTable.cs:1006
A set of results returned by Kinetica.showTable.
Definition: ShowTable.cs:676
const string INTERVAL
Using interval partitioning.
Definition: ShowTable.cs:870
const string ATTRIBUTE_INDEXES
Semicolon-separated list of indexes.
Definition: ShowTable.cs:916
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:1715
const string RANGE
Using range partitioning.
Definition: ShowTable.cs:865
const string LIST
Using manual list partitioning.
Definition: ShowTable.cs:875
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:814
const string NO_ACCESS
No read/write operations are allowed on this table.
Definition: ShowTable.cs:959
const string REFRESH_METHOD
For materialized view current refresh_method - one of manual, periodic, on_change.
Definition: ShowTable.cs:992
const string TABLE_TTL
The value of the time-to-live setting.
Definition: ShowTable.cs:771
const string GLOBAL_ACCESS_MODE
Returns the global access mode (i.e.
Definition: ShowTable.cs:955
const string COLLECTION_NAMES
[DEPRECATED–use schema_name instead] This will now contain the name of the schema for the table.
Definition: ShowTable.cs:761
const string GET_COLUMN_INFO
If TRUE then column info (memory usage, etc) will be returned.
Definition: ShowTable.cs:220
const string REQUEST_AVRO_TYPE
Method by which this table was created.
Definition: ShowTable.cs:723
const string WRITE_ONLY
Only write operations are allowed on this table.
Definition: ShowTable.cs:965
const string DEPENDENCIES
Include view dependencies in the output.
Definition: ShowTable.cs:60
A set of string constants for the parameter table_descriptions.
Definition: ShowTable.cs:682
const string MATERIALIZED_VIEW_UNDER_CONSTRUCTION
Definition: ShowTable.cs:691
const string CREATED_TIME
Time (UTC) when this table or view was created.
Definition: ShowTable.cs:1064
const string HASH
Using hash partitioning.
Definition: ShowTable.cs:880
const string COMPRESSION_CODEC
Default compression codec for the table.
Definition: ShowTable.cs:1056
const string PARTITION_TYPE
Partitioning scheme used for this table.
Definition: ShowTable.cs:860
const string NONE
Using no partitioning.
Definition: ShowTable.cs:888
long total_size
If GET_SIZES is TRUE, the sum of the elements of sizes.
Definition: ShowTable.cs:1707
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:975
IList< IDictionary< string, string > > additional_info
Additional information about the respective tables in table_names.
Definition: ShowTable.cs:1669
const string DISK
On-disk primary key.
Definition: ShowTable.cs:799
string table_name
Value of table_name.
Definition: ShowTable.cs:1107
const string NO_ERROR_IF_NOT_EXISTS
If FALSE will return an error if the provided table_name does not exist.
Definition: ShowTable.cs:171
const string OWNER_RESOURCE_GROUP
Name of the owner resource group.
Definition: ShowTable.cs:1036
const string LAST_ALTER_BY
User that last altered this table or view.
Definition: ShowTable.cs:1093
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the partition_type.
Definition: ShowTable.cs:900
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:187
const string NEXT_REFRESH_TIME
For materialized view with periodic refresh_method a datetime string indicating the next time the vie...
Definition: ShowTable.cs:1017
const string LAST_WRITE_TIME
Time (UTC) when this table was last written.
Definition: ShowTable.cs:1085
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:1700
const string SERIES
Using series partitioning.
Definition: ShowTable.cs:885
A set of string constants for the parameter options.
Definition: ShowTable.cs:46
IList< string > type_labels
Type labels of the respective tables in table_names.
Definition: ShowTable.cs:1193
const string FALSE
Definition: ShowTable.cs:63