Kinetica   C#   API  Version 7.2.3.0
kinetica.RawExecuteSqlResponse Class Reference

A set of results returned by Kinetica.executeSql. More...

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

Classes

struct  HasMoreRecords
 A set of string constants for the parameter has_more_records. More...
 
struct  Info
 A set of string constants for the parameter info. More...
 

Properties

long count_affected [get, set]
 The number of objects/records affected. More...
 
string response_schema_str [get, set]
 Avro schema of binary_encoded_response or json_encoded_response. More...
 
byte [] binary_encoded_response [get, set]
 Avro binary encoded response. More...
 
string json_encoded_response [get, set]
 Avro JSON encoded response. More...
 
long total_number_of_records [get, set]
 Total/Filtered number of records. More...
 
bool has_more_records [get, set]
 Too many records. More...
 
string paging_table [get, set]
 Name of the table that has the result records of the query. More...
 
IDictionary< string, string > info = new Dictionary<string, string>() [get, set]
 Additional information. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 
- Properties inherited from Avro.Specific.ISpecificRecord
Schema Schema [get]
 

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...
 
 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...
 
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.executeSql.

Definition at line 1518 of file ExecuteSql.cs.

Property Documentation

◆ binary_encoded_response

byte [] kinetica.RawExecuteSqlResponse.binary_encoded_response
getset

Avro binary encoded response.

Definition at line 1547 of file ExecuteSql.cs.

◆ count_affected

long kinetica.RawExecuteSqlResponse.count_affected
getset

The number of objects/records affected.

Definition at line 1540 of file ExecuteSql.cs.

◆ has_more_records

bool kinetica.RawExecuteSqlResponse.has_more_records
getset

Too many records.

Supported values:

  • true
  • false

Definition at line 1565 of file ExecuteSql.cs.

◆ info

IDictionary< string, string > kinetica.RawExecuteSqlResponse.info = new Dictionary<string, string>()
getset

Additional information.

  • COUNT: Number of records in the final table

The default value is an empty Dictionary.

  • COUNT: Number of records without final limits applied
  • RESULT_TABLE_LIST: List of tables, comma-separated, in addition to the paging_table, created as result of the query. These should be cleared by the caller when they are done querying.

The default value is an empty Dictionary.

Definition at line 1582 of file ExecuteSql.cs.

◆ json_encoded_response

string kinetica.RawExecuteSqlResponse.json_encoded_response
getset

Avro JSON encoded response.

Definition at line 1550 of file ExecuteSql.cs.

◆ paging_table

string kinetica.RawExecuteSqlResponse.paging_table
getset

Name of the table that has the result records of the query.

Valid, when has_more_records is TRUE

Valid, when has_more_records is TRUE. The caller should clear this and all tables in RESULT_TABLE_LIST when they are done querying.

Definition at line 1571 of file ExecuteSql.cs.

◆ response_schema_str

string kinetica.RawExecuteSqlResponse.response_schema_str
getset

Avro schema of binary_encoded_response or json_encoded_response.

Definition at line 1544 of file ExecuteSql.cs.

◆ total_number_of_records

long kinetica.RawExecuteSqlResponse.total_number_of_records
getset

Total/Filtered number of records.

Definition at line 1553 of file ExecuteSql.cs.


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