/create/job

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/create/job

Create a job which will run asynchronously. The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by /get/job.

Input Parameter Description

Name	Type	Description
endpoint	string	Indicates which endpoint to execute, e.g. '/alter/table'.
request_encoding	string	The encoding of the request payload for the job. The supported values are: binary json snappy
data	bytes	Binary-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in input parameter endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then input parameter request_encoding must be binary or snappy.
data_str	string	JSON-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in input parameter endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then input parameter request_encoding must be json.
options	map of string to strings	Optional parameters. The default value is an empty map ( {} ).

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name	Type	Description
status	String	'OK' or 'ERROR'
message	String	Empty if success or an error message
data_type	String	'create_job_request' or 'none' in case of an error
data	String	Empty string
data_str	JSON or String	This embedded JSON represents the result of the /create/job endpoint: Name Type Description job_id int An identifier for the job created by this call. Empty string in case of an error.