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

Public Attributes
const string	CACHE_INPUT = "cache_input"
	A comma-delimited list of table names from input_table_names from which input data will be cached for use in subsequent calls to Kinetica.executeProc with the USE_CACHED_INPUT option. More...

const string	USE_CACHED_INPUT = "use_cached_input"
	A comma-delimited list of run IDs (as returned from prior calls to Kinetica.executeProc) of running or completed proc instances from which input data cached using the CACHE_INPUT option will be used. More...

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. More...

const string	MAX_OUTPUT_LINES = "max_output_lines"
	The maximum number of lines of output from stdout and stderr to return via Kinetica.showProcStatus. More...

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. More...

const string	TRUE = "true"

const string	FALSE = "false"

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. More...

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 28 of file ExecuteProc.cs.

Member Data Documentation

◆ CACHE_INPUT

const string kinetica.ExecuteProcRequest.Options.CACHE_INPUT = "cache_input"

A comma-delimited list of table names from input_table_names from which input data will be cached for use in subsequent calls to Kinetica.executeProc with the USE_CACHED_INPUT option.

Cached input data will be retained until the proc status is cleared with the clear_complete option of Kinetica.showProcStatus and all proc instances using the cached data have completed. The default value is ''.

Definition at line 44 of file ExecuteProc.cs.

◆ EXECUTE_AT_STARTUP

const string kinetica.ExecuteProcRequest.Options.EXECUTE_AT_STARTUP = "execute_at_startup"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 94 of file ExecuteProc.cs.

◆ EXECUTE_AT_STARTUP_AS

const string kinetica.ExecuteProcRequest.Options.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.

The default value is ''.

Definition at line 104 of file ExecuteProc.cs.

◆ FALSE

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

Definition at line 97 of file ExecuteProc.cs.

◆ MAX_OUTPUT_LINES

const string kinetica.ExecuteProcRequest.Options.MAX_OUTPUT_LINES = "max_output_lines"

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 78 of file ExecuteProc.cs.

◆ RUN_TAG

const string kinetica.ExecuteProcRequest.Options.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.

The default value is ''.

Definition at line 69 of file ExecuteProc.cs.

◆ TRUE

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

Definition at line 96 of file ExecuteProc.cs.

◆ USE_CACHED_INPUT

const string kinetica.ExecuteProcRequest.Options.USE_CACHED_INPUT = "use_cached_input"

A comma-delimited list of run IDs (as returned from prior calls to Kinetica.executeProc) of running or completed proc instances from which input data cached using the CACHE_INPUT option will be used.

Cached input data will not be used for any tables specified in input_table_names, but data from all other tables cached for the specified run IDs will be passed to the proc. If the same table was cached for multiple specified run IDs, the cached data from the first run ID specified in the list that includes that table will be used. The default value is ''.

Definition at line 60 of file ExecuteProc.cs.

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

Kinetica/Protocol/ExecuteProc.cs

Public Attributes