Kinetica C# API
Version 7.1.10.0
|
A set of parameters for Kinetica.showTable(string,IDictionary{string, string}). More...
Classes | |
struct | Options |
Optional parameters. More... | |
Public Member Functions | |
ShowTableRequest () | |
Constructs a ShowTableRequest object with default parameters. More... | |
ShowTableRequest (string table_name, IDictionary< string, string > options=null) | |
Constructs a ShowTableRequest object with the specified parameters. More... | |
![]() | |
KineticaData (KineticaType type) | |
Constructor from Kinetica Type More... | |
KineticaData (System.Type type=null) | |
Default constructor, with optional System.Type More... | |
object | Get (int fieldPos) |
Retrieve a specific property from this object More... | |
void | Put (int fieldPos, object fieldValue) |
Write a specific property to this object More... | |
Properties | |
string | table_name [get, set] |
Name of the table for which to retrieve the information, in [schema_name. More... | |
IDictionary< string, string > | options [get, set] |
Optional parameters. More... | |
![]() | |
Schema | Schema [get] |
Avro Schema for this class More... | |
Additional Inherited Members | |
![]() | |
static RecordSchema | SchemaFromType (System.Type t, KineticaType ktype=null) |
Create an Avro Schema from a System.Type and a KineticaType. More... | |
A set of parameters for Kinetica.showTable(string,IDictionary{string, string}).
Retrieves detailed information about a table, view, or schema, specified in table_name. If the supplied table_name is a schema the call can return information about either the schema itself or the tables and views it contains. If table_name is empty, information about all schemas will be returned.
If the option get_sizes is set to true, then the number of records in each table is returned (in <member name="sizes"> and <member name="full_sizes">), along with the total number of objects across all requested tables (in <member name="total_size"> and <member name="total_full_size">).
For a schema, setting the show_children option to false returns only information about the schema itself; setting show_children to true returns a list of tables and views contained in the schema, along with their corresponding detail.
To retrieve a list of every table, view, and schema in the database, set table_name to '*' and show_children to true. When doing this, the returned <member name="total_size"> and <member name="total_full_size"> will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).
Definition at line 47 of file ShowTable.cs.
|
inline |
Constructs a ShowTableRequest object with default parameters.
Definition at line 438 of file ShowTable.cs.
|
inline |
Constructs a ShowTableRequest object with the specified parameters.
table_name | Name of the table for which to retrieve the information, in [schema_name.]table_name format, using standard name resolution rules. If blank, then returns information about all tables and views. |
options | Optional parameters.
|
Definition at line 577 of file ShowTable.cs.
|
getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 433 of file ShowTable.cs.
|
getset |
Name of the table for which to retrieve the information, in [schema_name.
]table_name format, using standard name resolution rules. If blank, then returns information about all tables and views.
Definition at line 303 of file ShowTable.cs.