kinetica.ShowSchemaRequest Class Reference
A set of parameters for Kinetica.showSchema. More...
Inheritance diagram for kinetica.ShowSchemaRequest:
Collaboration diagram for kinetica.ShowSchemaRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| ShowSchemaRequest () | |
| Constructs a ShowSchemaRequest object with default parameters. More... | |
| ShowSchemaRequest (string schema_name, IDictionary< string, string > options=null) | |
| Constructs a ShowSchemaRequest object with the specified parameters. More... | |
| ShowSchemaRequest () | |
| Constructs a ShowSchemaRequest object with default parameters. More... | |
| ShowSchemaRequest (string schema_name, IDictionary< string, string > options=null) | |
| Constructs a ShowSchemaRequest 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... | |
| 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 | schema_name [get, set] |
| Name of the schema for which to retrieve the information. 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... | |
| Properties inherited from Avro.Specific.ISpecificRecord | |
| Schema | Schema [get] |
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... | |
| 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.showSchema.
Retrieves information about a schema (or all schemas), as specified in schema_name.
Definition at line 17 of file ShowSchema.cs.
Constructor & Destructor Documentation
◆ ShowSchemaRequest() [1/4]
|
inline |
Constructs a ShowSchemaRequest object with default parameters.
Definition at line 79 of file ShowSchema.cs.
◆ ShowSchemaRequest() [2/4]
|
inline |
Constructs a ShowSchemaRequest object with the specified parameters.
- Parameters
-
schema_name Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned. options Optional parameters. The default value is an empty Dictionary.
Definition at line 113 of file ShowSchema.cs.
◆ ShowSchemaRequest() [3/4]
|
inline |
Constructs a ShowSchemaRequest object with default parameters.
Definition at line 79 of file ShowSchema.cs.
◆ ShowSchemaRequest() [4/4]
|
inline |
Constructs a ShowSchemaRequest object with the specified parameters.
- Parameters
-
schema_name Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned. options Optional parameters. The default value is an empty Dictionary.
Definition at line 113 of file ShowSchema.cs.
Property Documentation
◆ options
|
getset |
Optional parameters.
- NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided schema_name does not exist. If TRUE then it will return an empty result if the provided schema_name does not exist. Supported values: The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 75 of file ShowSchema.cs.
◆ schema_name
|
getset |
Name of the schema for which to retrieve the information.
If blank, then info for all schemas is returned.
Definition at line 48 of file ShowSchema.cs.
The documentation for this class was generated from the following file:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ShowSchema.cs
