Version:

/show/procΒΆ

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

Shows information about a proc.

Input Parameter Description

Name Type Description
proc_name string Name of the proc to show information about. If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned. Default value is ''.
options map of strings

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

Supported Parameters (keys) Parameter Description
include_files

If set to true, the files that make up the proc will be returned. If set to false, the files will not be returned. Default value is 'false'. The allowed 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_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/proc endpoint:

Name Type Description
proc_names array of strings The proc names.
execution_modes array of strings

The execution modes of the procs named in output parameter proc_names.

Supported List Entries Description
string
Supported Values Description
distributed Distributed
nondistributed Nondistributed
files array of maps of bytes Maps of the files that make up the procs named in output parameter proc_names.
commands array of strings The commands (excluding arguments) that will be invoked when the procs named in output parameter proc_names are executed.
args array of arrays of strings Arrays of command-line arguments that will be passed to the procs named in output parameter proc_names when executed.
options array of maps of strings The optional parameters for the procs named in output parameter proc_names.

Empty string in case of an error.