Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.ShowTableResponse Class Reference

A set of results returned by /show/table. More...

+ Inheritance diagram for kinetica.ShowTableResponse:
+ Collaboration diagram for kinetica.ShowTableResponse:

Classes

struct  AdditionalInfo
 Additional information about the respective tables in <member name="table_names">. More...
 
struct  TableDescriptions
 List of descriptions for the respective tables in <member name="table_names">. More...
 

Properties

string table_name [get, set]
 Value of . More...
 
IList< string > table_names [get, set]
 If is a table or view, then the single element of the array is . More...
 
IList< IList< string > > table_descriptions = new List<string>() [get, set]
 List of descriptions for the respective tables in <member name="table_names">. More...
 
IList< string > type_ids = new List<IList<string>>() [get, set]
 Type ids of the respective tables in <member name="table_names">. More...
 
IList< string > type_schemas = new List<string>() [get, set]
 Type schemas of the respective tables in <member name="table_names">. More...
 
IList< string > type_labels = new List<string>() [get, set]
 Type labels of the respective tables in <member name="table_names">. More...
 
IList< IDictionary< string,
IList< string > > > 
properties = new List<string>() [get, set]
 Property maps of the respective tables in <member name="table_names">. More...
 
IList< IDictionary< string,
string > > 
additional_info = new List<IDictionary<string, IList<string>>>() [get, set]
 Additional information about the respective tables in <member name="table_names">. More...
 
IList< long > sizes = new List<IDictionary<string, string>>() [get, set]
 Empty array if the get_sizes option is false. More...
 
IList< long > full_sizes = new List<long>() [get, set]
 Empty array if the get_sizes option is false. More...
 
IList< double > join_sizes = new List<long>() [get, set]
 Empty array if the get_sizes option is false. More...
 
long total_size = new List<double>() [get, set]
 -1 if the get_sizes option is false. More...
 
long total_full_size [get, set]
 -1 if the get_sizes option is false. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

Additional Inherited Members

- Public Member Functions inherited from kinetica.KineticaData
 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...
 
- Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema SchemaFromType (System.Type t, KineticaType ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType. More...
 

Detailed Description

A set of results returned by /show/table.

Definition at line 189 of file ShowTable.cs.

Property Documentation

IList<IDictionary<string, string> > kinetica.ShowTableResponse.additional_info = new List<IDictionary<string, IList<string>>>()
getset

Additional information about the respective tables in <member name="table_names">.

Values: .

Definition at line 302 of file ShowTable.cs.

IList<long> kinetica.ShowTableResponse.full_sizes = new List<long>()
getset

Empty array if the get_sizes option is false.

Otherwise, number of total objects in the respective tables represented in <member name="table_names">. For all but track data types, this is the same as <member name="sizes">. For track types, since each track semantically contains many individual objects, <member name="full_sizes"> is the count of total objects.

Definition at line 321 of file ShowTable.cs.

IList<double> kinetica.ShowTableResponse.join_sizes = new List<long>()
getset

Empty array if the get_sizes option is false.

Otherwise, number of unfiltered objects in the cross product of the sub-tables in the joined-tables represented in <member name="table_names">. For simple tables, this number will be the same as <member name="sizes">. For join-tables this value gives the number of joined-table rows that must be processed by any aggregate functions operating on the table.

Definition at line 330 of file ShowTable.cs.

IList<IDictionary<string, IList<string> > > kinetica.ShowTableResponse.properties = new List<string>()
getset

Property maps of the respective tables in <member name="table_names">.

Definition at line 297 of file ShowTable.cs.

IList<long> kinetica.ShowTableResponse.sizes = new List<IDictionary<string, string>>()
getset

Empty array if the get_sizes option is false.

Otherwise, sizes of the respective tables represented in <member name="table_names">. For all but track data types, this is simply the number of total objects in a table. For track types, since each track semantically contains many individual objects, the <member name="sizes"> are the counts of conceptual tracks (each of which may be associated with multiple objects).

Definition at line 312 of file ShowTable.cs.

IList<IList<string> > kinetica.ShowTableResponse.table_descriptions = new List<string>()
getset

List of descriptions for the respective tables in <member name="table_names">.

Values: COLLECTION, VIEW, REPLICATED, JOIN, RESULT_TABLE.

Definition at line 281 of file ShowTable.cs.

string kinetica.ShowTableResponse.table_name
getset

Value of .

Definition at line 262 of file ShowTable.cs.

IList<string> kinetica.ShowTableResponse.table_names
getset

If is a table or view, then the single element of the array is .

If is a collection and show_children is set to true, then this array is populated with the names of all tables and views contained by the given collection; if show_children is false then this array will only include the collection name itself. If is an empty string, then the array contains the names of all collections and top-level tables.

Definition at line 275 of file ShowTable.cs.

long kinetica.ShowTableResponse.total_full_size
getset

-1 if the get_sizes option is false.

The sum of the elements of <member name="full_sizes">.

Definition at line 339 of file ShowTable.cs.

long kinetica.ShowTableResponse.total_size = new List<double>()
getset

-1 if the get_sizes option is false.

Otherwise, the sum of the elements of <member name="sizes">.

Definition at line 335 of file ShowTable.cs.

IList<string> kinetica.ShowTableResponse.type_ids = new List<IList<string>>()
getset

Type ids of the respective tables in <member name="table_names">.

Definition at line 285 of file ShowTable.cs.

IList<string> kinetica.ShowTableResponse.type_labels = new List<string>()
getset

Type labels of the respective tables in <member name="table_names">.

Definition at line 293 of file ShowTable.cs.

IList<string> kinetica.ShowTableResponse.type_schemas = new List<string>()
getset

Type schemas of the respective tables in <member name="table_names">.

Definition at line 289 of file ShowTable.cs.


The documentation for this class was generated from the following file: