executeProc
Executes a proc. This endpoint is asynchronous and does not wait for the proc to complete before returning.If the proc being executed is distributed,
inputTableNamesandinputColumnNamesmay be passed to the proc to use for reading data, andoutputTableNamesmay be passed to the proc to use for writing data.If the proc being executed is non-distributed, these table parameters will be ignored.
Parameters:request-Requestobject containing the parameters for the operation.Returns:Responseobject containing the results of the operation.Throws:GPUdbException- if an error occurs during the operation.executeProc
public ExecuteProcResponse executeProc(String procName, Map<String, String> params, Map<String, ByteBuffer> binParams, List<String> inputTableNames, Map<String, List<String>> inputColumnNames, List<String> outputTableNames, Map<String, String> options) throws GPUdbException Executes a proc. This endpoint is asynchronous and does not wait for the proc to complete before returning.If the proc being executed is distributed,
inputTableNamesandinputColumnNamesmay be passed to the proc to use for reading data, andoutputTableNamesmay be passed to the proc to use for writing data.If the proc being executed is non-distributed, these table parameters will be ignored.
Parameters:procName- Name of the proc to execute. Must be the name of a currently existing proc.params- A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an emptyMap.binParams- A map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an emptyMap.inputTableNames- Names of the tables containing data to be passed to the proc. Each name specified must be the name of a currently existing table, in [schema_name.]table_name format, using standard name resolution rules. If no table names are specified, no data will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an emptyList.inputColumnNames- Map of table names frominputTableNamesto lists of names of columns from those tables that will be passed to the proc. Each column name specified must be the name of an existing column in the corresponding table. If a table name frominputTableNamesis not included, all columns from that table will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an emptyMap.outputTableNames- Names of the tables to which output data from the proc will be written, each in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If a specified table does not exist, it will automatically be created with the same schema as the corresponding table (by order) frominputTableNames, excluding any primary and shard keys. If a specified table is a non-persistent result table, it must not have primary or shard keys. If no table names are specified, no output data can be returned from the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an emptyList.options- Optional parameters.CACHE_INPUT: No longer supported; option will be ignored. The default value is ”.USE_CACHED_INPUT: No longer supported; option will be ignored. The default value is ”.RUN_TAG: A string that, if not empty, can be used in subsequent calls toshowProcStatusorkillProcto identify the proc instance. The default value is ”.MAX_OUTPUT_LINES: The maximum number of lines of output from stdout and stderr to return viashowProcStatus. If the number of lines output exceeds the maximum, earlier lines are discarded. The default value is ‘100’.EXECUTE_AT_STARTUP: IfTRUE, an instance of the proc will run when the database is started instead of running immediately. TherunIdcan be retrieved usingshowProcand used inshowProcStatus. Supported values:The default value isFALSE.EXECUTE_AT_STARTUP_AS: Sets the alternate user name to execute this proc instance as whenEXECUTE_AT_STARTUPisTRUE. The default value is ”.
Map.Returns:Responseobject containing the results of the operation.Throws:GPUdbException- if an error occurs during the operation.