Package com.gpudb.protocol

Class ShowSqlProcRequest

java.lang.Object

com.gpudb.protocol.ShowSqlProcRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class ShowSqlProcRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.showSqlProc.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShowSqlProcRequest.Options	A set of string constants for the ShowSqlProcRequest parameter options.

Constructor Summary

Constructors

Constructor	Description
ShowSqlProcRequest()	Constructs a ShowSqlProcRequest object with default parameters.
ShowSqlProcRequest(String procedureName, Map<String,String> options)	Constructs a ShowSqlProcRequest object with the specified parameters.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Object	get(int index)	This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
Map<String,String>	getOptions()	Optional parameters.
String	getProcedureName()	Name of the procedure for which to retrieve the information.
org.apache.avro.Schema	getSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
int	hashCode()
void	put(int index, Object value)	This method supports the Avro framework and is not intended to be called directly by the user.
ShowSqlProcRequest	setOptions(Map<String,String> options)	Optional parameters.
ShowSqlProcRequest	setProcedureName(String procedureName)	Name of the procedure for which to retrieve the information.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShowSqlProcRequest

public ShowSqlProcRequest()

Constructs a ShowSqlProcRequest object with default parameters.

ShowSqlProcRequest

public ShowSqlProcRequest(String procedureName,
                          Map<String,String> options)

Constructs a ShowSqlProcRequest object with the specified parameters.

Parameters:

procedureName - Name of the procedure for which to retrieve the information. If blank, then information about all procedures is returned. The default value is ''.

options - 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:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

The schema for the class.

getProcedureName

public String getProcedureName()

Name of the procedure for which to retrieve the information. If blank, then information about all procedures is returned. The default value is ''.

Returns:

The current value of procedureName.

setProcedureName

public ShowSqlProcRequest setProcedureName(String procedureName)

Name of the procedure for which to retrieve the information. If blank, then information about all procedures is returned. The default value is ''.

Parameters:

procedureName - The new value for procedureName.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

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:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

public ShowSqlProcRequest setOptions(Map<String,String> options)

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:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Parameters:

options - The new value for options.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

The schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object