killaddtable (Kills an ongoing load process)

The killaddtable transaction kills an ongoing asynchronous load job (an addtab command with <sync>0</sync>).

The api will not delete the table if the load transaction was completed before the kill command. You will receive a response from the server whether killaddtable was successful.
Note: This command will not work against upload and synchronous addtab transactions (<sync>1</sync>).

Query string

The query string in the HTTP header must contain the following parameters:

api
Specify the name of the API transaction.
apiversion
Specify the version of the API that should handle the requested transaction.

For the most up-to-date version, use apiversion=3.

uid
Specify a valid 1010data user name.
pswd
Specify a valid password for the 1010data user name provided to the uid parameter.
Note: The pswd value should be the encrypted password returned from the login transaction.
sid
The session ID for the current API session.

This value is returned by the login transaction and must be provided to every transaction (except login).

kill (optional)
Valid values for kill are as follows:
yes
Terminate the existing session and start a new one.
no
Do not terminate the existing session.

If no session exists, a new one will be created. If a session does exist, an error is returned.

Note: If kill=no and a session is active, the system returns an error.
possess
Log in and possess the existing session.
auth
Authenticate with the system but do not kill, possess, or start any session.

The default is yes.

Query String Example

https://www2.1010data.com/gw.k?api=killaddtable&apiversion=3&uid=$UID&pswd=$PSWD&sid=$SID

XML Input to Server

The specifications must contain the following elements:

XML Element To Send Description of Sent Element Content Required/ Optional Example
<path></path> Path of the table of the ongoing load, which is the value of the <name> attribute of the addtab transaction. Required <path>table.path</path>

XML Input Example

<in>
  <path>table.path</path>
</in>

XML Response from Server

A successful killaddtable produces the following result:

<out>
    <rc>0</rc>
    <msg>Gracefully killed load process for path: table.path</msg>
</out>
If the load transaction succeeds prior to the killaddtable transaction, it produces the following result:
<out>
    <rc>0</rc>
    <msg>Load was already finished</msg>
</out>