Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.ShowSchemaRequest Class Reference

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

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

Classes

struct  Options
 Optional parameters. 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...
 
- 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 schema_name [get, set]
 Name of the schema for which to retrieve the information. 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.showSchema(string,IDictionary{string, string}).


Retrieves information about a schema (or all schemas), as specified in schema_name.

Definition at line 20 of file ShowSchema.cs.

Constructor & Destructor Documentation

kinetica.ShowSchemaRequest.ShowSchemaRequest ( )
inline

Constructs a ShowSchemaRequest object with default parameters.

Definition at line 112 of file ShowSchema.cs.

kinetica.ShowSchemaRequest.ShowSchemaRequest ( string  schema_name,
IDictionary< string, string >  options = null 
)
inline

Constructs a ShowSchemaRequest object with the specified parameters.

Parameters
schema_nameName of the schema for which to retrieve the information. If blank, then info for all schemas is returned.
optionsOptional parameters.
  • NO_ERROR_IF_NOT_EXISTS: If false will return an error if the provided does not exist. If true then it will return an empty result if the provided does not exist. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 147 of file ShowSchema.cs.

Property Documentation

IDictionary<string, string> kinetica.ShowSchemaRequest.options
getset

Optional parameters.

  • NO_ERROR_IF_NOT_EXISTS: If false will return an error if the provided does not exist. If true then it will return an empty result if the provided does not exist. Supported values: The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 107 of file ShowSchema.cs.

string kinetica.ShowSchemaRequest.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 79 of file ShowSchema.cs.


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