kinetica.KillProcRequest.Options Struct Reference

Optional parameters. More...

Public Attributes
const string	RUN_TAG = "run_tag"
	If run_id is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to Kinetica.executeProc(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string}). More...
const string	CLEAR_EXECUTE_AT_STARTUP = "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. More...
const string	TRUE = "true"
const string	FALSE = "false"

Detailed Description

Optional parameters.

• RUN_TAG: If is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to /execute/proc. If is not specified, kill the proc instance(s) where a matching run tag was provided to /execute/proc. The default value is ''.
• 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 /execute/proc and can be retrieved using /show/proc. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 58 of file KillProc.cs.

Member Data Documentation

const string kinetica.KillProcRequest.Options.CLEAR_EXECUTE_AT_STARTUP = "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 Kinetica.executeProc(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string}) and can be retrieved using Kinetica.showProc(string,IDictionary{string, string}). Supported values:

• TRUE
• FALSE

The default value is FALSE.

Definition at line 92 of file KillProc.cs.

const string kinetica.KillProcRequest.Options.FALSE = "false"

Definition at line 94 of file KillProc.cs.

const string kinetica.KillProcRequest.Options.RUN_TAG = "run_tag"

If run_id is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to Kinetica.executeProc(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string}).

If run_id is not specified, kill the proc instance(s) where a matching run tag was provided to Kinetica.executeProc(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string}). The default value is ''.

Definition at line 69 of file KillProc.cs.

const string kinetica.KillProcRequest.Options.TRUE = "true"

Definition at line 93 of file KillProc.cs.

---

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

• Kinetica/Protocol/KillProc.cs