Kinetica   C#   API  Version 7.2.3.0
kinetica.ShowSqlProcRequest Class Reference

A set of parameters for Kinetica.showSqlProc. More...

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

Classes

struct  Options
 A set of string constants for the parameter options. More...
 

Public Member Functions

 ShowSqlProcRequest ()
 Constructs a ShowSqlProcRequest object with default parameters. More...
 
 ShowSqlProcRequest (string procedure_name=null, IDictionary< string, string > options=null)
 Constructs a ShowSqlProcRequest 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 procedure_name = "" [get, set]
 Name of the procedure 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...
 

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.showSqlProc.

Shows information about SQL procedures, including the full definition of each requested procedure.

Definition at line 16 of file ShowSqlProc.cs.

Constructor & Destructor Documentation

◆ ShowSqlProcRequest() [1/2]

kinetica.ShowSqlProcRequest.ShowSqlProcRequest ( )
inline

Constructs a ShowSqlProcRequest object with default parameters.

Definition at line 77 of file ShowSqlProc.cs.

◆ ShowSqlProcRequest() [2/2]

kinetica.ShowSqlProcRequest.ShowSqlProcRequest ( string  procedure_name = null,
IDictionary< string, string >  options = null 
)
inline

Constructs a ShowSqlProcRequest object with the specified parameters.

Parameters
procedure_nameName of the procedure for which to retrieve the information. If blank, then information about all procedures is returned. The default value is ''.
optionsOptional parameters.
  • NO_ERROR_IF_NOT_EXISTS: If TRUE, no error will be returned if the requested procedure does not exist. If FALSE, an error will be returned if the requested procedure does not exist. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 109 of file ShowSqlProc.cs.

Property Documentation

◆ options

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

Optional parameters.

  • NO_ERROR_IF_NOT_EXISTS: If TRUE, no error will be returned if the requested procedure does not exist. If FALSE, an error will be returned if the requested procedure does not exist. Supported values: The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 73 of file ShowSqlProc.cs.

◆ procedure_name

string kinetica.ShowSqlProcRequest.procedure_name = ""
getset

Name of the procedure for which to retrieve the information.

If blank, then information about all procedures is returned. The default value is ''.

Definition at line 47 of file ShowSqlProc.cs.


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