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

A set of results returned by Kinetica.showTable(string,IDictionary{string, string}). 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]
 If get_sizes is true, an array containing the number of records of each corresponding table in <member name="table_names">. More...
 
IList< long > full_sizes = new List<long>() [get, set]
 If get_sizes is true, an array containing the number of records of each corresponding table in <member name="table_names"> (same values as <member name="sizes">). More...
 
IList< double > join_sizes = new List<long>() [get, set]
 If get_sizes is true, an array containing the number of unfiltered records in the cross product of the sub-tables of each corresponding join-table in <member name="table_names">. More...
 
long total_size = new List<double>() [get, set]
 If get_sizes is true, the sum of the elements of <member name="sizes">. More...
 
long total_full_size [get, set]
 If get_sizes is true, the sum of the elements of <member name="full_sizes"> (same value as <member name="total_size">). More...
 
IDictionary< string, string > info [get, set]
 Additional information. 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 Kinetica.showTable(string,IDictionary{string, string}).

Definition at line 591 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">.

Supported values:

Definition at line 1079 of file ShowTable.cs.

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

If get_sizes is true, an array containing the number of records of each corresponding table in <member name="table_names"> (same values as <member name="sizes">).

Otherwise, an empty array.

Definition at line 1090 of file ShowTable.cs.

IDictionary<string, string> kinetica.ShowTableResponse.info
getset

Additional information.

Definition at line 1112 of file ShowTable.cs.

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

If get_sizes is true, an array containing the number of unfiltered records in the cross product of the sub-tables of each corresponding join-table 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. Otherwise, (if get_sizes is false), an empty array.

Definition at line 1100 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 1072 of file ShowTable.cs.

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

If get_sizes is true, an array containing the number of records of each corresponding table in <member name="table_names">.

Otherwise, an empty array.

Definition at line 1084 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">.

Supported values:

Definition at line 1056 of file ShowTable.cs.

string kinetica.ShowTableResponse.table_name
getset

Value of .

Definition at line 987 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 schema and show_children is set to true, then this array is populated with the names of all tables and views in the given schema; if show_children is false, then this array will only include the schema name itself. If is an empty string, then the array contains the names of all tables in the user's default schema.

Definition at line 1001 of file ShowTable.cs.

long kinetica.ShowTableResponse.total_full_size
getset

If get_sizes is true, the sum of the elements of <member name="full_sizes"> (same value as <member name="total_size">).

Otherwise, -1.

Definition at line 1109 of file ShowTable.cs.

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

If get_sizes is true, the sum of the elements of <member name="sizes">.

Otherwise, -1.

Definition at line 1104 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 1060 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 1068 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 1064 of file ShowTable.cs.


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