GPUdb C++ API  Version 7.2.2.4
gpudb::ShowProcRequest Struct Reference

A set of parameters for GPUdb::showProc. More...

#include <gpudb/protocol/show_proc.h>

Public Member Functions

 ShowProcRequest ()
 Constructs a ShowProcRequest object with default parameters. More...
 
 ShowProcRequest (const std::string &procName_, const std::map< std::string, std::string > &options_)
 Constructs a ShowProcRequest object with the specified parameters. More...
 

Public Attributes

std::string procName
 Name of the proc to show information about. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::showProc.

Shows information about a proc.

Definition at line 17 of file show_proc.h.

Constructor & Destructor Documentation

◆ ShowProcRequest() [1/2]

gpudb::ShowProcRequest::ShowProcRequest ( )
inline

Constructs a ShowProcRequest object with default parameters.

Definition at line 22 of file show_proc.h.

◆ ShowProcRequest() [2/2]

gpudb::ShowProcRequest::ShowProcRequest ( const std::string &  procName_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a ShowProcRequest object with the specified parameters.

Parameters
[in]procName_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. The default value is ''.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 58 of file show_proc.h.

Member Data Documentation

◆ options

std::map<std::string, std::string> gpudb::ShowProcRequest::options

Optional parameters.

The default value is an empty map.

Definition at line 89 of file show_proc.h.

◆ procName

std::string gpudb::ShowProcRequest::procName

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. The default value is ''.

Definition at line 69 of file show_proc.h.


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