Skip to main content

A set of string constants for the parameter ExecuteProcRequest.options. More…

​
Static Public Attributes

const string CACHE_INPUT = “cache_input”
 No longer supported; option will be ignored.
 
const string USE_CACHED_INPUT = “use_cached_input”
 No longer supported; option will be ignored.
 
const string RUN_TAG = “run_tag”
 A string that, if not empty, can be used in subsequent calls to Kinetica.showProcStatus or Kinetica.killProc to identify the proc instance.
 
const string MAX_OUTPUT_LINES = “max_output_lines”
 The maximum number of lines of output from stdout and stderr to return via Kinetica.showProcStatus.
 
const string EXECUTE_AT_STARTUP = “execute_at_startup”
 If TRUE, an instance of the proc will run when the database is started instead of running immediately.
 
const string TRUE = “true”
 A boolean constant for the ExecuteProcRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the ExecuteProcRequest.Options options.
 
const string EXECUTE_AT_STARTUP_AS = “execute_at_startup_as”
 Sets the alternate user name to execute this proc instance as when EXECUTE_AT_STARTUP is TRUE.
 

​
Detailed Description

A set of string constants for the parameter ExecuteProcRequest.options.

Optional parameters.

Definition at line 29 of file ExecuteProc.cs.

​
Member Data Documentation

​
◆ CACHE_INPUT

const string kinetica.ExecuteProcRequest.Options.CACHE_INPUT = “cache_input”
 static

No longer supported; option will be ignored.

The default value is ”.

Definition at line 33 of file ExecuteProc.cs.

​
◆ EXECUTE_AT_STARTUP

const string kinetica.ExecuteProcRequest.Options.EXECUTE_AT_STARTUP = “execute_at_startup”
 static

If TRUE, an instance of the proc will run when the database is started instead of running immediately.

The run_id can be retrieved using Kinetica.showProc and used in Kinetica.showProcStatus. Supported values:

The default value is FALSE.

Definition at line 80 of file ExecuteProc.cs.

​
◆ EXECUTE_AT_STARTUP_AS

const string kinetica.ExecuteProcRequest.Options.EXECUTE_AT_STARTUP_AS = “execute_at_startup_as”
 static

Sets the alternate user name to execute this proc instance as when EXECUTE_AT_STARTUP is TRUE.

The default value is ”.

Definition at line 96 of file ExecuteProc.cs.

​
◆ FALSE

const string kinetica.ExecuteProcRequest.Options.FALSE = “false”
 static

A boolean constant for the ExecuteProcRequest.Options options.

Definition at line 88 of file ExecuteProc.cs.

​
◆ MAX_OUTPUT_LINES

const string kinetica.ExecuteProcRequest.Options.MAX_OUTPUT_LINES = “max_output_lines”
 static

The maximum number of lines of output from stdout and stderr to return via Kinetica.showProcStatus.

If the number of lines output exceeds the maximum, earlier lines are discarded. The default value is ‘100’.

Definition at line 55 of file ExecuteProc.cs.

​
◆ RUN_TAG

const string kinetica.ExecuteProcRequest.Options.RUN_TAG = “run_tag”
 static

A string that, if not empty, can be used in subsequent calls to Kinetica.showProcStatus or Kinetica.killProc to identify the proc instance.

The default value is ”.

Definition at line 46 of file ExecuteProc.cs.

​
◆ TRUE

const string kinetica.ExecuteProcRequest.Options.TRUE = “true”
 static

A boolean constant for the ExecuteProcRequest.Options options.

Definition at line 84 of file ExecuteProc.cs.

​
◆ USE_CACHED_INPUT

const string kinetica.ExecuteProcRequest.Options.USE_CACHED_INPUT = “use_cached_input”
 static

No longer supported; option will be ignored.

The default value is ”.

Definition at line 37 of file ExecuteProc.cs.

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