/show/sql/proc - Kinetica Docs

URL: http://<db.host>:<db.port>/show/sql/proc

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

Input Parameter Description

string

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

map of string to strings

Optional parameters.The default value is an empty map ( {} ).

Show options

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.The default value is false.The supported values are:

true
false

Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

String

‘OK’ or ‘ERROR’

String

Empty if success or an error message

String

‘show_sql_proc_response’ or ‘none’ in case of an error

String

Empty string

JSON or String

This embedded JSON represents the result of the /show/sql/proc endpoint:

Show data_str

array of strings

A list of the names of the requested procedures.

array of strings

A list of the definitions for the requested procedures.

array of maps of string to strings

Additional information about the respective tables in the requested procedures.

Show additional_info

The periodic execution impersonate user.The default value is ”.

The periodic execution interval in seconds.The default value is ”.

The initial date/time that periodic execution began.The default value is ”.

Time at which the periodic execution stops.The default value is ”.

map of string to strings

Additional information.

Empty string in case of an error.

​Input Parameter Description

​Output Parameter Description

Input Parameter Description

Output Parameter Description