Version:

/show/sql/proc

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/show/sql/proc

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

Input Parameter Description

Name Type Description
procedure_name string Name of the procedure for which to retrieve the information. If blank, then information about all procedures is returned. The default value is ''.
options map of string to strings

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

Supported Parameters (keys) Parameter Description
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. The supported values are:

  • true
  • false

Output Parameter Description

The GPUdb 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:

Name Type Description
status String 'OK' or 'ERROR'
message String Empty if success or an error message
data_type String 'show_sql_proc_request' or 'none' in case of an error
data String Empty string
data_str JSON or String

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

Name Type Description
procedure_names array of strings A list of the names of the requested procedures.
procedure_definitions array of strings A list of the definitions for the requested procedures.
additional_info array of maps of string to strings

Additional information about the respective tables in the requested procedures.

Possible List Entries Description
map of string to strings

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

Possible Parameters (keys) Parameter Description
execute_start_time The initial date/time that periodic execution began. The default value is ''.
execute_interval The periodic execution interval in seconds. The default value is ''.
info map of string to strings Additional information.

Empty string in case of an error.