kinetica.ExecuteProcRequest.Options Struct Reference

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

Public Attributes
const string	CACHE_INPUT = "cache_input"
	No longer supported; option will be ignored. More...
const string	USE_CACHED_INPUT = "use_cached_input"
	No longer supported; option will be ignored. 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"

No longer supported; option will be ignored.

The default value is ''.

Definition at line 32 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 70 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 80 of file ExecuteProc.cs.

FALSE

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

Definition at line 73 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 54 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 45 of file ExecuteProc.cs.

TRUE

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

Definition at line 72 of file ExecuteProc.cs.

USE_CACHED_INPUT

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

No longer supported; option will be ignored.

The default value is ''.

Definition at line 36 of file ExecuteProc.cs.

---

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

• _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ExecuteProc.cs