A set of parameters for Kinetica.showTypes. More...
Inheritance diagram for kinetica.ShowTypesRequest:
Collaboration diagram for kinetica.ShowTypesRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. 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 Kinetica.createType. More... | |
| string | label [get, set] |
| Option string that was supplied by user in a call to Kinetica.createType. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [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.
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 18 of file ShowTypes.cs.
Constructor & Destructor Documentation
◆ ShowTypesRequest() [1/2]
|
inline |
Constructs a ShowTypesRequest object with default parameters.
Definition at line 79 of file ShowTypes.cs.
◆ ShowTypesRequest() [2/2]
|
inline |
Constructs a ShowTypesRequest object with the specified parameters.
- Parameters
-
type_id Type Id returned in response to a call to Kinetica.createType. label Option string that was supplied by user in a call to Kinetica.createType. options Optional parameters. - NO_JOIN_TYPES: When set to 'true', no join types will be included. Supported values: The default value is FALSE.
Definition at line 113 of file ShowTypes.cs.
Property Documentation
◆ label
|
getset |
Option string that was supplied by user in a call to Kinetica.createType.
Definition at line 52 of file ShowTypes.cs.
◆ options
|
getset |
Optional parameters.
- NO_JOIN_TYPES: When set to 'true', no join types will be included. Supported values: The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 75 of file ShowTypes.cs.
◆ type_id
|
getset |
Type Id returned in response to a call to Kinetica.createType.
Definition at line 47 of file ShowTypes.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/ShowTypes.cs
