ExecuteProcRequest.Options (Kinetica Java API 7.1.10.4 API)

java.lang.Object
- com.gpudb.protocol.ExecuteProcRequest.Options

Enclosing class:

ExecuteProcRequest
```
public static final class ExecuteProcRequest.Options
extends Object
```
Optional parameters.
- CACHE_INPUT: A comma-delimited list of table names from inputTableNames from which input data will be cached for use in subsequent calls to GPUdb.executeProc(ExecuteProcRequest) with the use_cached_input option. Cached input data will be retained until the proc status is cleared with the clear_complete option of GPUdb.showProcStatus(ShowProcStatusRequest) 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 GPUdb.executeProc(ExecuteProcRequest)) 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 inputTableNames, 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 GPUdb.showProcStatus(ShowProcStatusRequest) or GPUdb.killProc(KillProcRequest) 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 GPUdb.showProcStatus(ShowProcStatusRequest). 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 runId can be retrieved using GPUdb.showProc(ShowProcRequest) and used in GPUdb.showProcStatus(ShowProcStatusRequest). Supported values:
  - TRUE
  - FALSE
  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 Map. A set of string constants for the parameter options.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CACHE_INPUT` A comma-delimited list of table names from `inputTableNames` from which input data will be cached for use in subsequent calls to `GPUdb.executeProc(ExecuteProcRequest)` with the `use_cached_input` option.
`static String`	`EXECUTE_AT_STARTUP` If `true`, an instance of the proc will run when the database is started instead of running immediately.
`static String`	`EXECUTE_AT_STARTUP_AS` Sets the alternate user name to execute this proc instance as when `execute_at_startup` is `true`.
`static String`	`FALSE`
`static String`	`MAX_OUTPUT_LINES` The maximum number of lines of output from stdout and stderr to return via `GPUdb.showProcStatus(ShowProcStatusRequest)`.
`static String`	`RUN_TAG` A string that, if not empty, can be used in subsequent calls to `GPUdb.showProcStatus(ShowProcStatusRequest)` or `GPUdb.killProc(KillProcRequest)` to identify the proc instance.
`static String`	`TRUE`
`static String`	`USE_CACHED_INPUT` A comma-delimited list of run IDs (as returned from prior calls to `GPUdb.executeProc(ExecuteProcRequest)`) of running or completed proc instances from which input data cached using the `cache_input` option will be used.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CACHE_INPUT
```
public static final String CACHE_INPUT
```
    A comma-delimited list of table names from inputTableNames from which input data will be cached for use in subsequent calls to GPUdb.executeProc(ExecuteProcRequest) with the use_cached_input option. Cached input data will be retained until the proc status is cleared with the clear_complete option of GPUdb.showProcStatus(ShowProcStatusRequest) and all proc instances using the cached data have completed. The default value is ''.
    
    See Also:
    
    Constant Field Values
  - USE_CACHED_INPUT
```
public static final String USE_CACHED_INPUT
```
    A comma-delimited list of run IDs (as returned from prior calls to GPUdb.executeProc(ExecuteProcRequest)) 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 inputTableNames, 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 ''.
    
    See Also:
    
    Constant Field Values
  - RUN_TAG
```
public static final String RUN_TAG
```
    A string that, if not empty, can be used in subsequent calls to GPUdb.showProcStatus(ShowProcStatusRequest) or GPUdb.killProc(KillProcRequest) to identify the proc instance. The default value is ''.
    
    See Also:
    
    Constant Field Values
  - MAX_OUTPUT_LINES
```
public static final String MAX_OUTPUT_LINES
```
    The maximum number of lines of output from stdout and stderr to return via GPUdb.showProcStatus(ShowProcStatusRequest). If the number of lines output exceeds the maximum, earlier lines are discarded. The default value is '100'.
    
    See Also:
    
    Constant Field Values
  - EXECUTE_AT_STARTUP
```
public static final String EXECUTE_AT_STARTUP
```
    If true, an instance of the proc will run when the database is started instead of running immediately. The runId can be retrieved using GPUdb.showProc(ShowProcRequest) and used in GPUdb.showProcStatus(ShowProcStatusRequest). Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    See Also:
    
    Constant Field Values
  - EXECUTE_AT_STARTUP_AS
```
public static final String 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 ''.
    
    See Also:
    
    Constant Field Values

Class ExecuteProcRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CACHE_INPUT

USE_CACHED_INPUT

RUN_TAG

MAX_OUTPUT_LINES

EXECUTE_AT_STARTUP

TRUE

FALSE

EXECUTE_AT_STARTUP_AS