Skip to main content

A set of parameters for Kinetica.showTablesByType. More…

Inheritance diagram for kinetica.ShowTablesByTypeRequest:
Collaboration diagram for kinetica.ShowTablesByTypeRequest:

Public Member Functions

 ShowTablesByTypeRequest ()
 Constructs a ShowTablesByTypeRequest object with default parameters.
 
 ShowTablesByTypeRequest (string type_id, string label, IDictionary< string, string > options=null)
 Constructs a ShowTablesByTypeRequest object with the specified parameters.
 
 ShowTablesByTypeRequest ()
 Constructs a ShowTablesByTypeRequest object with default parameters.
 
 ShowTablesByTypeRequest (string type_id, string label, IDictionary< string, string > options=null)
 Constructs a ShowTablesByTypeRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 

Properties

string type_id [get, set]
 Type id returned by a call to Kinetica.createType.
 
string label [get, set]
 Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

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.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.showTablesByType.

Gets names of the tables whose type matches the given criteria. Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Definition at line 19 of file ShowTablesByType.cs.

Constructor & Destructor Documentation

◆ ShowTablesByTypeRequest() [1/4]

kinetica.ShowTablesByTypeRequest.ShowTablesByTypeRequest ()
inline

Constructs a ShowTablesByTypeRequest object with default parameters.

Definition at line 37 of file ShowTablesByType.cs.

◆ ShowTablesByTypeRequest() [2/4]

kinetica.ShowTablesByTypeRequest.ShowTablesByTypeRequest (stringtype_id,
stringlabel,
IDictionary< string, string >options = null )
inline

Constructs a ShowTablesByTypeRequest object with the specified parameters.

Parameters
type_idType id returned by a call to Kinetica.createType.
labelOptional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 50 of file ShowTablesByType.cs.

◆ ShowTablesByTypeRequest() [3/4]

kinetica.ShowTablesByTypeRequest.ShowTablesByTypeRequest ()
inline

Constructs a ShowTablesByTypeRequest object with default parameters.

Definition at line 37 of file ShowTablesByType.cs.

◆ ShowTablesByTypeRequest() [4/4]

kinetica.ShowTablesByTypeRequest.ShowTablesByTypeRequest (stringtype_id,
stringlabel,
IDictionary< string, string >options = null )
inline

Constructs a ShowTablesByTypeRequest object with the specified parameters.

Parameters
type_idType id returned by a call to Kinetica.createType.
labelOptional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 50 of file ShowTablesByType.cs.

Property Documentation

◆ label

string kinetica.ShowTablesByTypeRequest.label
getset

Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.

Definition at line 28 of file ShowTablesByType.cs.

◆ options

IDictionary< string, string > kinetica.ShowTablesByTypeRequest.options = new Dictionary<string, string>()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 33 of file ShowTablesByType.cs.

◆ type_id

string kinetica.ShowTablesByTypeRequest.type_id
getset

Type id returned by a call to Kinetica.createType.

Definition at line 24 of file ShowTablesByType.cs.


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