Loading Job Functions

The functions on this page run loading jobs on the TigerGraph server. All functions in this module are called as methods on a TigerGraphConnection object.

runLoadingJobWithFile()

runLoadingJobWithFile(filePath: str, fileTag: str, jobName: str, sep: str = None, eol: str = None, timeout: int = 16000, sizeLimit: int = 128000000) → Union[dict, None]

Execute a loading job with the referenced file.

The file will first be uploaded to the TigerGraph server and the value of the appropriate FILENAME definition will be updated to point to the freshly uploaded file.

The argument USING HEADER="true" in the GSQL loading job may not be enough to load the file correctly. Remove the header from the data file before using this function.

Parameters:

  • filePath: File variable name or file path for the file containing the data.

  • fileTag: The name of file variable in the loading job (DEFINE FILENAME <fileTag>).

  • jobName: The name of the loading job.

  • sep: Data value separator. If your data is JSON, you do not need to specify this parameter. The default separator is a comma ,.

  • eol: End-of-line character. Only one or two characters are allowed, except for the special case \r\n. The default value is \n

  • timeout: Timeout in seconds. If set to 0, use the system-wide endpoint timeout setting.

  • sizeLimit: Maximum size for input file in bytes.

Endpoint:

uploadFile()

uploadFile(filePath, fileTag, jobName = "", sep = None, eol = None, timeout = 16000, sizeLimit = 128000000) → dict

DEPRECATED

Use runLoadingJobWithFile() instead.