Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.ExecuteProcRequest.Options Struct Reference

Optional parameters. 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(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string}) 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(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string})) 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(string,IDictionary{string, string}) or Kinetica.killProc(string,IDictionary{string, string}) 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(string,IDictionary{string, string}). 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

Optional parameters.

  • CACHE_INPUT: A comma-delimited list of table names from from which input data will be cached for use in subsequent calls to /execute/proc with the use_cached_input option. Cached input data will be retained until the proc status is cleared with the /show/proc/status option of /show/proc/status and all proc instances using the cached data have completed. The default value is ''.
  • USE_CACHED_INPUT: A comma-delimited list of run IDs (as returned from prior calls to /execute/proc) 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 , 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 ''.
  • RUN_TAG: A string that, if not empty, can be used in subsequent calls to /show/proc/status or /kill/proc to identify the proc instance. The default value is ''.
  • MAX_OUTPUT_LINES: The maximum number of lines of output from stdout and stderr to return via /show/proc/status. If the number of lines output exceeds the maximum, earlier lines are discarded. The default value is '100'.
  • EXECUTE_AT_STARTUP: If true, an instance of the proc will run when the database is started instead of running immediately. The <member name="run_id"> can be retrieved using /show/proc and used in /show/proc/status. Supported values: The default value is FALSE.
  • 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 ''.

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

Definition at line 111 of file ExecuteProc.cs.

Member Data Documentation

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(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string}) 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(string,IDictionary{string, string}) and all proc instances using the cached data have completed. The default value is ''.

Definition at line 125 of file ExecuteProc.cs.

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.

The <member name="run_id"> can be retrieved using Kinetica.showProc(string,IDictionary{string, string}) and used in Kinetica.showProcStatus(string,IDictionary{string, string}). Supported values:

The default value is FALSE.

Definition at line 177 of file ExecuteProc.cs.

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

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

Definition at line 179 of file ExecuteProc.cs.

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(string,IDictionary{string, string}).

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

Definition at line 155 of file ExecuteProc.cs.

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

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

The default value is ''.

Definition at line 148 of file ExecuteProc.cs.

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

Definition at line 178 of file ExecuteProc.cs.

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(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string})) 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 139 of file ExecuteProc.cs.

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