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	KIFS_INPUT_DIRS = "kifs_input_dirs"
	A comma-delimited list of KiFS directories whose local files will be made directly accessible to the proc through the API. 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 ''.
• KIFS_INPUT_DIRS: A comma-delimited list of KiFS directories whose local files will be made directly accessible to the proc through the API. (All KiFS files, local or not, are also accessible through the file system below the KiFS mount point.) Each name specified must the name of an existing KiFS directory. The default value is ''.

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

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

KIFS_INPUT_DIRS

const string kinetica.ExecuteProcRequest.Options.KIFS_INPUT_DIRS = "kifs_input_dirs"

A comma-delimited list of KiFS directories whose local files will be made directly accessible to the proc through the API.

(All KiFS files, local or not, are also accessible through the file system below the KiFS mount point.) Each name specified must the name of an existing KiFS directory. The default value is ''.

Definition at line 102 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(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 94 of file ExecuteProc.cs.

---

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

• Kinetica/Protocol/ExecuteProc.cs