UltipaDocs
Try Playground
  • Introduction
  • Terminologies
    • Graphset
    • Schema
    • Property
    • Constraints
    • Insert
    • Overwrite or Insert
    • Upsert
    • Update
    • Delete
    • Find Nodes
    • Find Edges
      • AB
      • Autonet
      • Spread
      • Path Template
      • K-Hop
      • K-Hop Template
    • GROUP BY
    • ORDER BY
    • SKIP
    • LIMIT
    • WHERE
    • RETURN
    • WITH
    • UNCOLLECT
    • UNION
    • UNION ALL
    • CALL
    • All Functions
    • Path Functions
    • Aggregate Functions
    • Mathematical Functions
    • Trigonometric Functions
    • String Functions
    • List Functions
    • Datetime Functions
    • Spatial Functions
    • Table Functions
    • Null Functions
    • Type Conversion Functions
  • Operators
  • Expressions
    • Index
    • Full-text Index
    • Vector Index
    • Cache
    • Overview
    • Managing HDC Graphs
    • HDC Graph Queries
    • Process
    • Job
    • Execution Plan
    • Alias
    • Filter
    • Values and Types
    • Data Flow in Queries
    • Comments
    • Reserved Words
  • Access Control
  1. Docs
  2. /
  3. UQL
  4. /
  5. UQL Execution

Job

Overview

Certain UQL operations, such as schema dropping, projection creation, and algorithm writeback, are designed to run as back-end jobs. The results of some jobs, such as files generated by algorithms, are stored in the graphsets on which they are executed and can be retrieved later, unless cleared.

Showing Jobs

To retrieve all jobs in the current graphset:

UQL
show().job()

To retrieve the job with id 83 in the current graphset:

UQL
show().job(83)

It returns the following information for each job:

Field
Description
Job IDJob ID. Some jobs have sub-jobs with ids <jobId>_1,<jobId>_2, and so on.
Graph NameThe graphset on which the job executes.
TypeJob type, such as CREATE_INDEX, CACHE, COMPACT etc.
QueryQuery of the job.
Start TimeStart time of the job.
End TimeEnd time of the job.
ResultResults generated by the job, such as output files or statistical summaries from an algorithm.
Error MsgError message, if any, encountered during the job's execution.
StatusJob status, which can be FINISHED, RUNNING, STOPPING, STOPPED or FAILED.
ProgressProgress updates for the job, such as indications that the write operation has been started.

Stopping Jobs

To stop the running job with id 83 in the current graphset:

UQL
stop().job(83)
NOTE

Certain job types cannot be stopped once they are running. These include COMPACT, CREATE_INDEX, CREATE_FULLTEXT, CREATE_CONSTRAINT, MIGRATION, and CREATE_BACKUP.

Clearing Jobs

To clear all jobs in the current graphset that are not running:

UQL
clear().job("*")

To clear the job with ID 83 in the current graphset:

UQL
clear().job(83)