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

#include <gpudb/protocol/kill_proc.h>

Public Member Functions
	KillProcRequest ()
	Constructs a KillProcRequest object with default parameters. More...

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

Public Attributes
std::string	runId
	The run ID of a running proc instance. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::killProc.

Kills a running proc instance.

Definition at line 17 of file kill_proc.h.

Constructor & Destructor Documentation

◆ KillProcRequest() [1/2]

gpudb::KillProcRequest::KillProcRequest ( )

inline

Constructs a KillProcRequest object with default parameters.

Definition at line 22 of file kill_proc.h.

◆ KillProcRequest() [2/2]

gpudb::KillProcRequest::KillProcRequest	(	const std::string &	runId_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a KillProcRequest object with the specified parameters.

Parameters

[in]	runId_	The run ID of a running proc instance. If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed. The default value is ''.
[in]	options_	Optional parameters. kill_proc_run_tag: If runId_ is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to GPUdb::executeProc. If runId_ is not specified, kill the proc instance(s) where a matching run tag was provided to GPUdb::executeProc. The default value is ''. kill_proc_clear_execute_at_startup: If true, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned from GPUdb::executeProc and can be retrieved using GPUdb::showProc. Supported values: kill_proc_true kill_proc_false The default value is kill_proc_false. The default value is an empty map.

Definition at line 79 of file kill_proc.h.

Member Data Documentation

◆ options

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

Optional parameters.

kill_proc_run_tag: If runId is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to GPUdb::executeProc. If runId is not specified, kill the proc instance(s) where a matching run tag was provided to GPUdb::executeProc. The default value is ''.
kill_proc_clear_execute_at_startup: If true, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned from GPUdb::executeProc and can be retrieved using GPUdb::showProc. Supported values:
- kill_proc_true
- kill_proc_false
The default value is kill_proc_false.

The default value is an empty map.

Definition at line 124 of file kill_proc.h.

◆ runId

std::string gpudb::KillProcRequest::runId

The run ID of a running proc instance.

If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed. The default value is ''.

Definition at line 91 of file kill_proc.h.

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

gpudb/protocol/kill_proc.h

Public Member Functions