kinetica.ShowTypesRequest Class Reference

A set of parameters for Kinetica.showTypes(string,string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.ShowTypesRequest:

Collaboration diagram for kinetica.ShowTypesRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	ShowTypesRequest ()
	Constructs a ShowTypesRequest object with default parameters. More...
	ShowTypesRequest (string type_id, string label, IDictionary< string, string > options=null)
	Constructs a ShowTypesRequest object with the specified parameters. More...
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...

Properties
string	type_id [get, set]
	Type Id returned in response to a call to /create/type. More...
string	label [get, set]
	Option string that was supplied by user in a call to /create/type. More...
IDictionary< string, string >	options [get, set]
	Optional parameters. More...
Properties inherited from kinetica.KineticaData
Schema	Schema [get]
	Avro Schema for this class More...

Additional Inherited Members
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 parameters for Kinetica.showTypes(string,string,IDictionary{string, string}).

Retrieves information for the specified data type ID or type label. For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.

Definition at line 22 of file ShowTypes.cs.

Constructor & Destructor Documentation

kinetica.ShowTypesRequest.ShowTypesRequest ( )

inline

Constructs a ShowTypesRequest object with default parameters.

Definition at line 109 of file ShowTypes.cs.

kinetica.ShowTypesRequest.ShowTypesRequest ( string  type_id, string  label, IDictionary< string, string >  options = null  )

inline

Constructs a ShowTypesRequest object with the specified parameters.

Parameters

type_id	Type Id returned in response to a call to /create/type.
label	Option string that was supplied by user in a call to /create/type.
options	Optional parameters. NO_JOIN_TYPES: When set to 'true', no join types will be included. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 142 of file ShowTypes.cs.

Property Documentation

string kinetica.ShowTypesRequest.label

getset

Option string that was supplied by user in a call to /create/type.

Definition at line 79 of file ShowTypes.cs.

IDictionary<string, string> kinetica.ShowTypesRequest.options

getset

Optional parameters.

• NO_JOIN_TYPES: When set to 'true', no join types will be included. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 104 of file ShowTypes.cs.

string kinetica.ShowTypesRequest.type_id

getset

Type Id returned in response to a call to /create/type.

Definition at line 75 of file ShowTypes.cs.

---

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

• Kinetica/Protocol/ShowTypes.cs